PasswordRulesInfo

java.lang.Object
- com.ibm.passwordrules.standard.PasswordRulesInfo

All Implemented Interfaces:

java.io.Serializable
```
public class PasswordRulesInfo
extends java.lang.Object
implements java.io.Serializable
```
This class represents a value object containing information about password rules.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

PasswordRulesInfo()
Default constructor

Constructors
Constructor and Description
`PasswordRulesInfo()` Default constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCustomRule(java.lang.String name, java.lang.String value)` Add custom rule definition
`boolean`	`getAllowInDictionary()` Make sure, that the genenerated password is or is not allowed in the password dictionary.
`boolean`	`getAllowUserID()` Make sure in a case sensitive way, that the user id is or is not to be allowed within the password.
`boolean`	`getAllowUserIDCaseInsensitive()` Check in a case insensitive way, if user id is to be allowed within the password.
`boolean`	`getAllowUserName()` Check in a case sensitive way, if user name is to be allowed within the password.
`boolean`	`getAllowUserNameCaseInsensitive()` Check in a case insensitive way, if user name is to be allowed within the password.
`java.util.Map`	`getCustomRules()` Obtain definitions of all custom rules known to this object.
`java.lang.String`	`getInvalidChars()` Return the characteres which are not to be used within the passsword.
`int`	`getMaxLength()` Return the maximum length of the passsword.
`int`	`getMaxSequentialCharacters()` Return the maximum allowed number of sequential characteres within the passsword.
`long`	`getMaxValidityPeriod()` Return maximum number of time units the password will be valid for.
`int`	`getMinAlphabeticCharacters()` Return the minimum required number of alphabetic characteres within the passsword.
`int`	`getMinDigitCharacters()` Return the minimum required number of numeric characteres within the passsword.
`int`	`getMinDistinctCharacters()` Return the minimum required number of distinct characteres within the passsword.
`int`	`getMinLength()` Return the minimum length of the passsword.
`long`	`getMinValidityPeriod()` Return minimum number of time units the password will be valid for.
`boolean`	`getPasswordComplexity()` Returns whether the password complexity rule is set
`int`	`getRepeatedHistoryLength()` Return the length of the password history used to check for repeating passwords.
`java.lang.String`	`getRequiredChars()` Return the characteres one of which which must used within the passsword.
`java.lang.String`	`getRestrictedToChars()` Return the characteres from which the passsword must be created.
`int`	`getReversedHistoryLength()` Return the length of the password history used to check for repeating passwords spelled backwards
`java.lang.String`	`getStartsWithChars()` Return the characteres one of which must be the first character set of the password.
`static boolean`	`isRuleTypeTextBox(java.lang.String rule)` Check if the given rule is represented as a textbox on the GUI.
`void`	`setAllowInDictionary(boolean allowInDictionary)` Check if the genenerated password is or is not allowed in the password dictionary.
`void`	`setAllowUserID(boolean allowUserID)` Make sure in a case sensitive way, that the user id is or is not to be allowed within the password.
`void`	`setAllowUserIDCaseInsensitive(boolean allowUserIDCaseInsensitive)` Make sure in a case insensitive way, that the user id is or is not to be allowed within the password.
`void`	`setAllowUserName(boolean allowUserName)` Make sure in a case sensitive way, that the user name is or is not to be allowed within the password.
`void`	`setAllowUserNameCaseInsensitive(boolean allowUserNameCaseInsensitive)` Make sure in a case insensitive way, that the user name is or is not to be allowed within the password.
`void`	`setCustomRules(java.util.Map customRules)` Set all custom rules onto this object.
`void`	`setInvalidChars(java.lang.String invalidChars)` Set the characteres which are not to be used within the passsword.
`void`	`setMaxLength(int maxLength)` Set the maximum length of the passsword.
`void`	`setMaxSequentialCharacters(int maxSequentialCharacters)` Set the maximum allowed number of sequential characteres within the passsword.
`void`	`setMaxValidityPeriod(long maxValidityPeriod)` Set maximum number of time units the password will be valid for.
`void`	`setMinAlphabeticCharacters(int minAlphabeticChars)` Set the minimum required number of alphabetic characteres within the passsword.
`void`	`setMinDigitCharacters(int minDigitChars)` Set the minimum required number of numeric characteres within the passsword.
`void`	`setMinDistinctCharacters(int minDistinctChars)` Set the minimum required number of distinct characteres within the passsword.
`void`	`setMinLength(int minLength)` Set the minimum length of the passsword.
`void`	`setMinValidityPeriod(long minValidityPeriod)` Set minimum number of time units the password will be valid for.
`void`	`setPasswordComplexity(boolean setComplexity)` Sets the password complexity rule
`void`	`setRepeatedHistoryLength(int repeatedHistoryLength)` Return the length of the password history used to check for repeating passwords.
`void`	`setRequiredChars(java.lang.String requiredChars)` Set the characteres one of which which must used within the passsword.
`void`	`setRestrictedToChars(java.lang.String restrictedToChars)` Set the characteres from which the passsword must be created.
`void`	`setReversedHistoryLength(int reversedHistoryLength)` Set the length of the password history used to check for repeating passwords spelled backwards
`void`	`setStartsWithChars(java.lang.String startsWithChars)` Set the characteres one of which must be the first character set of the password.
`java.lang.String`	`toString()` Return string representation of all password rules set on this object.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PasswordRulesInfo
```
public PasswordRulesInfo()
```
    Default constructor
- Method Detail
  - getMinLength
```
public int getMinLength()
```
    Return the minimum length of the passsword.
    
    Returns:
    
    int value representing the minimum length of the passsword
  - setMinLength
```
public void setMinLength(int minLength)
```
    Set the minimum length of the passsword.
    
    Parameters:
    
    minLength - int value representing the minimum length of the passsword
  - getMaxLength
```
public int getMaxLength()
```
    Return the maximum length of the passsword.
    
    Returns:
    
    int value representing the maximum length of the passsword
  - setMaxLength
```
public void setMaxLength(int maxLength)
```
    Set the maximum length of the passsword.
    
    Parameters:
    
    maxLength - int value representing the maximum length of the passsword
  - getMaxSequentialCharacters
```
public int getMaxSequentialCharacters()
```
    Return the maximum allowed number of sequential characteres within the passsword.
    
    Returns:
    
    int value representing the maximum allowed number of sequential characteres within the passsword
  - setMaxSequentialCharacters
```
public void setMaxSequentialCharacters(int maxSequentialCharacters)
```
    Set the maximum allowed number of sequential characteres within the passsword.
    
    Parameters:
    
    maxSequentialCharacters - int value representing the maximum allowed number of sequential characteres within the passsword
  - getMinDistinctCharacters
```
public int getMinDistinctCharacters()
```
    Return the minimum required number of distinct characteres within the passsword.
    
    Returns:
    
    int value representing the minimum required number of distinct characteres within the passsword
  - setMinDistinctCharacters
```
public void setMinDistinctCharacters(int minDistinctChars)
```
    Set the minimum required number of distinct characteres within the passsword.
    
    Parameters:
    
    minDistinctChars - int value representing the minimum required number of distinct characteres within the passsword
  - getMinAlphabeticCharacters
```
public int getMinAlphabeticCharacters()
```
    Return the minimum required number of alphabetic characteres within the passsword.
    
    Returns:
    
    int value representing the minimum required number of alphabetic characteres within the passsword
  - setMinAlphabeticCharacters
```
public void setMinAlphabeticCharacters(int minAlphabeticChars)
```
    Set the minimum required number of alphabetic characteres within the passsword.
    
    Parameters:
    
    minAlphabeticChars - int value representing the minimum required number of alphabetic characteres within the passsword
  - getMinDigitCharacters
```
public int getMinDigitCharacters()
```
    Return the minimum required number of numeric characteres within the passsword.
    
    Returns:
    
    int value representing the minimum required number of numeric characteres within the passsword
  - setMinDigitCharacters
```
public void setMinDigitCharacters(int minDigitChars)
```
    Set the minimum required number of numeric characteres within the passsword.
    
    Parameters:
    
    minDigitChars - int value representing the minimum required number of numeric characteres within the passsword
  - getInvalidChars
```
public java.lang.String getInvalidChars()
```
    Return the characteres which are not to be used within the passsword.
    
    Returns:
    
    String value representing the characteres which are not to be used within the passsword.
  - setInvalidChars
```
public void setInvalidChars(java.lang.String invalidChars)
```
    Set the characteres which are not to be used within the passsword.
    
    Parameters:
    
    invalidChars - String value representing the characteres which are not to be used within the passsword.
  - getRequiredChars
```
public java.lang.String getRequiredChars()
```
    Return the characteres one of which which must used within the passsword.
    
    Returns:
    
    String value representing the characteres one, of which which must used within the passsword.
  - setRequiredChars
```
public void setRequiredChars(java.lang.String requiredChars)
```
    Set the characteres one of which which must used within the passsword.
    
    Parameters:
    
    requiredChars - String value representing the characteres one of which which must used within the passsword.
  - getRestrictedToChars
```
public java.lang.String getRestrictedToChars()
```
    Return the characteres from which the passsword must be created.
    
    Returns:
    
    String value representing the set of characteres from which the passsword must be created.
  - setRestrictedToChars
```
public void setRestrictedToChars(java.lang.String restrictedToChars)
```
    Set the characteres from which the passsword must be created.
    
    Parameters:
    
    restrictedToChars - String value representing the set of characteres from which the passsword must be created.
  - getStartsWithChars
```
public java.lang.String getStartsWithChars()
```
    Return the characteres one of which must be the first character set of the password.
    
    Returns:
    
    String value representing the characteres one of which must be the first character set of the password.
  - setStartsWithChars
```
public void setStartsWithChars(java.lang.String startsWithChars)
```
    Set the characteres one of which must be the first character set of the password.
    
    Parameters:
    
    startsWithChars - String value representing the characteres one of which must be the first character set of the password.
  - getRepeatedHistoryLength
```
public int getRepeatedHistoryLength()
```
    Return the length of the password history used to check for repeating passwords.
    
    Returns:
    
    int value representing length of password history
  - setRepeatedHistoryLength
```
public void setRepeatedHistoryLength(int repeatedHistoryLength)
```
    Return the length of the password history used to check for repeating passwords.
    
    Parameters:
    
    repeatedHistoryLength - int value representing length of password history
  - getReversedHistoryLength
```
public int getReversedHistoryLength()
```
    Return the length of the password history used to check for repeating passwords spelled backwards
    
    Returns:
    
    int value representing length of password history
  - setReversedHistoryLength
```
public void setReversedHistoryLength(int reversedHistoryLength)
```
    Set the length of the password history used to check for repeating passwords spelled backwards
    
    Parameters:
    
    reversedHistoryLength - int value representing length of password history
  - getAllowUserName
```
public boolean getAllowUserName()
```
    Check in a case sensitive way, if user name is to be allowed within the password.
    
    Returns:
    
    boolean value true if user name is to be allowed within the password, false otherwise
  - setAllowUserName
```
public void setAllowUserName(boolean allowUserName)
```
    Make sure in a case sensitive way, that the user name is or is not to be allowed within the password.
    
    Parameters:
    
    allowUserName - boolean value true if user name is to be allowed within the password, false otherwise
  - getAllowUserNameCaseInsensitive
```
public boolean getAllowUserNameCaseInsensitive()
```
    Check in a case insensitive way, if user name is to be allowed within the password.
    
    Returns:
    
    boolean value true if user name is to be allowed within the password, false otherwise
  - setAllowUserNameCaseInsensitive
```
public void setAllowUserNameCaseInsensitive(boolean allowUserNameCaseInsensitive)
```
    Make sure in a case insensitive way, that the user name is or is not to be allowed within the password.
    
    Parameters:
    
    allowUserNameCaseInsensitive - boolean value true if user name is to be allowed within the password, false otherwise
  - getAllowUserID
```
public boolean getAllowUserID()
```
    Make sure in a case sensitive way, that the user id is or is not to be allowed within the password.
    
    Returns:
    
    boolean value true if user id is to be allowed within the password, false otherwise
  - setAllowUserID
```
public void setAllowUserID(boolean allowUserID)
```
    Make sure in a case sensitive way, that the user id is or is not to be allowed within the password.
    
    Parameters:
    
    allowUserID - boolean value true if user id is to be allowed within the password, false otherwise
  - getAllowUserIDCaseInsensitive
```
public boolean getAllowUserIDCaseInsensitive()
```
    Check in a case insensitive way, if user id is to be allowed within the password.
    
    Returns:
    
    boolean value true if user id is to be allowed within the password, false otherwise
  - setAllowUserIDCaseInsensitive
```
public void setAllowUserIDCaseInsensitive(boolean allowUserIDCaseInsensitive)
```
    Make sure in a case insensitive way, that the user id is or is not to be allowed within the password.
    
    Parameters:
    
    allowUserIDCaseInsensitive - boolean value true if user id is to be allowed within the password, false otherwise
  - getMinValidityPeriod
```
public long getMinValidityPeriod()
```
    Return minimum number of time units the password will be valid for. Curerntly, This rule is not used.
    
    Returns:
    
    long value representing minimum number of time units the password will be valid for
  - setMinValidityPeriod
```
public void setMinValidityPeriod(long minValidityPeriod)
```
    Set minimum number of time units the password will be valid for. Curerntly, This rule is not used.
    
    Parameters:
    
    minValidityPeriod - long value representing minimum number of time units the password will be valid for
  - getMaxValidityPeriod
```
public long getMaxValidityPeriod()
```
    Return maximum number of time units the password will be valid for. Curerntly, This rule is not used.
    
    Returns:
    
    long value representing maximum number of time units the password will be valid for
  - setMaxValidityPeriod
```
public void setMaxValidityPeriod(long maxValidityPeriod)
```
    Set maximum number of time units the password will be valid for. Curerntly, This rule is not used.
    
    Parameters:
    
    maxValidityPeriod - long value representing maximum number of time units the password will be valid for
  - getAllowInDictionary
```
public boolean getAllowInDictionary()
```
    Make sure, that the genenerated password is or is not allowed in the password dictionary.
    
    Returns:
    
    boolean value true the genenerated password is or is not allowed in the password dictionary, false otherwise
  - setAllowInDictionary
```
public void setAllowInDictionary(boolean allowInDictionary)
```
    Check if the genenerated password is or is not allowed in the password dictionary.
    
    Parameters:
    
    allowInDictionary - boolean value true if the genenerated password is allowed in the password dictionary, false otherwise
  - getPasswordComplexity
```
public boolean getPasswordComplexity()
```
    Returns whether the password complexity rule is set
  - setPasswordComplexity
```
public void setPasswordComplexity(boolean setComplexity)
```
    Sets the password complexity rule
    
    Parameters:
    
    setComplexity -
  - toString
```
public java.lang.String toString()
```
    Return string representation of all password rules set on this object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    String value representing this object
  - addCustomRule
```
public void addCustomRule(java.lang.String name,
                          java.lang.String value)
```
    Add custom rule definition
    
    Parameters:
    
    name - fully qualified class name of a class implementing Rule interface.
    
    value - optional value of a parameter used by the custom rule class.
    
    See Also:
    
    Rule
  - getCustomRules
```
public java.util.Map getCustomRules()
```
    Obtain definitions of all custom rules known to this object.
    
    Returns:
    
    Map object where key is fully qualified class name of a class implementing Rule interface and value is optional and may contain a value of a parameter used by the custom rule class.
    
    See Also:
    
    Rule
  - setCustomRules
```
public void setCustomRules(java.util.Map customRules)
```
    Set all custom rules onto this object.
    
    Parameters:
    
    customRules - Map object where key is fully qualified class name of a class implementing Rule interface and value is optional and may contain a value of a parameter used by the custom rule class.
    
    See Also:
    
    Rule
  - isRuleTypeTextBox
```
public static boolean isRuleTypeTextBox(java.lang.String rule)
```
    Check if the given rule is represented as a textbox on the GUI.
    
    Parameters:
    
    rule - Custom rule name
    
    Returns:
    
    boolean true if custom rule is represented by a textbox and false if by checkbox.

Methods inherited from class java.lang.Object

PasswordRulesInfo

getMinLength

setMinLength

getMaxLength

setMaxLength

getMaxSequentialCharacters

setMaxSequentialCharacters

getMinDistinctCharacters

setMinDistinctCharacters

getMinAlphabeticCharacters

setMinAlphabeticCharacters

getMinDigitCharacters

setMinDigitCharacters

getInvalidChars

setInvalidChars

getRequiredChars

setRequiredChars

getRestrictedToChars

setRestrictedToChars

getStartsWithChars

setStartsWithChars

getRepeatedHistoryLength

setRepeatedHistoryLength

getReversedHistoryLength

setReversedHistoryLength

getAllowUserName

setAllowUserName

getAllowUserNameCaseInsensitive

setAllowUserNameCaseInsensitive

getAllowUserID

setAllowUserID

getAllowUserIDCaseInsensitive

setAllowUserIDCaseInsensitive

getMinValidityPeriod

setMinValidityPeriod

getMaxValidityPeriod

setMaxValidityPeriod

getAllowInDictionary

setAllowInDictionary

getPasswordComplexity

setPasswordComplexity

toString

addCustomRule

getCustomRules

setCustomRules

isRuleTypeTextBox