com.sap.security.api
Interface ISecurityPolicy

public interface ISecurityPolicy

This interface handles UME Security Policy settings. Note: It is not possible to change the current security policy settings with the setter methods at runtime. If you want to change these settings, change the configuration and restart the server.

Field Summary

static String	ACCOUNT_LOCKED_ADMIN
static String	ACCOUNT_LOCKED_LOGON
static String	ALPHANUM_REQUIRED_FOR_LOGONID
static String	ALPHANUM_REQUIRED_FOR_PSWD
static String	CERT_GET_ERROR
static String	CERT_NOT_UNIQUE
static String	CHANGE_PASSWORD_NOT_ALLOWED
static String	LOGONID_IS_NULL
static String	LOGONID_TOO_LONG
static String	LOGONID_TOO_SHORT
static String	MISSING_NEW_PASSWORD
static String	MISSING_PASSWORD
static String	MISSING_PASSWORD_CONFIRM
static String	MISSING_UID
static String	MIXED_CASE_REQUIRED_FOR_LOGONID
static String	MIXED_CASE_REQUIRED_FOR_PSWD
static String	NEW_PASSWORD_INVALID
static String	NEW_PASSWORDS_UNMATCHED
static String	NO_CERTIFICATE
static String	NO_USER_CERTIFICATE
static String	NUMERIC_REQUIRED
static String	OLDPASSWORD_IN_NEWPASSWORD
static String	PASSWORD_CONTAINED_IN_HISTORY
static String	PASSWORD_EXPIRED
static String	PASSWORD_MAX_IDLE_TIME_EXCEEDED
static String	PASSWORD_TOO_LONG
static String	PASSWORD_TOO_SHORT
static String	SAPSTAR_ACTIVATED
static String	SPEC_CHARS_REQUIRED_FOR_LOGONID
static String	SPEC_CHARS_REQUIRED_FOR_PSWD
static String	USER_AUTH_FAILED
static String	USER_IS_CURRENTLY_NOT_VALID
static String	USERID_CONTAINED_IN_PASSWORD
static String	USERID_NOT_FOUND
static String	WHITESPACES_NOT_ALLOWED
static String	WRONG_OLD_PASSWORD
static String	WRONG_PASSWORD

Method Summary

String	generateLogonId() Generate a logon id for this security policy.
String	generatePassword() Generate a password for this security policy.
String	generatePassword(String userid) Generate a password for this security policy.
int	getAutoUnlockTime() Gets the AutoUnlockTime(in seconds) attribute of the ISecurityPolicy object
boolean	getCertLogonRequired() Deprecated.
int	getCookieLifeTime() Deprecated.
boolean	getEnforcePolicyAtLogon() Returns a boolean indicating whether users who have a productive password that doesn't match the security policy settings have to change it during password logon.
String	getLocalizedMessage(Locale locale, Exception ex) Return a localized password exception message for the given key.
String	getLocalizedMessage(Locale locale, String key) Return a localized password exception message for the given key.
int	getLockAfterInvalidAttempts() Gets the Number of Allowed Logon Attempts (AllowedLogonAttempts) attribute of the ISecurityPolicy object
int	getLogonIdLowerCaseRequired() Return a number indicating how many capical and lower case letters the logon id must contain.
int	getLogonIdMaxLength() Return the integer value indicating the maximum length of a logon id.
int	getLogonIdMinLength() Return the integer value indicating the minimum length of a logon id.
int	getLogonIdNumericDigitsRequired() Return the number indicating how many alphabets and numeric values the logon id must contain.
int	getLogonIdSpecialCharRequired() Return a number indicating how many special characters the logon id must contain.
boolean	getOldInNewAllowed() Return a boolean indicating whether the password need to be different from the old password.
int	getPasswordAlphaNumericRequired() Return the number indicating how many alphabets and numeric values the password must contain.
boolean	getPasswordChangeAllowed() Return the boolean value indicating whether the password is allowed to be changed.
boolean	getPasswordChangeRequired() Deprecated.
int	getPasswordExpiredDays() Return the numbers of days the password is set to expired.
int	getPasswordHistory() Gets the PasswordHistory attribute of the SecurityPolicy object.
Date	getPasswordLastChangeDateDefault() Returns the PasswordLastChangeDateDefault (MM/DD/YYYY) attribute of the ISecurityPolicy object.
int	getPasswordMaxIdleTime() Returns the PasswordMaxIdleTime(in days) attribute of the ISecurityPolicy object.
int	getPasswordMaxLength() Gets the Password Maximum Length(PasswordMaxLength) attribute of the ISecurityPolicy object
int	getPasswordMinLength() Gets the Password Minimum Length(PasswordMinLength) attribute of the ISecurityPolicy object
int	getPasswordMixCaseRequired() Return a number indicating how many capical and lower case letters the password must contain.
int	getPasswordSpecialCharRequired() Return the number indicating how many special characters the password must contain.
Date	getPasswordSuccessfulCheckDateDefault() Returns the PasswordSuccessfulCheckDateDefault attribute of the ISecurityPolicy object.
boolean	getUseridInPasswordAllowed() Return a boolean indicating whether the password need to be different from the user id(uid).
boolean	isLogonIdValid(String logonId) Check the validity of the logon id against the security policy
boolean	isPasswordValid(String pass) Deprecated. please use isPasswordValid(String pass, String logonId)
boolean	isPasswordValid(String pass, String logonId) Check the validity of the password against the password policy
void	setAutoUnlockTime(int time) Deprecated.
void	setCertLogonRequired(boolean clr) Deprecated.
void	setCookieLifeTime(int lifeTime) Deprecated.
void	setEnforcePolicyAtLogon(boolean enforcePolicyAtLogon) Sets whether users who have a productive password that doesn't match the security policy settings have to change it during password logon.
void	setLockAfterInvalidAttempts(int count) Deprecated.
void	setLogonIdLowerCaseRequired(int number) Deprecated.
void	setLogonIdMaxLength(int length) Deprecated.
void	setLogonIdMinLength(int length) Deprecated.
void	setLogonIdNumericDigitsRequired(int number) Deprecated.
void	setLogonIdSpecialCharRequired(int number) Deprecated.
void	setOldInNewAllowed(boolean allow) Deprecated.
void	setPasswordAlphaNumericRequired(int number) Deprecated.
void	setPasswordChangeAllowed(boolean pca) Deprecated.
void	setPasswordChangeRequired(boolean pca) Deprecated.
void	setPasswordExpiredDays(int days) Deprecated.
void	setPasswordHistory(int length) Deprecated.
void	setPasswordMaxIdleTime(int time) Deprecated.
void	setPasswordMaxLength(int length) Deprecated.
void	setPasswordMinLength(int length) Deprecated.
void	setPasswordMixCaseRequired(int number) Deprecated.
void	setPasswordPasswordLastChangeDateDefault(Date newDate) Deprecated.
void	setPasswordSpecialCharRequired(int number) Deprecated.
void	setPasswordSuccessfulCheckDateDefault(Date newDate) Deprecated.
void	setUseridInPasswordAllowed(boolean pwnur) Deprecated.
void	setUserName(String id) Deprecated.
String	validatePassword(String pass) Deprecated. please use validatePassword(String pass, String uid)
String	validatePassword(String pass, String uid) Check the validity of the password against the password policy.

Field Detail

ACCOUNT_LOCKED_ADMIN

static final String ACCOUNT_LOCKED_ADMIN

See Also:

Constant Field Values

ACCOUNT_LOCKED_LOGON

static final String ACCOUNT_LOCKED_LOGON

See Also:

Constant Field Values

ALPHANUM_REQUIRED_FOR_PSWD

static final String ALPHANUM_REQUIRED_FOR_PSWD

See Also:

Constant Field Values

CERT_GET_ERROR

static final String CERT_GET_ERROR

See Also:

Constant Field Values

CERT_NOT_UNIQUE

static final String CERT_NOT_UNIQUE

See Also:

Constant Field Values

CHANGE_PASSWORD_NOT_ALLOWED

static final String CHANGE_PASSWORD_NOT_ALLOWED

See Also:

Constant Field Values

MISSING_NEW_PASSWORD

static final String MISSING_NEW_PASSWORD

See Also:

Constant Field Values

MISSING_PASSWORD

static final String MISSING_PASSWORD

See Also:

Constant Field Values

MISSING_PASSWORD_CONFIRM

static final String MISSING_PASSWORD_CONFIRM

See Also:

Constant Field Values

MISSING_UID

static final String MISSING_UID

See Also:

Constant Field Values

MIXED_CASE_REQUIRED_FOR_PSWD

static final String MIXED_CASE_REQUIRED_FOR_PSWD

See Also:

Constant Field Values

NEW_PASSWORD_INVALID

static final String NEW_PASSWORD_INVALID

See Also:

Constant Field Values

NEW_PASSWORDS_UNMATCHED

static final String NEW_PASSWORDS_UNMATCHED

See Also:

Constant Field Values

NO_CERTIFICATE

static final String NO_CERTIFICATE

See Also:

Constant Field Values

NO_USER_CERTIFICATE

static final String NO_USER_CERTIFICATE

See Also:

Constant Field Values

NUMERIC_REQUIRED

static final String NUMERIC_REQUIRED

See Also:

Constant Field Values

OLDPASSWORD_IN_NEWPASSWORD

static final String OLDPASSWORD_IN_NEWPASSWORD

See Also:

Constant Field Values

PASSWORD_CONTAINED_IN_HISTORY

static final String PASSWORD_CONTAINED_IN_HISTORY

See Also:

Constant Field Values

PASSWORD_EXPIRED

static final String PASSWORD_EXPIRED

See Also:

Constant Field Values

PASSWORD_MAX_IDLE_TIME_EXCEEDED

static final String PASSWORD_MAX_IDLE_TIME_EXCEEDED

See Also:

Constant Field Values

PASSWORD_TOO_LONG

static final String PASSWORD_TOO_LONG

See Also:

Constant Field Values

PASSWORD_TOO_SHORT

static final String PASSWORD_TOO_SHORT

See Also:

Constant Field Values

SAPSTAR_ACTIVATED

static final String SAPSTAR_ACTIVATED

See Also:

Constant Field Values

SPEC_CHARS_REQUIRED_FOR_PSWD

static final String SPEC_CHARS_REQUIRED_FOR_PSWD

See Also:

Constant Field Values

USER_AUTH_FAILED

static final String USER_AUTH_FAILED

See Also:

Constant Field Values

USER_IS_CURRENTLY_NOT_VALID

static final String USER_IS_CURRENTLY_NOT_VALID

See Also:

Constant Field Values

USERID_CONTAINED_IN_PASSWORD

static final String USERID_CONTAINED_IN_PASSWORD

See Also:

Constant Field Values

USERID_NOT_FOUND

static final String USERID_NOT_FOUND

See Also:

Constant Field Values

WRONG_OLD_PASSWORD

static final String WRONG_OLD_PASSWORD

See Also:

Constant Field Values

WRONG_PASSWORD

static final String WRONG_PASSWORD

See Also:

Constant Field Values

LOGONID_IS_NULL

static final String LOGONID_IS_NULL

See Also:

Constant Field Values

LOGONID_TOO_LONG

static final String LOGONID_TOO_LONG

See Also:

Constant Field Values

LOGONID_TOO_SHORT

static final String LOGONID_TOO_SHORT

See Also:

Constant Field Values

WHITESPACES_NOT_ALLOWED

static final String WHITESPACES_NOT_ALLOWED

See Also:

Constant Field Values

SPEC_CHARS_REQUIRED_FOR_LOGONID

static final String SPEC_CHARS_REQUIRED_FOR_LOGONID

See Also:

Constant Field Values

MIXED_CASE_REQUIRED_FOR_LOGONID

static final String MIXED_CASE_REQUIRED_FOR_LOGONID

See Also:

Constant Field Values

ALPHANUM_REQUIRED_FOR_LOGONID

static final String ALPHANUM_REQUIRED_FOR_LOGONID

See Also:

Constant Field Values

Method Detail

getPasswordSuccessfulCheckDateDefault

Date getPasswordSuccessfulCheckDateDefault()

Returns the PasswordSuccessfulCheckDateDefault attribute of the ISecurityPolicy object. Default value is 12/31/9999

Returns:

The PasswordSuccessfulCheckDateDefault value

setPasswordSuccessfulCheckDateDefault

void setPasswordSuccessfulCheckDateDefault(Date newDate)

Deprecated.

Sets the PasswordSuccessfulCheckDateDefault attribute of the ISecurityPolicy object. This value is used to enforce the PasswordMaxIdleTime policy if no successful logon date is available (because no logon succeeded yet).

Parameters:

newDate - The new PasswordSuccessfulCheckDateDefault value

setPasswordPasswordLastChangeDateDefault

void setPasswordPasswordLastChangeDateDefault(Date newDate)

Deprecated.

Sets the PasswordLastChangeDateDefault attribute of the ISecurityPolicy object. This value is used to enforce the PasswordExpiredDays policy if no password change date is available (because it is not changed yet).

Parameters:

newDate - The new PasswordLastChangeDateDefault value

getPasswordLastChangeDateDefault

Date getPasswordLastChangeDateDefault()

Returns the PasswordLastChangeDateDefault (MM/DD/YYYY) attribute of the ISecurityPolicy object.

Returns:

The PasswordLastChangeDateDefault value

setPasswordMaxIdleTime

void setPasswordMaxIdleTime(int time)

Deprecated.

Sets the PasswordMaxIdleTime(in days) attribute of the ISecurityPolicy object. If a password is not successfully used for the set period, the password is expired and can't be used for logon until a new password is set by an administrator. Default value is 0 which means no expiration.

Parameters:

time - The new PasswordMaxIdleTime value

getPasswordMaxIdleTime

int getPasswordMaxIdleTime()

Returns the PasswordMaxIdleTime(in days) attribute of the ISecurityPolicy object. Default value is 0 which means no expiration.

Returns:

The PasswordMaxIdleTime value

isPasswordValid

boolean isPasswordValid(String pass)
                        throws InvalidPasswordException

Deprecated. please use isPasswordValid(String pass, String logonId)

Check the validity of the password against the password policy Set the logonID of the user before with the method setUserName().

Parameters:

pass - password to check

Returns:

boolean is the password valid

Throws:

InvalidPasswordException

isPasswordValid

boolean isPasswordValid(String pass,
                        String logonId)
                        throws InvalidPasswordException

Check the validity of the password against the password policy

Parameters:

pass - password to check

logonId - logonID to check against the password.

Returns:

boolean is the password valid

Throws:

InvalidPasswordException

validatePassword

String validatePassword(String pass)

Deprecated. please use validatePassword(String pass, String uid)

Check the validity of the password against the password policy. Set the logonID of the user before with the method setUserName().

Parameters:

pass - password to check

Returns:

the error message why the password is not valid or null

validatePassword

String validatePassword(String pass,
                        String uid)

Check the validity of the password against the password policy.

Parameters:

pass - password to check

Returns:

the error message why the password is not valid or null

generatePassword

String generatePassword()

Generate a password for this security policy.

Returns:

a valid password

generatePassword

String generatePassword(String userid)

Generate a password for this security policy.

Parameters:

userid - the user id to generate a password for

Returns:

a valid password

getLockAfterInvalidAttempts

int getLockAfterInvalidAttempts()

Gets the Number of Allowed Logon Attempts (AllowedLogonAttempts) attribute of the ISecurityPolicy object

Returns:

The AllowedLogonAttempts value

setLockAfterInvalidAttempts

void setLockAfterInvalidAttempts(int count)

Deprecated.

Sets the Number of Allowed Logon Attempts (AllowedLogonAttempts) attribute of the ISecurityPolicy object

Parameters:

count - The new AllowedLogonAttempts value

getAutoUnlockTime

int getAutoUnlockTime()

Gets the AutoUnlockTime(in seconds) attribute of the ISecurityPolicy object

Returns:

The AutoUnlockTime value

setAutoUnlockTime

void setAutoUnlockTime(int time)

Deprecated.

Sets the AutoUnlockTime(in seconds) attribute of the ISecurityPolicy object

Parameters:

time - The new AutoUnlockTime value

getPasswordMinLength

int getPasswordMinLength()

Gets the Password Minimum Length(PasswordMinLength) attribute of the ISecurityPolicy object

Returns:

The PasswordMinLength value

setPasswordMinLength

void setPasswordMinLength(int length)

Deprecated.

Sets the Password Minimum Length(PasswordMinLength) attribute of the ISecurityPolicy object

Parameters:

length - The new PasswordMinLength value

getPasswordMaxLength

int getPasswordMaxLength()

Gets the Password Maximum Length(PasswordMaxLength) attribute of the ISecurityPolicy object

Returns:

The PasswordMaxLength value

setPasswordMaxLength

void setPasswordMaxLength(int length)

Deprecated.

Sets the Password Maximum Length(PasswordMaxLength) attribute of the ISecurityPolicy object

Parameters:

length - The new PasswordMaxLength value

getUseridInPasswordAllowed

boolean getUseridInPasswordAllowed()

Return a boolean indicating whether the password need to be different from the user id(uid).

Returns:

a boolean indicating whether the password need to be different from the user id(uid).

setUseridInPasswordAllowed

void setUseridInPasswordAllowed(boolean pwnur)

Deprecated.

Sets the boolean indicating whether the password need to be different from the user id(uid).

Parameters:

pwnur - a boolean indicating whether the password need to be different from the user id(uid).

getOldInNewAllowed

boolean getOldInNewAllowed()

Return a boolean indicating whether the password need to be different from the old password.

Returns:

a boolean indicating whether the password need to be different from old password.

getEnforcePolicyAtLogon

boolean getEnforcePolicyAtLogon()

Returns a boolean indicating whether users who have a productive password that doesn't match the security policy settings have to change it during password logon.

Returns:

whether the plolicy is enforced at logon or not.

setEnforcePolicyAtLogon

void setEnforcePolicyAtLogon(boolean enforcePolicyAtLogon)

Sets whether users who have a productive password that doesn't match the security policy settings have to change it during password logon.

Parameters:

enforcePolicyAtLogon - specifies whether the plolicy is enforced at logon or not.

setOldInNewAllowed

void setOldInNewAllowed(boolean allow)

Deprecated.

Sets the boolean indicating whether the password need to be different from the old password.

Parameters:

allow - a boolean indicating whether the password need to be different from old password.

getPasswordMixCaseRequired

int getPasswordMixCaseRequired()

Return a number indicating how many capical and lower case letters the password must contain.

Returns:

number of required both capical and lower case letters.

setPasswordMixCaseRequired

void setPasswordMixCaseRequired(int number)

Deprecated.

Sets the number indicating how many capical and lower case letters the password must contain.

Parameters:

number - the number of both capical and lower case letters.

getLogonIdLowerCaseRequired

int getLogonIdLowerCaseRequired()

Return a number indicating how many capical and lower case letters the logon id must contain.

Returns:

number of required both capical and lower case letters.

setLogonIdLowerCaseRequired

void setLogonIdLowerCaseRequired(int number)

Deprecated.

Sets the number indicating how many capical and lower case letters the logon id must contain.

Parameters:

number - the number of both capical and lower case letters.

getPasswordAlphaNumericRequired

int getPasswordAlphaNumericRequired()

Return the number indicating how many alphabets and numeric values the password must contain.

Returns:

number of required both alphabets and numeric values.

setPasswordAlphaNumericRequired

void setPasswordAlphaNumericRequired(int number)

Deprecated.

Sets the number indicating how many alphabets and numeric values the password must contain.

Parameters:

number - the number of required both alphabets and numeric values.

getLogonIdNumericDigitsRequired

int getLogonIdNumericDigitsRequired()

Return the number indicating how many alphabets and numeric values the logon id must contain.

Returns:

number of required both alphabets and numeric values.

setLogonIdNumericDigitsRequired

void setLogonIdNumericDigitsRequired(int number)

Deprecated.

Sets the number indicating how many alphabets and numeric values the logon id must contain.

Parameters:

number - the number of required both alphabets and numeric values.

getPasswordSpecialCharRequired

int getPasswordSpecialCharRequired()

Return the number indicating how many special characters the password must contain.

Returns:

a number indicating whether the password has to include both alphabets and numeric values Return the boolean indicating whether the password has to include special character

setPasswordSpecialCharRequired

void setPasswordSpecialCharRequired(int number)

Deprecated.

Sets the number indicating how many special characters the password must contain.

Parameters:

number - the number of required special characters.

getPasswordExpiredDays

int getPasswordExpiredDays()

Return the numbers of days the password is set to expired. If the return value is 0, that means the password does not expired.

Returns:

The numbers of days the password is set to expired

getPasswordHistory

int getPasswordHistory()

Gets the PasswordHistory attribute of the SecurityPolicy object. If the return value is 0, that means that no password history is used.

Returns:

The PasswordHistory value

setPasswordExpiredDays

void setPasswordExpiredDays(int days)

Deprecated.

Sets the numbers of days the password is to be expired. If the value is set to be 0, that means the password will not expired.

Parameters:

days - The numbers of days the password is set to expired

setPasswordHistory

void setPasswordHistory(int length)

Deprecated.

Sets the PasswordHistory attribute of the SecurityPolicy object

Parameters:

length - The new PasswordHistory value

getPasswordChangeAllowed

boolean getPasswordChangeAllowed()

Return the boolean value indicating whether the password is allowed to be changed.

Returns:

A boolean value indicating whether the password is allowed to be changed

setPasswordChangeAllowed

void setPasswordChangeAllowed(boolean pca)

Deprecated.

Sets the boolean value indicating whether the password is allowed to be changed.

Parameters:

pca - The boolean value indicating whether the password is allowed to changed

getPasswordChangeRequired

boolean getPasswordChangeRequired()

Deprecated.

Return the boolean value indicating whether the password is enforced to change at the first logon.

Returns:

A boolean value indicating whether the password is enforced to change

setPasswordChangeRequired

void setPasswordChangeRequired(boolean pca)

Deprecated.

Sets the boolean value indicating whether the password is enforced to change.

Parameters:

pca - The boolean value indicating whether the password is enforced to change

getLogonIdMinLength

int getLogonIdMinLength()

Return the integer value indicating the minimum length of a logon id.

Returns:

The integer value indicating the minimum length of a logon id.

setLogonIdMinLength

void setLogonIdMinLength(int length)

Deprecated.

Sets the integer value indicating the minimum length of a logon id.

Parameters:

length - integer value indicating the minimum length of a logon id.

getLogonIdMaxLength

int getLogonIdMaxLength()

Return the integer value indicating the maximum length of a logon id.

Returns:

The integer value indicating the maximum length of a logon id.

setLogonIdMaxLength

void setLogonIdMaxLength(int length)

Deprecated.

Sets the integer value indicating the maximum length of a logon id.

Parameters:

length - integer value indicating the maximum length of a logon id.

getLogonIdSpecialCharRequired

int getLogonIdSpecialCharRequired()

Return a number indicating how many special characters the logon id must contain.

Returns:

number of required special characters.

setLogonIdSpecialCharRequired

void setLogonIdSpecialCharRequired(int number)

Deprecated.

Sets the number indicating how many special characters the logon id must contain.

Parameters:

number - the number of special characters.

isLogonIdValid

boolean isLogonIdValid(String logonId)
                       throws InvalidLogonIdException

Check the validity of the logon id against the security policy

Parameters:

logonId - logonid to check

Returns:

boolean true if the logon id is valid

Throws:

InvalidLogonIdException - if the logon id is invalid

generateLogonId

String generateLogonId()
                       throws InvalidLogonIdException

Generate a logon id for this security policy.

Returns:

a valid logon id

Throws:

InvalidLogonIdException - if security policy configuration cannot be fullfilled

getCertLogonRequired

boolean getCertLogonRequired()

Deprecated.

setCertLogonRequired

void setCertLogonRequired(boolean clr)

Deprecated.

getCookieLifeTime

int getCookieLifeTime()

Deprecated.

setCookieLifeTime

void setCookieLifeTime(int lifeTime)

Deprecated.

setUserName

void setUserName(String id)

Deprecated.

getLocalizedMessage

String getLocalizedMessage(Locale locale,
                           Exception ex)

Return a localized password exception message for the given key.

Parameters:

locale - the locale

ex - the exception which hold the key as message

Returns:

the localized message or when not available

getLocalizedMessage

String getLocalizedMessage(Locale locale,
                           String key)

Return a localized password exception message for the given key.

Parameters:

locale - the locale

key - the key

Returns:

the localized message or when not available