org.pageseeder.smith.rule

Class SpecialCharCountRule

java.lang.Object

org.pageseeder.smith.rule.SpecialCharCountRule

All Implemented Interfaces:

PasswordRule, Scriptable

public final class SpecialCharCountRule
extends java.lang.Object
implements PasswordRule, Scriptable

A rule based on the number of upper case characters in the password.

The scoring is as follows:

• 0 for null or empty string ""
• 1 point for every special character found in the password

The maximum value is the length of the password if it is entirely made up of special characters.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CHARS The default special characters

Constructor Summary

Constructors

Constructor and Description
SpecialCharCountRule() Creates a new rule using the special characters
SpecialCharCountRule(java.lang.String chars)

Method Summary

Modifier and Type	Method and Description
void	configure(java.util.Map<java.lang.String,java.lang.String> config) Configures the specified rule.
int	score(java.lang.String password) Returns the score for the password.
java.lang.Appendable	toScript(java.lang.Appendable script) Writes the script for the object on to the specified writer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_CHARS

public static final java.lang.String DEFAULT_CHARS

The default special characters

See Also:

Constant Field Values

Constructor Detail

SpecialCharCountRule

public SpecialCharCountRule()

Creates a new rule using the special characters

SpecialCharCountRule

public SpecialCharCountRule(java.lang.String chars)

Parameters:

chars - The characters to look for

Method Detail

score

public int score(java.lang.String password)

Description copied from interface: PasswordRule

Returns the score for the password.

Specified by:

score in interface PasswordRule

Parameters:

password - The password to evaluate.

Returns:

the corresponding score.

configure

public void configure(java.util.Map<java.lang.String,java.lang.String> config)

Description copied from interface: PasswordRule

Configures the specified rule.

The properties are specific to each rule.

Specified by:

configure in interface PasswordRule

Parameters:

config - The configuration.

toScript

public java.lang.Appendable toScript(java.lang.Appendable script)
                              throws java.io.IOException

Description copied from interface: Scriptable

Writes the script for the object on to the specified writer.

Specified by:

toScript in interface Scriptable

Parameters:

script - Where to write the script.

Returns:

A reference to this Appendable

Throws:

java.io.IOException - If an I/O error occurs