com.ibm.passwordrules.standard
Class RestrictedTo

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

All Implemented Interfaces:

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

public class RestrictedTo

extends LexicalRule

This class implements built-in rule for restricting passwords to only contain a given set of characters.

See Also:

Serialized Form

Field Summary

static java.lang.String	INCOMPATIBLE_RESTRICTED_TO_RESTRICTIONS Constant representing a message key in a property file
static java.lang.String	INCOMPATIBLE_STARTS_WITH_RESTRICTIONS
static java.lang.String	INVALID_CHARACTERS_FOUND Constant representing a message key in a property file
static java.lang.String	MayNotContain_INCOMPATIBLE_CHARACTER_RESTRICTIONS
static java.lang.String	MustContain_INCOMPATIBLE_CHARACTER_RESTRICTIONS

Fields inherited from class com.ibm.passwordrules.LexicalRule

DEFAULT_MAX_SEQUENTIAL_CHARACTERS, LOWER_CASE_ONLY, UPPER_CASE_ONLY

Constructor Summary

RestrictedTo(char[] chars)
Constructor accepting character array parameter containing the list of allowed characters.

RestrictedTo(java.lang.String chars)
Constructor accepting String parameter containing the list of allowed characters.

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) Try to join the specified rule with this one.
void	setCharList(char[] chars) 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

INCOMPATIBLE_RESTRICTED_TO_RESTRICTIONS

public static final java.lang.String INCOMPATIBLE_RESTRICTED_TO_RESTRICTIONS

Constant representing a message key in a property file

See Also:

Constant Field Values

MustContain_INCOMPATIBLE_CHARACTER_RESTRICTIONS

public static final java.lang.String MustContain_INCOMPATIBLE_CHARACTER_RESTRICTIONS

See Also:

Constant Field Values

MayNotContain_INCOMPATIBLE_CHARACTER_RESTRICTIONS

public static final java.lang.String MayNotContain_INCOMPATIBLE_CHARACTER_RESTRICTIONS

See Also:

Constant Field Values

INCOMPATIBLE_STARTS_WITH_RESTRICTIONS

public static final java.lang.String INCOMPATIBLE_STARTS_WITH_RESTRICTIONS

See Also:

Constant Field Values

INVALID_CHARACTERS_FOUND

public static final java.lang.String INVALID_CHARACTERS_FOUND

Constant representing a message key in a property file

See Also:

Constant Field Values

Constructor Detail

RestrictedTo

public RestrictedTo(char[] chars)

Constructor accepting character array parameter containing the list of allowed characters.

Parameters:

chars - character array representing the list of allowed characters.

RestrictedTo

public RestrictedTo(java.lang.String chars)

Constructor accepting String parameter containing the list of allowed characters.

Parameters:

chars - String containing the list of allowed characters.

Method Detail

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 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:

always return true

Throws:

InvalidPasswordException - thrown when password is invalid.

getCharList

public char[] getCharList()

Return a list of required characters.

Returns:

character array representing the list of allowed characters.

setCharList

public void setCharList(char[] chars)

Set a list of required characters.

Parameters:

chars - character array representing the list of allowed characters.

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.