com.ibm.passwordrules.standard
Class StartsWithChar

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

All Implemented Interfaces:

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

public class StartsWithChar

extends LexicalRule

This class implements built-in rule for restricting passwords to start with a given sequence of characters.

See Also:

Serialized Form

Field Summary

static java.lang.String	INCOMPATIBLE_STARTS_WITH_RESTRICTIONS Constant representing a message key in a property file
static java.lang.String	REQUIRED_CHARACTERS_NOT_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

StartsWithChar(char[] charList)
Constructor accepting character array parameter containing a list of characters the password must start with.

StartsWithChar(java.lang.String charList)
Constructor accepting String parameter containing a list of characters the password must start with.

Method Summary

void	constrain(PasswordGenerator generator) Constrain the password generator to allowed values.
char[]	getCharList() Return characters, that the password must start with.
boolean	join(Rule rule) Try to join the specified rule with this one.
void	setCharList(char[] charList) Set characters, that the password must start with.
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_STARTS_WITH_RESTRICTIONS

public static final java.lang.String INCOMPATIBLE_STARTS_WITH_RESTRICTIONS

Constant representing a message key in a property file

See Also:

Constant Field Values

REQUIRED_CHARACTERS_NOT_FOUND

public static final java.lang.String REQUIRED_CHARACTERS_NOT_FOUND

Constant representing a message key in a property file

See Also:

Constant Field Values

Constructor Detail

StartsWithChar

public StartsWithChar(char[] charList)

Constructor accepting character array parameter containing a list of characters the password must start with.

Parameters:

charList - char aray containing a list of characters the password must start with.

StartsWithChar

public StartsWithChar(java.lang.String charList)

Constructor accepting String parameter containing a list of characters the password must start with.

Parameters:

charList - String containing a list of characters the password must start with.

Method Detail

constrain

public void constrain(PasswordGenerator generator)

Constrain the password generator to 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 characters, that the password must start with.

Returns:

char array containing a list of characters.

setCharList

public void setCharList(char[] charList)

Set characters, that the password must start with.

Parameters:

charList - char array containing a list of 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.