com.sap.security.api
Interface ISecurityPolicy

public interface ISecurityPolicy

Title: UME4 Security Policy Description: 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.

Version:

1.0

Method Summary

java.lang.String	generateLogonId() Generate a logon id for this security policy.
java.lang.String	generatePassword() 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.
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() Return the boolean value indicating whether the password is enforced to change at the first logon.
int	getPasswordExpiredDays() Return the numbers of days the password is set to expired.
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.
boolean	getUseridInPasswordAllowed() Return a boolean indicating whether the password need to be different from the user id(uid).
boolean	isLogonIdValid(java.lang.String logonId) Check the validity of the logon id against the security policy
boolean	isPasswordValid(java.lang.String pass) Deprecated. please use isPasswordValid(String pass, String logonId)
boolean	isPasswordValid(java.lang.String pass, java.lang.String logonId) Check the validity of the password against the password policy
void	setAutoUnlockTime(int time) Sets the AutoUnlockTime(in seconds) attribute of the ISecurityPolicy object
void	setCertLogonRequired(boolean clr) Deprecated.
void	setCookieLifeTime(int lifeTime) Deprecated.
void	setLockAfterInvalidAttempts(int count) Sets the Number of Allowed Logon Attempts (AllowedLogonAttempts) attribute of the ISecurityPolicy object
void	setLogonIdLowerCaseRequired(int number) Sets the number indicating how many capical and lower case letters the logon id must contain.
void	setLogonIdMaxLength(int length) Sets the integer value indicating the maximum length of a logon id.
void	setLogonIdMinLength(int length) Sets the integer value indicating the minimum length of a logon id.
void	setLogonIdNumericDigitsRequired(int number) Sets the number indicating how many alphabets and numeric values the logon id must contain.
void	setLogonIdSpecialCharRequired(int number) Sets the number indicating how many special characters the logon id must contain.
void	setOldInNewAllowed(boolean allow) Sets the boolean indicating whether the password need to be different from the old password.
void	setPasswordAlphaNumericRequired(int number) Sets the number indicating how many alphabets and numeric values the password must contain.
void	setPasswordChangeAllowed(boolean pca) Sets the boolean value indicating whether the password is allowed to be changed.
void	setPasswordChangeRequired(boolean pca) Sets the boolean value indicating whether the password is enforced to change.
void	setPasswordExpiredDays(int days) Sets the numbers of days the password is to be expired.
void	setPasswordMaxLength(int length) Sets the Password Maximum Length(PasswordMaxLength) attribute of the ISecurityPolicy object
void	setPasswordMinLength(int length) Sets the Password Minimum Length(PasswordMinLength) attribute of the ISecurityPolicy object
void	setPasswordMixCaseRequired(int number) Sets the number indicating how many capical and lower case letters the password must contain.
void	setPasswordSpecialCharRequired(int number) Sets the number indicating how many special characters the password must contain.
void	setUseridInPasswordAllowed(boolean pwnur) Sets the boolean indicating whether the password need to be different from the user id(uid).
void	setUserName(java.lang.String id) Deprecated.
java.lang.String	validatePassword(java.lang.String pass) Deprecated. please use validatePassword(String pass, String uid)
java.lang.String	validatePassword(java.lang.String pass, java.lang.String uid) Check the validity of the password against the password policy.

Method Detail

isPasswordValid

public boolean isPasswordValid(java.lang.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

isPasswordValid

public boolean isPasswordValid(java.lang.String pass,
                               java.lang.String logonId)
                        throws InvalidPasswordException

Check the validity of the password against the password policy

Parameters:

pass - password to check

logoId - logonID to check against the password.

Returns:

boolean is the password valid

validatePassword

public java.lang.String validatePassword(java.lang.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

public java.lang.String validatePassword(java.lang.String pass,
                                         java.lang.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

public java.lang.String generatePassword()

Generate a password for this security policy.

Returns:

a valid password

getLockAfterInvalidAttempts

public int getLockAfterInvalidAttempts()

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

Returns:

The AllowedLogonAttempts value

setLockAfterInvalidAttempts

public void setLockAfterInvalidAttempts(int count)

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

Parameters:

count - The new AllowedLogonAttempts value

getAutoUnlockTime

public int getAutoUnlockTime()

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

Returns:

The AutoUnlockTime value

setAutoUnlockTime

public void setAutoUnlockTime(int time)

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

Parameters:

time - The new AutoUnlockTime value

getPasswordMinLength

public int getPasswordMinLength()

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

Returns:

The PasswordMinLength value

setPasswordMinLength

public void setPasswordMinLength(int length)

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

Parameters:

length - The new PasswordMinLength value

getPasswordMaxLength

public int getPasswordMaxLength()

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

Returns:

The PasswordMaxLength value

setPasswordMaxLength

public void setPasswordMaxLength(int length)

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

Parameters:

length - The new PasswordMaxLength value

getUseridInPasswordAllowed

public 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

public void setUseridInPasswordAllowed(boolean pwnur)

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

public 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.

setOldInNewAllowed

public void setOldInNewAllowed(boolean allow)

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

public 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

public void setPasswordMixCaseRequired(int number)

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

public 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

public void setLogonIdLowerCaseRequired(int number)

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

public 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

public void setPasswordAlphaNumericRequired(int number)

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

public 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

public void setLogonIdNumericDigitsRequired(int number)

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

public 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

public void setPasswordSpecialCharRequired(int number)

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

Parameters:

number - the number of required special characters.

getPasswordExpiredDays

public 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

setPasswordExpiredDays

public void setPasswordExpiredDays(int days)

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

getPasswordChangeAllowed

public 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

public void setPasswordChangeAllowed(boolean pca)

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

public boolean getPasswordChangeRequired()

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

public void setPasswordChangeRequired(boolean pca)

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

public 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

public void setLogonIdMinLength(int length)

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

public 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

public void setLogonIdMaxLength(int length)

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

public int getLogonIdSpecialCharRequired()

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

Returns:

number of required special characters.

setLogonIdSpecialCharRequired

public void setLogonIdSpecialCharRequired(int number)

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

Parameters:

number - the number of special characters.

isLogonIdValid

public boolean isLogonIdValid(java.lang.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

public java.lang.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

public boolean getCertLogonRequired()

Deprecated.

setCertLogonRequired

public void setCertLogonRequired(boolean clr)

Deprecated.

getCookieLifeTime

public int getCookieLifeTime()

Deprecated.

setCookieLifeTime

public void setCookieLifeTime(int lifeTime)

Deprecated.

setUserName

public void setUserName(java.lang.String id)

Deprecated.