com.netegrity.llsdk6.imsapi.managedobject
Interface PasswordPolicy

All Superinterfaces:

AttributeCollection, ManagedObject, java.util.Map, ModifiableObject, NamedObject, java.io.Serializable

public interface PasswordPolicy
extends ManagedObject

Provides access to the attributes in a PasswordPolicy managed object through the methods inherited from the base interfaces.

PasswordPolicy represents a set of restrictions and controls around passwords.

Since:

Identity Manager 8.1

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

static java.lang.String	DESCRIPTION The password policy object's description.
static java.lang.String	DIRECTORY_FILTER_RESOLUTION_ALL The filter resolution specifies the entire directory.
static java.lang.String	DIRECTORY_FILTER_RESOLUTION_GROUP The filter path should identify a search expression for a group.
static java.lang.String	DIRECTORY_FILTER_RESOLUTION_ORG The filter path should identify a search expression for an organization.
static java.lang.String	DIRECTORY_FILTER_RESOLUTION_SEARCH_ANY The filter path should identify an arbitrary search expression against this directory.
static java.lang.String	DIRECTORY_FILTER_RESOLUTION_SEARCH_GROUPS The filter path should identify a search expression for a collection of groups.
static java.lang.String	DIRECTORY_FILTER_RESOLUTION_SEARCH_ORGS The filter path should identify a search expression for a collection of organizations.
static java.lang.String	DIRECTORY_FILTER_RESOLUTION_SEARCH_USERS The filter path should identify a search expression for a group of users based on user attributes.
static java.lang.String	DIRECTORY_FILTER_RESOLUTION_USER The filter path should identify a search expression for a particular user.
static java.lang.String	ENABLED The password policy object's enabled flag.
static java.lang.String	FRIENDLY_NAME The password policy object's friendly name.
static java.lang.String	VERSION The password policy object's version.

Method Summary

void	clearRegularExpressions() Clears the set of RegularExpression objects associated with this PasswordPolicy -- typically used by Identity Manager only.
PasswordPolicyRegEx	createRegularExpression(java.lang.String friendlyName, java.lang.String regularExpression, boolean noMatch) Creates a new regular expression for this password policy -- typically used by Identity Manager only.
void	enablePasswordPolicy(boolean enabled) Alters the enabled state of this password policy.
int	getAttributeMatchLength() Retrieves the number of consecutive password characters to compare to personal information in user profile attributes for this PasswordPolicy.
int	getDictionaryMatchLength() Retrieves the minimum length of words checked against the dictionary for this PasswordPolicy.
java.lang.String	getDictionaryPath() Retrieves the location of the user defined dictionary file of the PasswordPolicy.
java.lang.String	getDirectoryFilterPath() Retrieves the directory filter path of the PasswordPolicy.
java.lang.String	getDirectoryFilterResolution() Retrieves the directory filter resolution of the PasswordPolicy.
int	getEvaluationPriority() Retrieves the evaluation priority for this PasswordPolicy.
int	getExpirationDelayDays() Retrieves the number of days to delay action after the password expires for this PasswordPolicy.
ForceCaseType	getForceCaseType() Returns the ForceCaseType associated with this PasswordPolicy.This value cannot be null.
int	getLoginGraceDays() Retrieves the number of days to issue warnings before the password expires for this PasswordPolicy.
int	getLoginMaxFailures() Retrieves the number of login failures before an account is disabled for this PasswordPolicy.
int	getLoginMaxInactivityDays() Retrieves the number of days of inactivity before a password expires for this PasswordPolicy.
int	getMaxLength() Retrieves the maximum length of a password for this PasswordPolicy.
int	getMaxRepeatingChar() Retrieves the maximum number of repeating characters in a password for this PasswordPolicy.
int	getMinAlpha() Retrieves the minimum number of letters in a password for this PasswordPolicy.
int	getMinAlphaNumeric() Retrieves the minimum number of letters or digits in a password for this PasswordPolicy.
int	getMinLength() Retrieves the minimum length of a password for this PasswordPolicy.
int	getMinLowerCase() Retrieves the minimum number of lower case characters in a password for this PasswordPolicy.
int	getMinNonAlphaNumeric() Retrieves the minimum number of non-alphanumeric characters in a password for this PasswordPolicy.
int	getMinNonPrintable() Retrieves the minimum number of non-printable characters in a password for this PasswordPolicy.
int	getMinNumbers() Retrieves the minimum number of digits in a password for this PasswordPolicy.
int	getMinPunctuation() Retrieves the minimum number of punctuation characters in a password for this PasswordPolicy.
int	getMinUpperCase() Retrieves the minimum number of upper case characters in a password for this PasswordPolicy.
java.lang.String	getPasswordPolicyDescription() Retrieves the description of this password policy.
int	getPercentDifferent() Retrieves the percentage that a password must differ from the last password for this PasswordPolicy.
java.lang.String	getRedirectTaskTag() Find out the redirect task tag of the PasswordPolicy.
java.lang.String	getRedirectURL() Retrieves the redirect URL of the PasswordPolicy.
int	getReenablementMinutes() Retrieves the number of minutes before an account is re-enabled after being disabled due to login failures for this PasswordPolicy.
java.lang.String	getRegularExpressionMatch() Get regular expression that passwords must match.
java.lang.String	getRegularExpressionNoMatch() Get regular expression that passwords must not match.
java.util.Vector	getRegularExpressions() Retrieves the set of RegularExpression objects associated with this PasswordPolicy -- typically used by Identity Manager only.
int	getReuseCount() Retrieves the minimum number of passwords before a password can be reused for this PasswordPolicy.
int	getReuseDelayDays() Retrieves the minimum number of days before a password can be reused for this PasswordPolicy.
boolean	isAllowFailedWrites() Returns the current state of the flag indicating that successful login is allowed in the event that login tracking fails for this PasswordPolicy.
boolean	isApplyLowerPriority() Returns the current state of the flag that determines whether to apply lower priority password policies.
boolean	isDirectoryFilterRecurse() Returns the scope of the directory filter associated with the PasswordPolicy.
boolean	isEntireDirectory() Returns the scope of the PasswordPolicy.
boolean	isExpiredForceChange() Returns the current state of the flag indicating whether to force a password change when the password expires for this PasswordPolicy.
boolean	isInactivityForceChange() Returns the current state of the flag that determines whether to force a password change when the password expires due to inactivity for this PasswordPolicy.
boolean	isPasswordPolicyEnabled() Determines whether the password policy is enabled.
boolean	isPercentSequence() Returns the current state of the flag that determines whether to ignore the position of characters when determining the percentage of difference for this PasswordPolicy.
boolean	isReenableAccount() Returns the current state of the flag that determines whether to re-enable an account after being disabled for failed login attempts for this PasswordPolicy.
boolean	isRemoveEmbeddedWS() Returns the current state of the flag that determines whether to remove embedded whitespace for this PasswordPolicy.
boolean	isRemoveLeadingWS() Returns the current state of the flag that determines whether to remove leading whitespace for this PasswordPolicy.
boolean	isRemoveTrailingWS() Returns the current state of the flag that determines whether to remove trailing whitespace for this PasswordPolicy.
boolean	isSiteMinderPasswordPolicy() Check if this is a SiteMinder Password Policy
boolean	isTrackFailedLogins() Returns the current state of failed login tracking for the PasswordPolicy.
boolean	isTrackSuccessLogins() Returns the current state of successful login tracking for the PasswordPolicy.
void	setAllowFailedWrites(boolean allowFailedWrites) Sets the flag indicating whether successful login is allowed in the event that login tracking fails for this PasswordPolicy.
void	setApplyLowerPriority(boolean applyLower) Alters the state of the flag that detrmines whether to apply lower priority password policies.
void	setAttributeMatchLength(int matchLength) Sets the number of consecutive password characters to compare to personal information in user profile attributes for this PasswordPolicy.
void	setDictionaryMatchLength(int matchLength) Sets the minimum length of words checked against the dictionary for this PasswordPolicy.
void	setDictionaryPath(java.lang.String newPath) Sets the directory filter path of the PasswordPolicy.
void	setDirectoryFilterPath(java.lang.String newFilterPath) Sets the directory filter path of the PasswordPolicy.
void	setDirectoryFilterRecurse(boolean directoryFilterRecurse) Alters the scope of the directory filter associated with the PasswordPolicy.
void	setDirectoryFilterResolution(java.lang.String newResolution) Sets the directory filter resolution of the PasswordPolicy.
void	setEntireDirectory(boolean entireDirectory) Alters the scope of the PasswordPolicy.
void	setEvaluationPriority(int priority) Sets the evaluation priority for this PasswordPolicy.
void	setExpirationDelayDays(int newDays) Sets the number of days to delay action after the password expires for this PasswordPolicy.
void	setExpiredForceChange(boolean forceChange) Alters the state of flag indicating whether to force a password change when the password expires for this PasswordPolicy.
void	setForceCaseType(ForceCaseType type) Alters the ForceCaseType associated with this PasswordPolicy.
void	setFriendlyName(java.lang.String friendlyName) Sets the password policy's friendly name value.
void	setInactivityForceChange(boolean forceChange) Alters the state of the flag that determines whether to force a password change when the password expires due to inactivity for this PasswordPolicy.
void	setLoginGraceDays(int newDays) Sets the number of days to issue warnings before the password expires for this PasswordPolicy.
void	setLoginMaxFailures(int maxFailures) Sets the number of login failures before an account is disabled for this PasswordPolicy.
void	setLoginMaxInactivityDays(int newDays) Sets the number of days of inactivity before a password expires for this PasswordPolicy.
void	setMaxLength(int length) Sets the maximum length of a password for this PasswordPolicy.
void	setMaxRepeatingChar(int max) Sets the maximum number of repeating characters in a password for this PasswordPolicy.
void	setMinAlpha(int min) Sets the minimum number of letters in a password for this PasswordPolicy.
void	setMinAlphaNumeric(int min) Sets the minimum number of letters or digits in a password for this PasswordPolicy.
void	setMinLength(int length) Sets the minimum length of a password for this PasswordPolicy.
void	setMinLowerCase(int min) Sets the minimum number of lower case characters in a password for this PasswordPolicy.
void	setMinNonAlphaNumeric(int min) Sets the minimum number of non-alphanumeric characters in a password for this PasswordPolicy.
void	setMinNonPrintable(int min) Sets the minimum number of non-printable characters in a password for this PasswordPolicy.
void	setMinNumbers(int min) Sets the minimum number of digits in a password for this PasswordPolicy.
void	setMinPunctuation(int min) Sets the minimum number of punctuation characters in a password for this PasswordPolicy.
void	setMinUpperCase(int min) Sets the minimum number of upper case characters in a password for this PasswordPolicy.
void	setPasswordPolicyDescription(java.lang.String newDescription) Sets the description of this password policy.
void	setPercentDifferent(int newPercent) Sets the percentage that a password must differ from the last password for this PasswordPolicy.
void	setPercentSequence(boolean percentSequence) Alters the state of flag that determines whether to ignore the position of characters when determining the percentage of difference for this PasswordPolicy.
void	setRedirectTaskTag(java.lang.String newTaskTag) Set the redirect task tag of the PasswordPolicy.
void	setRedirectURL(java.lang.String newURL) Sets the redirect URL of the PasswordPolicy.
void	setReenableAccount(boolean reenable) Alters the state of the flag that determines whether to re-enable an account after being disabled for failed login attempts for this PasswordPolicy.
void	setReenablementMinutes(int minutes) Sets the number of minutes before an account is re-enabled after being disabled due to login failures for this PasswordPolicy.
void	setRegularExpressionMatch(java.lang.String regex) Set the regular expression that passwords must match.
void	setRegularExpressionNoMatch(java.lang.String regex) Set the regular expression that passwords must not match.
void	setRemoveEmbeddedWS(boolean removeWS) Alters the state of flag that determines whether to remove embedded whitespace for this PasswordPolicy.
void	setRemoveLeadingWS(boolean removeWS) Alters the state of the flag that determines whether to remove leading whitespace for this PasswordPolicy.
void	setRemoveTrailingWS(boolean removeWS) Alters the state of the flag that determines whether to remove trailing whitespace for this PasswordPolicy.
void	setReuseCount(int newCount) Sets the minimum number of passwords before a password can be reused for this PasswordPolicy.
void	setReuseDelayDays(int newDays) Sets the minimum number of days before a password can be reused for this PasswordPolicy.
void	setTrackFailedLogins(boolean trackFailedLogins) Alters the state of failed login tracking for the PasswordPolicy.
void	setTrackSuccessLogins(boolean trackSuccessLogins) Alters the state of successful login tracking for the PasswordPolicy.

Methods inherited from interface com.netegrity.llsdk6.imsapi.managedobject.ManagedObject

directAddAttributeValue, directRemoveAttributeValue, equals, fixUniqueNames, getImsDirectory, getImsEnvironment, getObjectType, getOrg, getOrg, getProvider, hashCode, move, persisted

Methods inherited from interface com.netegrity.llsdk6.imsapi.abstractinterface.NamedObject

getFriendlyName, getUniqueName, toString

Methods inherited from interface com.netegrity.llsdk6.imsapi.abstractinterface.AttributeCollection

addAttributes, addValueToAttribute, containsAttribute, doesAttributeHaveMultipleValues, enumerateAttributes, getAttribute, getAttributeMultiValue, getAttributePermission, getAttributes, getExtendedAttribute, getLastCommittedAttribute, getLastCommittedAttributeMultiValue, getLastCommittedValue, getOriginalAttribute, getOriginalAttributeMultiValue, getOriginalValue, getValue, hasAttributeChanged, isAttributeUncommitted, isUncommitted, makeCurrentValueOriginal, removeAttributes, setAttribute, setAttributeMultiValue, setAttributes, setValue, updateAttributeSet

Methods inherited from interface com.netegrity.llsdk6.imsapi.abstractinterface.ModifiableObject

modifyObject, modifyObject

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Field Detail

FRIENDLY_NAME

static final java.lang.String FRIENDLY_NAME

The password policy object's friendly name.

DESCRIPTION

static final java.lang.String DESCRIPTION

The password policy object's description.

ENABLED

static final java.lang.String ENABLED

The password policy object's enabled flag.

VERSION

static final java.lang.String VERSION

The password policy object's version.

DIRECTORY_FILTER_RESOLUTION_ALL

static final java.lang.String DIRECTORY_FILTER_RESOLUTION_ALL

The filter resolution specifies the entire directory.

See Also:

Constant Field Values

DIRECTORY_FILTER_RESOLUTION_USER

static final java.lang.String DIRECTORY_FILTER_RESOLUTION_USER

The filter path should identify a search expression for a particular user.

See Also:

Constant Field Values

DIRECTORY_FILTER_RESOLUTION_ORG

static final java.lang.String DIRECTORY_FILTER_RESOLUTION_ORG

The filter path should identify a search expression for an organization.

See Also:

Constant Field Values

DIRECTORY_FILTER_RESOLUTION_GROUP

static final java.lang.String DIRECTORY_FILTER_RESOLUTION_GROUP

The filter path should identify a search expression for a group.

See Also:

Constant Field Values

DIRECTORY_FILTER_RESOLUTION_SEARCH_USERS

static final java.lang.String DIRECTORY_FILTER_RESOLUTION_SEARCH_USERS

The filter path should identify a search expression for a group of users based on user attributes.

See Also:

Constant Field Values

DIRECTORY_FILTER_RESOLUTION_SEARCH_GROUPS

static final java.lang.String DIRECTORY_FILTER_RESOLUTION_SEARCH_GROUPS

The filter path should identify a search expression for a collection of groups.

See Also:

Constant Field Values

DIRECTORY_FILTER_RESOLUTION_SEARCH_ORGS

static final java.lang.String DIRECTORY_FILTER_RESOLUTION_SEARCH_ORGS

The filter path should identify a search expression for a collection of organizations.

See Also:

Constant Field Values

DIRECTORY_FILTER_RESOLUTION_SEARCH_ANY

static final java.lang.String DIRECTORY_FILTER_RESOLUTION_SEARCH_ANY

The filter path should identify an arbitrary search expression against this directory.

See Also:

Constant Field Values

Method Detail

setFriendlyName

void setFriendlyName(java.lang.String friendlyName)

Sets the password policy's friendly name value.

Note: To persist the change, call modifyObject().

Parameters:

friendlyName - The friendly name to set.

Throws:

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException

getPasswordPolicyDescription

java.lang.String getPasswordPolicyDescription()

Retrieves the description of this password policy.

Returns:

The password policy description.

Throws:

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException

setPasswordPolicyDescription

void setPasswordPolicyDescription(java.lang.String newDescription)

Sets the description of this password policy.

Parameters:

newDescription - The new password policy description.

Throws:

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException

isPasswordPolicyEnabled

boolean isPasswordPolicyEnabled()

Determines whether the password policy is enabled.

Returns:

true if the password policy is enabled, or false otherwise.

Throws:

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException

enablePasswordPolicy

void enablePasswordPolicy(boolean enabled)

Alters the enabled state of this password policy.

Parameters:

enabled - true to enable the password policy, or false to disable the password policy.

Throws:

com.netegrity.llsdk6.imsapi.exception.AttributeNotPresentException

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException

isEntireDirectory

boolean isEntireDirectory()

Returns the scope of the PasswordPolicy.

Returns:

true

setEntireDirectory

void setEntireDirectory(boolean entireDirectory)

Alters the scope of the PasswordPolicy.

Parameters:

entireDirectory - - true if the PasswordPolicy applies to the entire directory

getDirectoryFilterResolution

java.lang.String getDirectoryFilterResolution()

Retrieves the directory filter resolution of the PasswordPolicy.

Returns:

The directory filter resolution.

setDirectoryFilterResolution

void setDirectoryFilterResolution(java.lang.String newResolution)

Sets the directory filter resolution of the PasswordPolicy.

Parameters:

newResolution - A String containing the new filter resolution.

getDirectoryFilterPath

java.lang.String getDirectoryFilterPath()

Retrieves the directory filter path of the PasswordPolicy.

Returns:

The directory filter path.

setDirectoryFilterPath

void setDirectoryFilterPath(java.lang.String newFilterPath)

Sets the directory filter path of the PasswordPolicy.

Parameters:

newFilterPath - A String containing the new filter path.

isDirectoryFilterRecurse

boolean isDirectoryFilterRecurse()

Returns the scope of the directory filter associated with the PasswordPolicy.

Returns:

true if the directory filter is associated with the PasswordPolicy recurse

setDirectoryFilterRecurse

void setDirectoryFilterRecurse(boolean directoryFilterRecurse)

Alters the scope of the directory filter associated with the PasswordPolicy.

Parameters:

directoryFilterRecurse - - true if the directory filter is associated with the PasswordPolicy recurse

getRedirectTaskTag

java.lang.String getRedirectTaskTag()

Find out the redirect task tag of the PasswordPolicy.

Returns:

String The redirect task tag.

setRedirectTaskTag

void setRedirectTaskTag(java.lang.String newTaskTag)

Set the redirect task tag of the PasswordPolicy.

Parameters:

newURL - A String containing the new redirect task tag.

getRedirectURL

java.lang.String getRedirectURL()

Retrieves the redirect URL of the PasswordPolicy.

Returns:

The redirect URL.

setRedirectURL

void setRedirectURL(java.lang.String newURL)

Sets the redirect URL of the PasswordPolicy.

Parameters:

newURL - A String containing the new redirect URL.

isTrackSuccessLogins

boolean isTrackSuccessLogins()

Returns the current state of successful login tracking for the PasswordPolicy.

Returns:

true if successful login tracking is enabled.

setTrackSuccessLogins

void setTrackSuccessLogins(boolean trackSuccessLogins)

Alters the state of successful login tracking for the PasswordPolicy.

Parameters:

trackSuccessLogins - - true if successful login tracking is enabled

isTrackFailedLogins

boolean isTrackFailedLogins()

Returns the current state of failed login tracking for the PasswordPolicy.

Returns:

true if failed login tracking is enabled.

setTrackFailedLogins

void setTrackFailedLogins(boolean trackFailedLogins)

Alters the state of failed login tracking for the PasswordPolicy.

Parameters:

trackFailedLogins - - true if failed login tracking is enabled

isAllowFailedWrites

boolean isAllowFailedWrites()

Returns the current state of the flag indicating that successful login is allowed in the event that login tracking fails for this PasswordPolicy.

Returns:

true if successful login is allowed when tracking fails.

setAllowFailedWrites

void setAllowFailedWrites(boolean allowFailedWrites)

Sets the flag indicating whether successful login is allowed in the event that login tracking fails for this PasswordPolicy.

Parameters:

allowFailedWrites - - true if successful login is allowed when tracking fails

getExpirationDelayDays

int getExpirationDelayDays()

Retrieves the number of days to delay action after the password expires for this PasswordPolicy.

Returns:

The number of days to delay action after password expiration.

setExpirationDelayDays

void setExpirationDelayDays(int newDays)

Sets the number of days to delay action after the password expires for this PasswordPolicy.

Parameters:

newDays - The number of days to delay action after password expiration.

getLoginGraceDays

int getLoginGraceDays()

Retrieves the number of days to issue warnings before the password expires for this PasswordPolicy.

Returns:

The number of days to issue warnings before password expires.

setLoginGraceDays

void setLoginGraceDays(int newDays)

Sets the number of days to issue warnings before the password expires for this PasswordPolicy.

Parameters:

newDays - The number of days to issue warnings before the password expires.

isExpiredForceChange

boolean isExpiredForceChange()

Returns the current state of the flag indicating whether to force a password change when the password expires for this PasswordPolicy.

Returns:

boolean true if a password change is forced when the password expires

setExpiredForceChange

void setExpiredForceChange(boolean forceChange)

Alters the state of flag indicating whether to force a password change when the password expires for this PasswordPolicy.

Parameters:

forceChange - - true if a password change should be forced when password the expires

getLoginMaxFailures

int getLoginMaxFailures()

Retrieves the number of login failures before an account is disabled for this PasswordPolicy.

Returns:

The number of login failures before the account is disabled.

setLoginMaxFailures

void setLoginMaxFailures(int maxFailures)

Sets the number of login failures before an account is disabled for this PasswordPolicy.

Parameters:

maxFailures - The number of login failures before the account is disabled.

getReenablementMinutes

int getReenablementMinutes()

Retrieves the number of minutes before an account is re-enabled after being disabled due to login failures for this PasswordPolicy.

Returns:

The number of minutes before the account is re-enabled after being disabled due to login failures.

setReenablementMinutes

void setReenablementMinutes(int minutes)

Sets the number of minutes before an account is re-enabled after being disabled due to login failures for this PasswordPolicy.

Parameters:

minutes - The number of minutes before the account is re-enabled after being disabled due to login failures.

isReenableAccount

boolean isReenableAccount()

Returns the current state of the flag that determines whether to re-enable an account after being disabled for failed login attempts for this PasswordPolicy.

Returns:

true if the account should be re-enabled after being disabled for failed login attempts

setReenableAccount

void setReenableAccount(boolean reenable)

Alters the state of the flag that determines whether to re-enable an account after being disabled for failed login attempts for this PasswordPolicy.

Parameters:

reenable - - true if the account should be re-enabled after being disabled for failed login attempts

getLoginMaxInactivityDays

int getLoginMaxInactivityDays()

Retrieves the number of days of inactivity before a password expires for this PasswordPolicy.

Returns:

The number of days of inactivity before a password expires.

setLoginMaxInactivityDays

void setLoginMaxInactivityDays(int newDays)

Sets the number of days of inactivity before a password expires for this PasswordPolicy.

Parameters:

newDays - The number of days of inactivity before a password expires.

isInactivityForceChange

boolean isInactivityForceChange()

Returns the current state of the flag that determines whether to force a password change when the password expires due to inactivity for this PasswordPolicy.

Returns:

true if a password change should be forced when the password expires due to inactivity.

setInactivityForceChange

void setInactivityForceChange(boolean forceChange)

Alters the state of the flag that determines whether to force a password change when the password expires due to inactivity for this PasswordPolicy.

Parameters:

forceChange - - true if a password change should be forced when the password expires due to inactivity

getMinLength

int getMinLength()

Retrieves the minimum length of a password for this PasswordPolicy.

Returns:

The minimum length of a password.

setMinLength

void setMinLength(int length)

Sets the minimum length of a password for this PasswordPolicy.

Parameters:

length - The minimum length of a password.

getMaxLength

int getMaxLength()

Retrieves the maximum length of a password for this PasswordPolicy.

Returns:

The maximum length of a password.

setMaxLength

void setMaxLength(int length)

Sets the maximum length of a password for this PasswordPolicy.

Parameters:

length - The maximum length of a password.

getMaxRepeatingChar

int getMaxRepeatingChar()

Retrieves the maximum number of repeating characters in a password for this PasswordPolicy.

Returns:

The maximum number of repeating characters in a password.

setMaxRepeatingChar

void setMaxRepeatingChar(int max)

Sets the maximum number of repeating characters in a password for this PasswordPolicy.

Parameters:

max - The maximum number of repeating characters in a password.

getMinUpperCase

int getMinUpperCase()

Retrieves the minimum number of upper case characters in a password for this PasswordPolicy.

Returns:

The minimum number of upper case characters in a password.

setMinUpperCase

void setMinUpperCase(int min)

Sets the minimum number of upper case characters in a password for this PasswordPolicy.

Parameters:

min - The minimum number of upper case characters in a password.

getMinLowerCase

int getMinLowerCase()

Retrieves the minimum number of lower case characters in a password for this PasswordPolicy.

Returns:

The minimum number of lower case characters in a password.

setMinLowerCase

void setMinLowerCase(int min)

Sets the minimum number of lower case characters in a password for this PasswordPolicy.

Parameters:

min - The minimum number of lower case characters in a password.

getMinAlpha

int getMinAlpha()

Retrieves the minimum number of letters in a password for this PasswordPolicy.

Returns:

The minimum number of letters in a password.

setMinAlpha

void setMinAlpha(int min)

Sets the minimum number of letters in a password for this PasswordPolicy.

Parameters:

min - The minimum number of letters in a password.

getMinNumbers

int getMinNumbers()

Retrieves the minimum number of digits in a password for this PasswordPolicy.

Returns:

The minimum number of digits in a password.

setMinNumbers

void setMinNumbers(int min)

Sets the minimum number of digits in a password for this PasswordPolicy.

Parameters:

min - The minimum number of digits in a password.

getMinAlphaNumeric

int getMinAlphaNumeric()

Retrieves the minimum number of letters or digits in a password for this PasswordPolicy.

Returns:

The minimum number of letters or digits in a password.

setMinAlphaNumeric

void setMinAlphaNumeric(int min)

Sets the minimum number of letters or digits in a password for this PasswordPolicy.

Parameters:

min - The minimum number of letters or digits in a password.

getMinPunctuation

int getMinPunctuation()

Retrieves the minimum number of punctuation characters in a password for this PasswordPolicy.

Returns:

The minimum number of punctuation characters in a password.

setMinPunctuation

void setMinPunctuation(int min)

Sets the minimum number of punctuation characters in a password for this PasswordPolicy.

Parameters:

min - The minimum number of punctuation characters in a password.

getMinNonPrintable

int getMinNonPrintable()

Retrieves the minimum number of non-printable characters in a password for this PasswordPolicy.

Returns:

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

setMinNonPrintable

void setMinNonPrintable(int min)

Sets the minimum number of non-printable characters in a password for this PasswordPolicy.

Parameters:

min - The minimum number of non-printable characters in a password.

getMinNonAlphaNumeric

int getMinNonAlphaNumeric()

Retrieves the minimum number of non-alphanumeric characters in a password for this PasswordPolicy.

Returns:

The minimum number of non-alphanumeric characters in a password.

setMinNonAlphaNumeric

void setMinNonAlphaNumeric(int min)

Sets the minimum number of non-alphanumeric characters in a password for this PasswordPolicy.

Parameters:

min - The minimum number of non-alphanumeric characters in a password.

getReuseDelayDays

int getReuseDelayDays()

Retrieves the minimum number of days before a password can be reused for this PasswordPolicy.

Returns:

The minimum number of days before a password can be reused.

setReuseDelayDays

void setReuseDelayDays(int newDays)

Sets the minimum number of days before a password can be reused for this PasswordPolicy.

Parameters:

newDays - The minimum number of days before a password can be reused.

getReuseCount

int getReuseCount()

Retrieves the minimum number of passwords before a password can be reused for this PasswordPolicy.

Returns:

The minimum number of passwords before a password can be reused.

setReuseCount

void setReuseCount(int newCount)

Sets the minimum number of passwords before a password can be reused for this PasswordPolicy.

Parameters:

newCount - The minimum number of passwords before a password can be reused.

getPercentDifferent

int getPercentDifferent()

Retrieves the percentage that a password must differ from the last password for this PasswordPolicy.

Returns:

The percentage that a password must differ the from last password.

setPercentDifferent

void setPercentDifferent(int newPercent)

Sets the percentage that a password must differ from the last password for this PasswordPolicy.

Parameters:

newPercent - The percentage that a password must differ from last password.

isPercentSequence

boolean isPercentSequence()

Returns the current state of the flag that determines whether to ignore the position of characters when determining the percentage of difference for this PasswordPolicy.

Returns:

true if the position of characters should be ignored when determining the percentage of difference

setPercentSequence

void setPercentSequence(boolean percentSequence)

Alters the state of flag that determines whether to ignore the position of characters when determining the percentage of difference for this PasswordPolicy.

Parameters:

percentSequence - - true if the position of characters should be ignored when determining the percentage of difference

getAttributeMatchLength

int getAttributeMatchLength()

Retrieves the number of consecutive password characters to compare to personal information in user profile attributes for this PasswordPolicy.

Returns:

The number of consecutive password characters to compare to personal information in user profile attributes.

setAttributeMatchLength

void setAttributeMatchLength(int matchLength)

Sets the number of consecutive password characters to compare to personal information in user profile attributes for this PasswordPolicy.

Parameters:

matchLength - The number of consecutive password characters to compare to personal information in user profile attributes.

getDictionaryPath

java.lang.String getDictionaryPath()

Retrieves the location of the user defined dictionary file of the PasswordPolicy.

Returns:

The location of the user defined dictionary file.

setDictionaryPath

void setDictionaryPath(java.lang.String newPath)

Sets the directory filter path of the PasswordPolicy.

Parameters:

newPath - A String containing the location of the user defined dictionary file.

getDictionaryMatchLength

int getDictionaryMatchLength()

Retrieves the minimum length of words checked against the dictionary for this PasswordPolicy.

Returns:

The minimum length of words checked against the dictionary.

setDictionaryMatchLength

void setDictionaryMatchLength(int matchLength)

Sets the minimum length of words checked against the dictionary for this PasswordPolicy.

Parameters:

matchLength - The minimum length of words checked against the dictionary.

getForceCaseType

ForceCaseType getForceCaseType()

Returns the ForceCaseType associated with this PasswordPolicy.This value cannot be null.

Returns:

The object type of this task

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this object represents a Task that has already been deleted

setForceCaseType

void setForceCaseType(ForceCaseType type)

Alters the ForceCaseType associated with this PasswordPolicy.

Parameters:

type - - A ForceCaseType value representing the force case setting for the password policy

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this object represents a PasswordPolicy that has already been deleted

isRemoveLeadingWS

boolean isRemoveLeadingWS()

Returns the current state of the flag that determines whether to remove leading whitespace for this PasswordPolicy.

Returns:

true if leading whitespace from passwords should be removed.

setRemoveLeadingWS

void setRemoveLeadingWS(boolean removeWS)

Alters the state of the flag that determines whether to remove leading whitespace for this PasswordPolicy.

Parameters:

removeWS - - true if leading whitespace from passwords should be removed

isRemoveTrailingWS

boolean isRemoveTrailingWS()

Returns the current state of the flag that determines whether to remove trailing whitespace for this PasswordPolicy.

Returns:

true if trailing whitespace from passwords should be removed

setRemoveTrailingWS

void setRemoveTrailingWS(boolean removeWS)

Alters the state of the flag that determines whether to remove trailing whitespace for this PasswordPolicy.

Parameters:

removeWS - - true if trailing whitespace from passwords should be removed

isRemoveEmbeddedWS

boolean isRemoveEmbeddedWS()

Returns the current state of the flag that determines whether to remove embedded whitespace for this PasswordPolicy.

Returns:

true if embedded whitespace from passwords should be removed.

setRemoveEmbeddedWS

void setRemoveEmbeddedWS(boolean removeWS)

Alters the state of flag that determines whether to remove embedded whitespace for this PasswordPolicy.

Parameters:

removeWS - - true if embedded whitespace from passwords should be removed

getEvaluationPriority

int getEvaluationPriority()

Retrieves the evaluation priority for this PasswordPolicy.

Returns:

The evaluation priority.

setEvaluationPriority

void setEvaluationPriority(int priority)

Sets the evaluation priority for this PasswordPolicy.

Parameters:

priority - The evaluation priority.

isApplyLowerPriority

boolean isApplyLowerPriority()

Returns the current state of the flag that determines whether to apply lower priority password policies.

Returns:

true if lower priority password policies should be applied

setApplyLowerPriority

void setApplyLowerPriority(boolean applyLower)

Alters the state of the flag that detrmines whether to apply lower priority password policies.

Parameters:

applyLower - - true if lower priority password policies should be applied

getRegularExpressionMatch

java.lang.String getRegularExpressionMatch()

Get regular expression that passwords must match.

Returns:

String The regular expression to match

setRegularExpressionMatch

void setRegularExpressionMatch(java.lang.String regex)

Set the regular expression that passwords must match.

Parameters:

regex - The regular expression to match

getRegularExpressionNoMatch

java.lang.String getRegularExpressionNoMatch()

Get regular expression that passwords must not match.

Returns:

String The regular expression to not match

setRegularExpressionNoMatch

void setRegularExpressionNoMatch(java.lang.String regex)

Set the regular expression that passwords must not match.

Parameters:

regex - The regular expression to not match

createRegularExpression

PasswordPolicyRegEx createRegularExpression(java.lang.String friendlyName,
                                            java.lang.String regularExpression,
                                            boolean noMatch)
                                            throws SmApiException

Creates a new regular expression for this password policy -- typically used by Identity Manager only.

Parameters:

friendlyName - the friendly name for the regular expression.

regularExpression - the regular expression.

noMatch - true if the regular expression should not be matched, or false if the regular expression should be matched.

Returns:

The new regular expression associated with this password policy

Throws:

SmApiException

getRegularExpressions

java.util.Vector getRegularExpressions()
                                       throws SmApiException

Retrieves the set of RegularExpression objects associated with this PasswordPolicy -- typically used by Identity Manager only.

Returns:

A Vector of RegularExpression objects.

Throws:

SmApiException

clearRegularExpressions

void clearRegularExpressions()
                             throws SmApiException

Clears the set of RegularExpression objects associated with this PasswordPolicy -- typically used by Identity Manager only.

Throws:

SmApiException

isSiteMinderPasswordPolicy

boolean isSiteMinderPasswordPolicy()

Check if this is a SiteMinder Password Policy

Returns:

true, if SiteMinder Password Policy. false, if Framework Password Policy