com.ibm.passwordrules.standard
Class CaseRestricted

java.lang.Object
  |
  +--com.ibm.passwordrules.LexicalRule
        |
        +--com.ibm.passwordrules.standard.CaseRestricted
All Implemented Interfaces:
java.lang.Cloneable, Rule, java.io.Serializable

public class CaseRestricted
extends LexicalRule

This class implements built-in rule for restricting the case of a password.

See Also:
Serialized Form

Field Summary
static java.lang.String INCOMPATIBLE_CASE_RESTRICTIONS
           
static java.lang.String LOWER_CASE_VIOLATION
           
static java.lang.String UPPER_CASE_VIOLATION
           
 
Fields inherited from class com.ibm.passwordrules.LexicalRule
DEFAULT_MAX_SEQUENTIAL_CHARACTERS, LOWER_CASE_ONLY, UPPER_CASE_ONLY
 
Constructor Summary
CaseRestricted(int restriction)
           
 
Method Summary
 void constrain(PasswordGenerator generator)
          Constrain the generation template to values we know are valid.
 int getRestriction()
          returns restriction type
 boolean join(Rule rule)
          Try to join the specified rule with this one.
 boolean validate(java.lang.String password, ValidationInfo validationInfo)
          Validate the given password using the given validation info.
 
Methods inherited from class com.ibm.passwordrules.LexicalRule
getParameter, setParameter, validateSafe
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

UPPER_CASE_VIOLATION

public static java.lang.String UPPER_CASE_VIOLATION

LOWER_CASE_VIOLATION

public static java.lang.String LOWER_CASE_VIOLATION

INCOMPATIBLE_CASE_RESTRICTIONS

public static java.lang.String INCOMPATIBLE_CASE_RESTRICTIONS
Constructor Detail

CaseRestricted

public CaseRestricted(int restriction)
Method Detail

getRestriction

public int getRestriction()
returns restriction type

constrain

public void constrain(PasswordGenerator generator)
Constrain the generation template to values we know are valid.
Overrides:
constrain in class LexicalRule
Parameters:
generator - including a character template to be constrained.

validate

public boolean validate(java.lang.String password,
                        ValidationInfo validationInfo)
                 throws InvalidPasswordException
Validate the given password using the given validation info.
Parameters:
validationInfo - contains contextual information about the password being validated.
password - Password to validate.
Returns:
true if password is valid
Throws:
InvalidPasswordException - thrown when password is invalid.

join

public boolean join(Rule rule)
             throws IncompatibleRulesException
Try to join the specified rule with this one. The more restrictive rule takes precedence.
Parameters:
rule - The rule to be joined with this one.
Returns:
True if the rule was successfully joined.
Throws:
IncompatibleRulesException - Thrown when given rule cannot be joined because it is not compatible.