com.ibm.passwordrules.standard
Class MustContain

java.lang.Object
  |
  +--com.ibm.passwordrules.LexicalRule
        |
        +--com.ibm.passwordrules.standard.MustContain

All Implemented Interfaces:

java.lang.Cloneable, Rule, java.io.Serializable

public class MustContain

extends LexicalRule

This class implements built-in rule for inclusion of required characters in a password

See Also:

Serialized Form

Field Summary

static java.lang.String	INCOMPATIBLE_CHARACTER_RESTRICTIONS Constant representing a message key in a property file
static java.lang.String	NO_REQUIRED_CHARACTERS_FOUND Constant representing a message key in a property file

Fields inherited from class com.ibm.passwordrules.LexicalRule

DEFAULT_MAX_SEQUENTIAL_CHARACTERS, LOWER_CASE_ONLY, UPPER_CASE_ONLY

Constructor Summary

MustContain(char[] charList)
Constructor

MustContain(java.lang.String charList)
Constructor

Method Summary

void	constrain(PasswordGenerator generator) Constrain the password generator to the allowed values.
char[]	getCharList() Return a list of required characters.
boolean	join(Rule rule) Method tries to join the specified rule with one defined by this object.
void	setCharList(char[] charList) Set a list of required characters.
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

NO_REQUIRED_CHARACTERS_FOUND

public static final java.lang.String NO_REQUIRED_CHARACTERS_FOUND

Constant representing a message key in a property file

See Also:

Constant Field Values

INCOMPATIBLE_CHARACTER_RESTRICTIONS

public static final java.lang.String INCOMPATIBLE_CHARACTER_RESTRICTIONS

Constant representing a message key in a property file

See Also:

Constant Field Values

Constructor Detail

MustContain

public MustContain(char[] charList)

Constructor

Parameters:

charList - integer array representing the list of required characters.

MustContain

public MustContain(java.lang.String charList)

Constructor

Parameters:

charList - String containing the list of required characters.

Method Detail

getCharList

public char[] getCharList()

Return a list of required characters.

Returns:

integer array representing the list of required characters.

setCharList

public void setCharList(char[] charList)

Set a list of required characters.

Parameters:

charList - integer array representing the list of required characters.

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:

always return true

Throws:

InvalidPasswordException - thrown when password is invalid.

constrain

public void constrain(PasswordGenerator generator)

Constrain the password generator to the allowed values.

Specified by:

constrain in interface Rule

Overrides:

constrain in class LexicalRule

Parameters:

generator - including a character template to constrain.

join

public boolean join(Rule rule)
             throws IncompatibleRulesException

Method tries to join the specified rule with one defined by this object. The more restrictive rule takes precedence.

Parameters:

rule - The rule to join

Returns:

True if the rule was successfuly joined, false otherwise.

Throws:

IncompatibleRulesException - thrown when two or more incompatible password rules are used.