com.ibm.passwordrules
Class LexicalRule

java.lang.Object
  |
  +--com.ibm.passwordrules.LexicalRule
All Implemented Interfaces:
java.lang.Cloneable, Rule, java.io.Serializable
Direct Known Subclasses:
CaseRestricted, LengthConstraint, MaxLengthConstraint, MaxSequentialCharacters, MayNotContain, MinAlphabeticCharacters, MinDigitCharacters, MinDistinctCharacters, MinLengthConstraint, MustContain, RestrictedTo, StartsWithChar

public abstract class LexicalRule
extends java.lang.Object
implements Rule, java.lang.Cloneable, java.io.Serializable

Abstract class to be extended by rule classes constraining lexical characteristics of a password.

See Also:
Serialized Form

Field Summary
static int DEFAULT_MAX_SEQUENTIAL_CHARACTERS
          Constant for default maximum sequential characters
static int LOWER_CASE_ONLY
          Constant for specifying that only lower case characters are to be used in password
static int UPPER_CASE_ONLY
          Constant for specifying that only upper case characters are to be used in password
 
Constructor Summary
LexicalRule()
          Default constructor
 
Method Summary
 void constrain(PasswordGenerator generator)
          Some Rule implementing classes will not have a constraint to impose, in which case method in this class will be called and will do nothing.
 java.lang.String getParameter()
          This Rule interface method in is not valid in the context of standard rule classes.
 void setParameter(java.lang.String parameter)
          This Rule interface method in is not valid in the context of standard rule classes.
 boolean validateSafe(java.lang.String password, ValidationInfo validationInfo)
          Validate the given password using the given validation info.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.passwordrules.Rule
join, validate
 

Field Detail

DEFAULT_MAX_SEQUENTIAL_CHARACTERS

public static final int DEFAULT_MAX_SEQUENTIAL_CHARACTERS
Constant for default maximum sequential characters

UPPER_CASE_ONLY

public static final int UPPER_CASE_ONLY
Constant for specifying that only upper case characters are to be used in password

LOWER_CASE_ONLY

public static final int LOWER_CASE_ONLY
Constant for specifying that only lower case characters are to be used in password
Constructor Detail

LexicalRule

public LexicalRule()
Default constructor
Method Detail

constrain

public void constrain(PasswordGenerator generator)
Some Rule implementing classes will not have a constraint to impose, in which case method in this class will be called and will do nothing.
Specified by:
constrain in interface Rule
Parameters:
generator - including a character template to be constrained.

validateSafe

public boolean validateSafe(java.lang.String password,
                            ValidationInfo validationInfo)
Validate the given password using the given validation info. This version will never throw an exception, but will return false if the password is invalid. It is not possible to get any more information about why the password failed when using this version.
Specified by:
validateSafe in interface Rule
Parameters:
validationInfo - contains contextual information about the password being validated.
password - Password to validate.
Returns:
true if password is valid - false it isn't

getParameter

public java.lang.String getParameter()
This Rule interface method in is not valid in the context of standard rule classes. Each standard rule class has its own method for getting constraining parameter value.
Specified by:
getParameter in interface Rule
Following copied from interface: com.ibm.passwordrules.Rule
Returns:
parameter String representing the constraining parameter

setParameter

public void setParameter(java.lang.String parameter)
This Rule interface method in is not valid in the context of standard rule classes. Each standard rule class has its own method for setting constraining parameter value.
Specified by:
setParameter in interface Rule
Following copied from interface: com.ibm.passwordrules.Rule
Parameters:
parameter - String representing the constraining parameter