com.netegrity.sdk.policyapi
Class SmPasswordPolicy

java.lang.Object
  com.netegrity.sdk.policyapi.SmObjectImpl
      com.netegrity.sdk.policyapi.SmPasswordPolicy

All Implemented Interfaces:

SmObject, java.lang.Cloneable

public final class SmPasswordPolicy
extends SmObjectImpl

Represents SiteMinder Password Policy object.

This object has global scope.

Since:

SDK 2.0

Field Summary

static java.lang.String	PropActive Constant to indicate the property Active.
static java.lang.String	PropClass Constant to indicate the property Class.
static java.lang.String	PropDictionaryName Constant to indicate the property Dictionary Name.
static java.lang.String	PropDictionaryPartial Constant to indicate the property Dictionary Partial.
static java.lang.String	PropExpirationDelay Constant to indicate the property Expiration Delay.
static java.lang.String	PropExpiredRedirect Constant to indicate the property Expired Redirect.
static java.lang.String	PropGlobal Constant to indicate the property Global.
static java.lang.String	PropLoginDaysGrace Constant to indicate the property Login Days Grace.
static java.lang.String	PropLoginInactivityWarn Constant to indicate the property Login Inactivity Warn.
static java.lang.String	PropLoginMaxFailures Constant to indicate the property Maximum Login Failures.
static java.lang.String	PropLoginMaxInactivity Constant to indicate the property Maximum Login Inactivity.
static java.lang.String	PropMaxFailuresRedirect Not used.
static java.lang.String	PropPasswordBehavior Constant to indicate the property Password Behavior.
static java.lang.String	PropPasswordCheckLib Constant to indicate the property password Check Lib.
static java.lang.String	PropPasswordPolicies Property name to be specified in the method getGlobalObjectNames().
static java.lang.String	PropPath Constant to indicate the property Path.
static java.lang.String	PropPriority Constant to indicate the property Priority.
static java.lang.String	PropPWMaxLength Constant to indicate the property Password Maximum Length.
static java.lang.String	PropPWMaxRepeatingChar Constant to indicate the property Password Maximum Repeating Characters.
static java.lang.String	PropPWMinAlpha Constant to indicate the property Minimum Alphabets.
static java.lang.String	PropPWMinAlphaNum Constant to indicate the property Minimum Alpha-Numeric Characters.
static java.lang.String	PropPWMinLength Constant to indicate the property Password Minimum Length.
static java.lang.String	PropPWMinLowerAlpha Constant to indicate the property Password Minimum Lower Alphabet.
static java.lang.String	PropPWMinNonAlpha Constant to indicate the property Minimum Non-Alphabets.
static java.lang.String	PropPWMinNonPrintable Constant to indicate the property Minimum Non-Printable Characters.
static java.lang.String	PropPWMinNumbers Constant to indicate the property Minimum Numbers.
static java.lang.String	PropPWMinPunctuation Constant to indicate the property Minimum Punctuation.
static java.lang.String	PropPWMinUpperAlpha Constant to indicate the property Password Minimum Upper Alphabet.
static java.lang.String	PropPWPercentDifferent Constant to indicate the property Percent Different.
static java.lang.String	PropPWPercentSequence Constant to indicate the property Percent Sequence.
static java.lang.String	PropPWReuseCount Constant to indicate the property Reuse Count.
static java.lang.String	PropPWReuseDelay Constant to indicate the property Reuse Delay.
static java.lang.String	PropPWSpecialsLength Constant to indicate the property Specials Length of the object.
static java.lang.String	PropReenablement Constant to indicate the property Re-enablement.
static java.lang.String	PropRegularExpressions Constant to indicate the property Regular Expressions.
static java.lang.String	PropResolution Constant to indicate the property Resolution.
static java.lang.String	PropUserDirectory Constant to indicate the property User Directory (searchable).
static int	Sm_PasswordPolicy_AllowFailedWrites Password Policy Behavior - Don't fail authentication if password data updates fail.
static int	Sm_PasswordPolicy_DontTrackFailedLogins Constant to indicate whether directory updates will be performed at login time.
static int	Sm_PasswordPolicy_DontTrackLogins Constant to indicate whether to use flags that allow the separate tracking of successful and failed logins.
static int	Sm_PasswordPolicy_DontTrackSuccessLogins Constant to indicate whether directory updates will be performed at login time.
static int	Sm_PasswordPolicy_InactivityForcePWChange Password Policy Behavior - If the user is marked inactive, don't disable.
static int	Sm_PasswordPolicy_PWExpiredForcePWChange Password Policy Behavior - If the user has an expired password, don't disable.

Fields inherited from class com.netegrity.sdk.policyapi.SmObjectImpl

PropObjectClassName

Fields inherited from interface com.netegrity.sdk.policyapi.SmObject

ConfigurationClassName, PropDesc, PropName, PropOid

Constructor Summary

SmPasswordPolicy()
Constructs a password policy object.

SmPasswordPolicy(java.lang.String name)
Constructs a password policy object with the specified name.

Method Summary

java.lang.String	getDictionaryName() Gets the location of a dictionary file for words that cannot be used in a password.
int	getDictionaryPartial() Gets the minimum number of letters needed to qualify for dictionary checking.
int	getExpirationDelay() Gets the Number of days of inactivity allowed before user account is disabled.
java.lang.String	getFilterClass() Gets the object class where the password policy applies.
java.lang.String	getFilterPath() Indicates the users to whom the password policy applies.
int	getLoginDaysGrace() Gets the number of days in advance to notify a user that the password will expire.
int	getLoginInactivityWarn() This is a reserved method.
int	getLoginMaxFailures() Gets the maximum number of failed login attempts a user can make before the user account is disabled.
int	getLoginMaxInactivity() Gets the number of days of inactivity allowed before a user password expires.
int	getPasswordBehavior() Gets the password policy behavior.
java.lang.String	getPasswordCheckLib() This property is reserved for future use.
int	getPasswordMaxLength() Gets the maximum length for user passwords.
int	getPasswordMaxRepeatingChar() Gets the maximum number of identical characters that can appear consecutively in a password.
int	getPasswordMinAlpha() Gets the minimum number of alphabetic characters (A-Z, a-z) that a password must contain.
int	getPasswordMinAlphaNum() Gets the minimum number of alphabetic or numeric characters that a password must contain.
int	getPasswordMinLength() Gets the minimum length for user passwords.
int	getPasswordMinLowerAlpha() Gets the value that is a safeguard against a user's Specifies whether to allow lower case alphabetic characters and, if so,the minimum number a password must contain.
int	getPasswordMinNonAlpha() Gets the minimum number of non-alphanumeric characters that a password must contain.
int	getPasswordMinNonPrintable() Gets the minimum number of non-printable characters that must be in a password.
int	getPasswordMinNumbers() Gets the minimum number of numeric characters (0-9) that a password must contain.
int	getPasswordMinPunctuation() Gets the minimum number of punctuation marks that a password must contain.
int	getPasswordMinUpperAlpha() Gets the value that is a safeguard against a user's Specifies whether to allow upper case alphabetic characters and, if so,the minimum number a password must contain.
int	getPasswordPercentDifferent() Gets the percentage of characters a new password must contain that differ from characters in the previous password.
int	getPasswordPercentSequence() Gets the flag that indicates whether or not to ignore sequence (character position) when the different-from-previous-characters percentage is calculated.
int	getPasswordReuseCount() Gets the number of new passwords that must be used before an old one can be reused.
int	getPasswordReuseDelay() Gets the number of days a user must wait before reusing a password.
java.lang.String	getPasswordServicesRedirect() Gets the URL where the user is redirected when an invalid password is entered.
int	getPasswordSpecialsLength() Gets the value that is a safeguard against a user's incorporating personal information in a password.
int	getPriority() Gets the priority where you configure options that determine how multiple policies that will apply to the same user directory or namespace are applied.
int	getReenablement() Gets the number of minutes a user must wait before attempting to log in again.
int	getResolution() Retrieves the password policy resolution within the LDAP directory.
SmObjId	getUserDirectoryOid() Gets the object identifier of the user directory where the password policy will apply.
boolean	isEnabled() Checks whether the password policy is enabled.
boolean	isEntireDir() Checks whether the password policy applies to the whole directory.
void	readProperties(java.util.Hashtable properties) Copies the object properties from the specified hashtable.
void	setDictionaryName(java.lang.String dictionaryName) Set the location of a dictionary file for words that cannot be used in a password.
void	setDictionaryPartial(int dictionaryPartial) Sets the minimum number of letters needed to qualify for dictionary checking.
void	setEnabled(boolean enable) Specifies whether the password policy is enabled.
void	setEntireDir(boolean entireDir) Specifies whether the password policy applies to the whole directory.
void	setExpirationDelay(int expirationDelay) Sets the Number of days of inactivity allowed before user account is disabled.
void	setFilterClass(java.lang.String filterClass) If isEntireDir() is false, use this method to specify the object class where the password policy applies.
void	setFilterPath(java.lang.String filterPath) If isEntireDir() is false, use this method to specify the users to whom the password policy applies.
void	setLoginDaysGrace(int loginDaysGrace) Sets the number of days in advance to notify user that the password will expire.
void	setLoginInactivityWarn(int loginInactivityWarn) This is a reserved method.
void	setLoginMaxFailures(int loginMaxFailures) Sets the maximum number of failed login attempts a user can make before the user account is disabled.
void	setLoginMaxInactivity(int loginMaxInactivity) Sets the number of days of inactivity allowed before a user password expires.
void	setPasswordBehavior(int passwordBehavior) It was used to indicate that don't perform directory updates at login (successful or failed) time, if it was set.
void	setPasswordCheckLib(java.lang.String szPasswordCheckLib) This property is reserved for future use.
void	setPasswordMaxLength(int passwordMaxLength) Sets the maximum length for user passwords.
void	setPasswordMaxRepeatingChar(int passwordMaxRepeatingChar) Sets the maximum number of identical characters that can appear consecutively in a password.
void	setPasswordMinAlpha(int passwordMinAlpha) Sets the minimum number of alphabetic characters (A-Z, a-z) that a password must contain.
void	setPasswordMinAlphaNum(int passwordMinAlphaNum) Sets the minimum number of alphabetic or numeric characters that a password must contain.
void	setPasswordMinLength(int passwordMinLength) Sets the minimum length for user passwords.
void	setPasswordMinLowerAlpha(int PasswordMinLowerAlpha) Sets the minimum number of lower-alphanumeric characters that a password must contain.
void	setPasswordMinNonAlpha(int passwordMinNonAlpha) Sets the minimum number of non-alphanumeric characters that a password must contain.
void	setPasswordMinNonPrintable(int passwordMinNonPrintable) Sets the minimum number of non-printable characters that must be in a password.
void	setPasswordMinNumbers(int passwordMinNumbers) Sets the minimum number of numeric characters (0-9) that a password must contain.
void	setPasswordMinPunctuation(int passwordMinPunctuation) Sets the minimum number of punctuation marks that a password must contain.
void	setPasswordMinUpperAlpha(int nPasswordMinUpperAlpha) Sets the minimum number of lower-alphanumeric characters that a password must contain.
void	setPasswordPercentDifferent(int passwordPercentDifferent) Sets the percentage of characters a new password must contain that differ from characters in the previous password.
void	setPasswordPercentSequence(int passwordPercentSequence) Sets the flag that indicates whether or not to ignore sequence (character position) when the different-from-previous-characters percentage is calculated.
void	setPasswordReuseCount(int passwordReuseCount) Sets the number of new passwords that must be used before an old one can be reused.
void	setPasswordReuseDelay(int passwordReuseDelay) Sets the number of days a user must wait before reusing a password.
void	setPasswordServicesRedirect(java.lang.String passwordServicesRedirect) Sets the URL where the user is redirected when an invalid password is entered.
void	setPasswordSpecialsLength(int passwordSpecialsLength) Sets the value that is a safeguard against a user's incorporating personal information in a password.
void	setPriority(int Priority) Sets the priority field-Specifies the evaluation priority for the password policy.
void	setReenablement(int reenablement) Sets the number of minutes a user must wait before attempting to log in again.
void	setResolution(int resolution) Shows how the password policy applies to the users specified in setFilterPath().
void	setUserDirectoryOid(java.lang.Object userDirectoryOid) Specifies the object identifier of the user directory where the password policy will apply.
void	writeProperties(java.util.Hashtable properties) Copies the object properties to the specified hashtable.

Methods inherited from class com.netegrity.sdk.policyapi.SmObjectImpl

getDescription, getName, getObjectClassname, getOid, isDomainObject, isWriteable, newObject, setDescription, setName, setObjectClassname, setOid, setOid, toString, writeSearchProperties

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PropPasswordPolicies

public static final java.lang.String PropPasswordPolicies

Property name to be specified in the method getGlobalObjectNames().

See Also:

Constant Field Values

PropActive

public static final java.lang.String PropActive

Constant to indicate the property Active.

See Also:

Constant Field Values

PropGlobal

public static final java.lang.String PropGlobal

Constant to indicate the property Global.

See Also:

Constant Field Values

PropUserDirectory

public static final java.lang.String PropUserDirectory

Constant to indicate the property User Directory (searchable). You can search password policies based on this property.

See Also:

Constant Field Values

PropPath

public static final java.lang.String PropPath

Constant to indicate the property Path.

See Also:

Constant Field Values

PropClass

public static final java.lang.String PropClass

Constant to indicate the property Class.

See Also:

Constant Field Values

PropResolution

public static final java.lang.String PropResolution

Constant to indicate the property Resolution.

See Also:

Constant Field Values

PropLoginMaxFailures

public static final java.lang.String PropLoginMaxFailures

Constant to indicate the property Maximum Login Failures.

See Also:

Constant Field Values

PropLoginMaxInactivity

public static final java.lang.String PropLoginMaxInactivity

Constant to indicate the property Maximum Login Inactivity.

See Also:

Constant Field Values

PropLoginInactivityWarn

public static final java.lang.String PropLoginInactivityWarn

Constant to indicate the property Login Inactivity Warn.

See Also:

Constant Field Values

PropLoginDaysGrace

public static final java.lang.String PropLoginDaysGrace

Constant to indicate the property Login Days Grace.

See Also:

Constant Field Values

PropDictionaryName

public static final java.lang.String PropDictionaryName

Constant to indicate the property Dictionary Name.

See Also:

Constant Field Values

PropDictionaryPartial

public static final java.lang.String PropDictionaryPartial

Constant to indicate the property Dictionary Partial.

See Also:

Constant Field Values

PropExpirationDelay

public static final java.lang.String PropExpirationDelay

Constant to indicate the property Expiration Delay.

See Also:

Constant Field Values

PropReenablement

public static final java.lang.String PropReenablement

Constant to indicate the property Re-enablement.

See Also:

Constant Field Values

PropPasswordBehavior

public static final java.lang.String PropPasswordBehavior

Constant to indicate the property Password Behavior.

See Also:

Constant Field Values

PropExpiredRedirect

public static final java.lang.String PropExpiredRedirect

Constant to indicate the property Expired Redirect.

See Also:

Constant Field Values

PropPWMaxLength

public static final java.lang.String PropPWMaxLength

Constant to indicate the property Password Maximum Length.

See Also:

Constant Field Values

PropPWMinLength

public static final java.lang.String PropPWMinLength

Constant to indicate the property Password Minimum Length.

See Also:

Constant Field Values

PropPWMaxRepeatingChar

public static final java.lang.String PropPWMaxRepeatingChar

Constant to indicate the property Password Maximum Repeating Characters.

See Also:

Constant Field Values

PropPWMinAlphaNum

public static final java.lang.String PropPWMinAlphaNum

Constant to indicate the property Minimum Alpha-Numeric Characters.

See Also:

Constant Field Values

PropPWMinAlpha

public static final java.lang.String PropPWMinAlpha

Constant to indicate the property Minimum Alphabets.

See Also:

Constant Field Values

PropPWMinNonAlpha

public static final java.lang.String PropPWMinNonAlpha

Constant to indicate the property Minimum Non-Alphabets.

See Also:

Constant Field Values

PropPWMinNonPrintable

public static final java.lang.String PropPWMinNonPrintable

Constant to indicate the property Minimum Non-Printable Characters.

See Also:

Constant Field Values

PropPWMinNumbers

public static final java.lang.String PropPWMinNumbers

Constant to indicate the property Minimum Numbers.

See Also:

Constant Field Values

PropPWMinPunctuation

public static final java.lang.String PropPWMinPunctuation

Constant to indicate the property Minimum Punctuation.

See Also:

Constant Field Values

PropPWReuseCount

public static final java.lang.String PropPWReuseCount

Constant to indicate the property Reuse Count.

See Also:

Constant Field Values

PropPWReuseDelay

public static final java.lang.String PropPWReuseDelay

Constant to indicate the property Reuse Delay.

See Also:

Constant Field Values

PropPWPercentDifferent

public static final java.lang.String PropPWPercentDifferent

Constant to indicate the property Percent Different.

See Also:

Constant Field Values

PropPWPercentSequence

public static final java.lang.String PropPWPercentSequence

Constant to indicate the property Percent Sequence.

See Also:

Constant Field Values

PropPWSpecialsLength

public static final java.lang.String PropPWSpecialsLength

Constant to indicate the property Specials Length of the object.

See Also:

Constant Field Values

PropPriority

public static final java.lang.String PropPriority

Constant to indicate the property Priority.

See Also:

Constant Field Values

PropPWMinLowerAlpha

public static final java.lang.String PropPWMinLowerAlpha

Constant to indicate the property Password Minimum Lower Alphabet.

See Also:

Constant Field Values

PropPWMinUpperAlpha

public static final java.lang.String PropPWMinUpperAlpha

Constant to indicate the property Password Minimum Upper Alphabet.

See Also:

Constant Field Values

PropPasswordCheckLib

public static final java.lang.String PropPasswordCheckLib

Constant to indicate the property password Check Lib.

See Also:

Constant Field Values

PropRegularExpressions

public static final java.lang.String PropRegularExpressions

Constant to indicate the property Regular Expressions.

See Also:

Constant Field Values

PropMaxFailuresRedirect

public static final java.lang.String PropMaxFailuresRedirect

Not used.

See Also:

Constant Field Values

Sm_PasswordPolicy_DontTrackLogins

public static final int Sm_PasswordPolicy_DontTrackLogins

Constant to indicate whether to use flags that allow the separate tracking of successful and failed logins.

This flag has been replaced in SiteMinder v6.0 SP3 by:

• Sm_PasswordPolicy_DontTrackSuccessLogins
• Sm_PasswordPolicy_DontTrackFailedLogins

The new flags allow successful and failed logins to be tracked separately.

Sm_PasswordPolicy_DontTrackLogins is currently maintained for backwards compatiblity. If this flag is set, login tracking for successful and failed logins will not occur.

See Also:

Constant Field Values

Sm_PasswordPolicy_DontTrackSuccessLogins

public static final int Sm_PasswordPolicy_DontTrackSuccessLogins

Constant to indicate whether directory updates will be performed at login time.

When this flag is not set, the password policy tracks successful user logins, including the time of the last login.

Since:

SDK 6.0 SP3

See Also:

Sm_PasswordPolicy_DontTrackFailedLogins, Constant Field Values

Sm_PasswordPolicy_DontTrackFailedLogins

public static final int Sm_PasswordPolicy_DontTrackFailedLogins

Constant to indicate whether directory updates will be performed at login time.

When this flag is not set, the password policy tracks unsuccessful user login attempts.

Since:

SDK 6.0 SP3

See Also:

Sm_PasswordPolicy_DontTrackSuccessLogins, Constant Field Values

Sm_PasswordPolicy_AllowFailedWrites

public static final int Sm_PasswordPolicy_AllowFailedWrites

Password Policy Behavior - Don't fail authentication if password data updates fail. Used by the Policy API to define password policy characteristics.

See Also:

Constant Field Values

Sm_PasswordPolicy_InactivityForcePWChange

public static final int Sm_PasswordPolicy_InactivityForcePWChange

Password Policy Behavior - If the user is marked inactive, don't disable. Force a password change instead. Used by the Policy API to define password policy characteristics.

See Also:

Constant Field Values

Sm_PasswordPolicy_PWExpiredForcePWChange

public static final int Sm_PasswordPolicy_PWExpiredForcePWChange

Password Policy Behavior - If the user has an expired password, don't disable. Force a password change instead. Used by the Policy API to define password policy characteristics.

See Also:

Constant Field Values

Constructor Detail

SmPasswordPolicy

public SmPasswordPolicy()

Constructs a password policy object. The name and description are not set.

SmPasswordPolicy

public SmPasswordPolicy(java.lang.String name)

Constructs a password policy object with the specified name.

Parameters:

name - Name of the password policy.

Method Detail

isEntireDir

public boolean isEntireDir()

Checks whether the password policy applies to the whole directory.

Returns:

true if the password policy applies to the whole directory. false otherwise.

setEntireDir

public void setEntireDir(boolean entireDir)

Specifies whether the password policy applies to the whole directory.

Parameters:

entireDir - true if the password policy applies to the whole directory. false otherwise.

isEnabled

public boolean isEnabled()

Checks whether the password policy is enabled.

Returns:

true if the password policy is enabled. false otherwise.

setEnabled

public void setEnabled(boolean enable)

Specifies whether the password policy is enabled.

Parameters:

enabled - true if the password policy is enabled. false otherwise.

getUserDirectoryOid

public SmObjId getUserDirectoryOid()

Gets the object identifier of the user directory where the password policy will apply.

Returns:

The object identifier of the user directory.

setUserDirectoryOid

public void setUserDirectoryOid(java.lang.Object userDirectoryOid)

Specifies the object identifier of the user directory where the password policy will apply.

Parameters:

userDirectoryOid - The object identifier of the user directory.

getFilterPath

public java.lang.String getFilterPath()

Indicates the users to whom the password policy applies. For more information, see setFilterPath().

Returns:

The users to whom the password policy applies.

setFilterPath

public void setFilterPath(java.lang.String filterPath)

If isEntireDir() is false, use this method to specify the users to whom the password policy applies. For example, the values you can specify include:

• A complete user DN.
• A complete DN of an organization or group containing the users to whom the password policy applies.
• A search expression that represents the users to whom the password policy applies.

For more information, see setResolution().

Parameters:

filterPath - The users to whom the password policy applies.

getFilterClass

public java.lang.String getFilterClass()

Gets the object class where the password policy applies. For more information, see setFilterClass().

Returns:

The class that the password policy applies to.

setFilterClass

public void setFilterClass(java.lang.String filterClass)

If isEntireDir() is false, use this method to specify the object class where the password policy applies. Specify the object class as understood by a user directory,such as organizationalUnit in LDAP or User in NT.

Parameters:

filterClass - The object class where the password policy applies.

getResolution

public int getResolution()

Retrieves the password policy resolution within the LDAP directory. For more information, see setResolution().

Returns:

The password policy resolution.

setResolution

public void setResolution(int resolution)

Shows how the password policy applies to the users specified in setFilterPath(). For example:

• If setFilterPath() specifies the path to a group, SmUserPolicy.GROUP_CLASS indicates that the password policy applies to the members of the specified group.
  
  
• If setFilterPath() specifies a search expression that searches for all groups containing a particular attribute, SmUserPolicy.GROUP_ATTRIBUTE_CLASS indicates that the password policy applies to the members of the matching groups.

For a list of all password policy resolution constants, see setPolicyResolution().

Parameters:

resolution - The password policy resolution.

getLoginMaxFailures

public int getLoginMaxFailures()

Gets the maximum number of failed login attempts a user can make before the user account is disabled.

Returns:

The maximum number of failed login attempts.

setLoginMaxFailures

public void setLoginMaxFailures(int loginMaxFailures)

Sets the maximum number of failed login attempts a user can make before the user account is disabled.

Parameters:

loginMaxFailures - The maximum number of failed login attempts.

getLoginMaxInactivity

public int getLoginMaxInactivity()

Gets the number of days of inactivity allowed before a user password expires. The account is not disabled until the user tries to log in after the expiration.

Returns:

The number of days of inactivity allowed.

setLoginMaxInactivity

public void setLoginMaxInactivity(int loginMaxInactivity)

Sets the number of days of inactivity allowed before a user password expires. The account is not disabled until the user tries to log in after the expiration.

Parameters:

loginMaxInactivity - The number of days of inactivity allowed.

getLoginInactivityWarn

public int getLoginInactivityWarn()

This is a reserved method.

Returns:

login inactivity warn

setLoginInactivityWarn

public void setLoginInactivityWarn(int loginInactivityWarn)

This is a reserved method.

Parameters:

loginInactivityWarn -

getLoginDaysGrace

public int getLoginDaysGrace()

Gets the number of days in advance to notify a user that the password will expire.

Returns:

The number of days in advance to notify user that the password will expire.

setLoginDaysGrace

public void setLoginDaysGrace(int loginDaysGrace)

Sets the number of days in advance to notify user that the password will expire.

Parameters:

loginDaysGrace - The number of days in advance to notify user that the password will expire.

getDictionaryName

public java.lang.String getDictionaryName()

Gets the location of a dictionary file for words that cannot be used in a password.

Returns:

The location of a dictionary file for words that cannot be used in a password.

setDictionaryName

public void setDictionaryName(java.lang.String dictionaryName)

Set the location of a dictionary file for words that cannot be used in a password.

Parameters:

dictionaryName - The location of a dictionary file for words that cannot be used in a password.

getDictionaryPartial

public int getDictionaryPartial()

Gets the minimum number of letters needed to qualify for dictionary checking.

Returns:

The minimum number of letters needed to qualify for dictionary checking.

setDictionaryPartial

public void setDictionaryPartial(int dictionaryPartial)

Sets the minimum number of letters needed to qualify for dictionary checking. For example, set dictionaryPartial to 5 to avoid checking words of four or fewer characters. Set dictionaryPartial to 0 to reject any password that matches a word in the dictionary exactly.

Parameters:

dictionaryPartial - The minimum number of letters needed to qualify for dictionary checking.

getExpirationDelay

public int getExpirationDelay()

Gets the Number of days of inactivity allowed before user account is disabled.

Returns:

The Number of days of inactivity allowed before user account is disabled.

setExpirationDelay

public void setExpirationDelay(int expirationDelay)

Sets the Number of days of inactivity allowed before user account is disabled.

Parameters:

expirationDelay - The Number of days of inactivity allowed before user account is disabled.

getReenablement

public int getReenablement()

Gets the number of minutes a user must wait before attempting to log in again. The account is automatically re-enabled after this time period.

Returns:

The number of minutes a user must wait before attempting to log in again.

setReenablement

public void setReenablement(int reenablement)

Sets the number of minutes a user must wait before attempting to log in again. The account is automatically re-enabled after this time period.

Parameters:

reenablement - The number of minutes a user must wait before attempting to log in again.

getPasswordBehavior

public int getPasswordBehavior()

Gets the password policy behavior. See setPasswordBehavior() for the valid behavior flags that can be returned.

Returns:

The password behavior flag.

setPasswordBehavior

public void setPasswordBehavior(int passwordBehavior)

It was used to indicate that don't perform directory updates at login (successful or failed) time, if it was set. Now, when this flag is not set, the password policy checks 2 new bits which are described below. If this is set to '1' then new bits will not be checked and login tracking will be disabled. This bit should be set to 1 if next 2 bits are both set to 1 otherwise Obj layer will give error while saving the pasword policy object.

Sm_PasswordPolicy_DontTrackSuccessLogins
If this bit is set then directory updates will not be performed upon successful login.

Sm_PasswordPolicy_DontTrackFailedLogins
If this bit is set then directory updates will not be performed upon failed login.

Sm_PasswordPolicy_AllowFailedWrites
Allow users to log in even if password data cannot be written to the user directory.

Sm_PasswordPolicy_InactivityForcePWChange
Force a password change on the next login attempt after a user password becomes invalid due to inactivity.

Sm_PasswordPolicy_PWExpiredForcePWChange
Force a password change on the next login attempt after a user password expires.

You can also set recursive behavior for the password policy through the additional password behavior flag 0x02. Use this flag to indicate that the password policy applies to the group specified in setFilterPath() and to any groups nested within it.

Parameters:

passwordBehavior - Bit mask flags representing the password policy behavior.

getPasswordServicesRedirect

public java.lang.String getPasswordServicesRedirect()

Gets the URL where the user is redirected when an invalid password is entered. This will be the URL of the Password Services CGI script.

Returns:

The URL where the user is redirected when an invalid password is entered.

setPasswordServicesRedirect

public void setPasswordServicesRedirect(java.lang.String passwordServicesRedirect)

Sets the URL where the user is redirected when an invalid password is entered. This must be the URL of the Password Services CGI script.

Parameters:

passwordServicesRedirect - The URL where the user is redirected when an invalid password is entered.

getPasswordMaxLength

public int getPasswordMaxLength()

Gets the maximum length for user passwords.

Returns:

The maximum length for user passwords.

setPasswordMaxLength

public void setPasswordMaxLength(int passwordMaxLength)

Sets the maximum length for user passwords.

Parameters:

passwordMaxLength - The maximum length for user passwords.

getPasswordMinLength

public int getPasswordMinLength()

Gets the minimum length for user passwords.

Returns:

The minimum length for user passwords.

setPasswordMinLength

public void setPasswordMinLength(int passwordMinLength)

Sets the minimum length for user passwords.

Parameters:

passwordMinLength - The minimum length for user passwords.

getPasswordMaxRepeatingChar

public int getPasswordMaxRepeatingChar()

Gets the maximum number of identical characters that can appear consecutively in a password.

Returns:

The maximum number of identical characters that can appear consecutively in a password.

setPasswordMaxRepeatingChar

public void setPasswordMaxRepeatingChar(int passwordMaxRepeatingChar)

Sets the maximum number of identical characters that can appear consecutively in a password.

Parameters:

passwordMaxRepeatingChar - The maximum number of identical characters that can appear consecutively in a password.

getPasswordMinAlphaNum

public int getPasswordMinAlphaNum()

Gets the minimum number of alphabetic or numeric characters that a password must contain.

Returns:

the minimum number of alphabetic or numeric characters.

setPasswordMinAlphaNum

public void setPasswordMinAlphaNum(int passwordMinAlphaNum)

Sets the minimum number of alphabetic or numeric characters that a password must contain.

Parameters:

passwordMinAlphaNum - The minimum number of alphabetic or numeric characters.

getPasswordMinAlpha

public int getPasswordMinAlpha()

Gets the minimum number of alphabetic characters (A-Z, a-z) that a password must contain.

Returns:

The minimum number of alphabetic characters (A-Z, a-z) that a password must contain.

setPasswordMinAlpha

public void setPasswordMinAlpha(int passwordMinAlpha)

Sets the minimum number of alphabetic characters (A-Z, a-z) that a password must contain.

Parameters:

passwordMinAlpha - The minimum number of alphabetic characters (A-Z, a-z) that a password must contain.

getPasswordMinNonAlpha

public int getPasswordMinNonAlpha()

Gets the minimum number of non-alphanumeric characters that a password must contain. These characters include punctuation marks and other symbols located on the keyboard, such as "@", "$", and "*."

Returns:

The minimum number of non-alphanumeric characters that a password must contain.

setPasswordMinNonAlpha

public void setPasswordMinNonAlpha(int passwordMinNonAlpha)

Sets the minimum number of non-alphanumeric characters that a password must contain. These characters include punctuation marks and other symbols located on the keyboard, such as "@", "$", and "*."

Parameters:

passwordMinNonAlpha - The minimum number of non-alphanumeric characters that a password must contain.

getPasswordMinNonPrintable

public int getPasswordMinNonPrintable()

Gets the minimum number of non-printable characters that must be in a password. These characters cannot be displayed on a computer screen.

Returns:

The minimum number of non-printable characters that must be in a password.

setPasswordMinNonPrintable

public void setPasswordMinNonPrintable(int passwordMinNonPrintable)

Sets the minimum number of non-printable characters that must be in a password. These characters cannot be displayed on a computer screen.

Parameters:

passwordMinNonPrintable - The minimum number of non-printable characters that must be in a password.

getPasswordMinNumbers

public int getPasswordMinNumbers()

Gets the minimum number of numeric characters (0-9) that a password must contain.

Returns:

The minimum number of numeric characters (0-9) that a password must contain.

setPasswordMinNumbers

public void setPasswordMinNumbers(int passwordMinNumbers)

Sets the minimum number of numeric characters (0-9) that a password must contain.

Parameters:

passwordMinNumbers - The minimum number of numeric characters (0-9) that a password must contain.

getPasswordMinPunctuation

public int getPasswordMinPunctuation()

Gets the minimum number of punctuation marks that a password must contain.

Returns:

The minimum number of punctuation marks that a password must contain.

setPasswordMinPunctuation

public void setPasswordMinPunctuation(int passwordMinPunctuation)

Sets the minimum number of punctuation marks that a password must contain. These characters include periods, commas, exclamation marks, slashes, hyphens, dashes, and other marks used for punctuation.

Parameters:

passwordMinPunctuation - The minimum number of punctuation marks that a password must contain.

getPasswordReuseCount

public int getPasswordReuseCount()

Gets the number of new passwords that must be used before an old one can be reused.

Returns:

The number of new passwords that must be used before an old one can be reused.

setPasswordReuseCount

public void setPasswordReuseCount(int passwordReuseCount)

Sets the number of new passwords that must be used before an old one can be reused.

Parameters:

passwordReuseCount - The number of new passwords that must be used before an old one can be reused.

getPasswordReuseDelay

public int getPasswordReuseDelay()

Gets the number of days a user must wait before reusing a password.

Returns:

The number of days a user must wait before reusing a password.

setPasswordReuseDelay

public void setPasswordReuseDelay(int passwordReuseDelay)

Sets the number of days a user must wait before reusing a password.

Parameters:

passwordReuseDelay - The number of days a user must wait before reusing a password.

getPasswordPercentDifferent

public int getPasswordPercentDifferent()

Gets the percentage of characters a new password must contain that differ from characters in the previous password.

Returns:

The percentage of characters a new password must contain that differ from characters in the previous password.

setPasswordPercentDifferent

public void setPasswordPercentDifferent(int passwordPercentDifferent)

Sets the percentage of characters a new password must contain that differ from characters in the previous password.

Parameters:

passwordPercentDifferent - The percentage of characters a new password must contain that differ from characters in the previous password.

getPasswordPercentSequence

public int getPasswordPercentSequence()

Gets the flag that indicates whether or not to ignore sequence (character position) when the different-from-previous-characters percentage is calculated.

Returns:

The flag that indicates whether or not to ignore sequence.

setPasswordPercentSequence

public void setPasswordPercentSequence(int passwordPercentSequence)

Sets the flag that indicates whether or not to ignore sequence (character position) when the different-from-previous-characters percentage is calculated.

Parameters:

passwordPercentSequence - The flag that indicates whether or not to ignore sequence.

getPasswordSpecialsLength

public int getPasswordSpecialsLength()

Gets the value that is a safeguard against a user's incorporating personal information in a password. For more information, see setPasswordSpecialsLength().

Returns:

The safeguard value.

setPasswordSpecialsLength

public void setPasswordSpecialsLength(int passwordSpecialsLength)

Sets the value that is a safeguard against a user's incorporating personal information in a password.

SiteMinder checks the password against attributes in the user's directory entry. passwordSpecialsLength specifies the number of sequential characters to check. For example, if this value is set to 4, SiteMinder prohibits the use of four password characters that match the same sequence of four identical characters in the user's directory, such as the four last digits of the user’s telephone number.

Parameters:

passwordSpecialsLength - the value.

getPriority

public int getPriority()

Gets the priority where you configure options that determine how multiple policies that will apply to the same user directory or namespace are applied.

Returns:

The priority value.

setPriority

public void setPriority(int Priority)

Sets the priority field-Specifies the evaluation priority for the password policy. The value should be in the range 0 (the default) to 999. Applicable policies are evaluated in descending order (999 first; 0 last). Apply lower priority password policies check box-Determines whether lower priority password policies are applied after this one.

Parameters:

priority - teh value.

getPasswordMinLowerAlpha

public int getPasswordMinLowerAlpha()

Gets the value that is a safeguard against a user's Specifies whether to allow lower case alphabetic characters and, if so,the minimum number a password must contain.

Returns:

The safeguard value.

setPasswordMinLowerAlpha

public void setPasswordMinLowerAlpha(int PasswordMinLowerAlpha)

Sets the minimum number of lower-alphanumeric characters that a password must contain. These characters include digits, specifies whether to allow numbers and, if so, the minimum a password must contain.Letters or digits-specifies whether to allow either letters or numbers (upper or lower case, a-Z; 0-9) and if so, the minimum number a password must contain.Punctuation-Specifies whether to allow punctuation marks, and if so, the minimum number a password should contain. These can be periods, commas, exclamation marks, slashes, dashes, and hyphens.

Parameters:

passwordMinLowerAlpha - The minimum number of lower-alphanumeric characters that a password must contain.

getPasswordMinUpperAlpha

public int getPasswordMinUpperAlpha()

Gets the value that is a safeguard against a user's Specifies whether to allow upper case alphabetic characters and, if so,the minimum number a password must contain.

Returns:

The safeguard value.

setPasswordMinUpperAlpha

public void setPasswordMinUpperAlpha(int nPasswordMinUpperAlpha)

Sets the minimum number of lower-alphanumeric characters that a password must contain. These characters include digits, specifies whether to allow numbers and, if so, the minimum a password must contain.Letters or digits-specifies whether to allow either letters or numbers (upper or lower case, a-Z; 0-9) and if so, the minimum number a password must contain.Punctuation-Specifies whether to allow punctuation marks, and if so, the minimum number a password should contain. These can be periods, commas, exclamation marks, slashes, dashes, and hyphens.

Parameters:

nPasswordMinUpperAlpha - The minimum number of upper-alphanumeric characters that a password must contain.

getPasswordCheckLib

public java.lang.String getPasswordCheckLib()

This property is reserved for future use.

setPasswordCheckLib

public void setPasswordCheckLib(java.lang.String szPasswordCheckLib)

This property is reserved for future use.

writeProperties

public void writeProperties(java.util.Hashtable properties)

Description copied from interface: SmObject

Copies the object properties to the specified hashtable.

Specified by:

writeProperties in interface SmObject

Overrides:

writeProperties in class SmObjectImpl

Parameters:

properties - The hashtable where the object properties will be copied.

readProperties

public void readProperties(java.util.Hashtable properties)

Description copied from interface: SmObject

Copies the object properties from the specified hashtable.

Specified by:

readProperties in interface SmObject

Overrides:

readProperties in class SmObjectImpl

Parameters:

properties - The new properties of the object.