org.pageseeder.smith.rule

Class BannedPasswordRule

java.lang.Object

org.pageseeder.smith.rule.BannedPasswordRule

All Implemented Interfaces:

PasswordRule, Scriptable

public class BannedPasswordRule
extends java.lang.Object
implements PasswordRule, Scriptable

Evaluate a password by checking against a list of banned passwords. The default scoring is as follows:

• 0 for null or empty string ""
• 0 for null or empty string ""
• -100 for any banned password

The score for banned and allowed passwords can be customized.

Constructor Summary

Constructors

Constructor and Description
BannedPasswordRule()

Method Summary

Modifier and Type	Method and Description
void	configure(java.util.Map<java.lang.String,java.lang.String> config) Configures the specified rule.
static java.util.Set<java.lang.String>	load() Loads the default banned passwords.
static java.util.Set<java.lang.String>	load(java.io.Reader reader) Loads the passwords found in the specified reader.
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

Constructor Detail

BannedPasswordRule

public BannedPasswordRule()

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.

load

public static java.util.Set<java.lang.String> load()

Loads the default banned passwords.

load

public static java.util.Set<java.lang.String> load(java.io.Reader reader)
                                            throws java.io.IOException

Loads the passwords found in the specified reader.

Parameters:

reader - the reader on a list of banned passwords.

Throws:

java.io.IOException

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