org.pageseeder.smith

Class PasswordMeter

java.lang.Object

org.pageseeder.smith.PasswordMeter

All Implemented Interfaces:

Scriptable

public final class PasswordMeter
extends java.lang.Object
implements Scriptable

The main class

Constructor Summary

Constructors

Constructor and Description
PasswordMeter() Creates a new password meter using the default built-in configuration.
PasswordMeter(PasswordConfig config) Creates a new password meter using the default configuration

Method Summary

Modifier and Type	Method and Description
PasswordConfig	configuration() Returns the configuration used by this password meter.
java.lang.String	getLevel(java.lang.String password) Evaluate the specified password.
boolean	isAtLeast(java.lang.String password, java.lang.String level) Indicates whether the specified password matches at least the supplied level.
static void	main(java.lang.String[] args)
int	score(java.lang.String password) Returns the score for this password.
java.lang.Appendable	toScript(java.lang.Appendable script) Writes the script for the object on to the specified writer.
int[]	vector(java.lang.String password) Returns the vector of scores for each rule in the order in which they are defined.

Methods inherited from class java.lang.Object

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

Constructor Detail

PasswordMeter

public PasswordMeter()

Creates a new password meter using the default built-in configuration.

PasswordMeter

public PasswordMeter(PasswordConfig config)

Creates a new password meter using the default configuration

Throws:

java.lang.NullPointerException - if the configuration is not specified.

Method Detail

getLevel

public java.lang.String getLevel(java.lang.String password)

Evaluate the specified password.

Returns:

the password.

vector

public int[] vector(java.lang.String password)

Returns the vector of scores for each rule in the order in which they are defined.

Parameters:

password - the password to evaluate

Returns:

the corresponding scores for each rule.

score

public int score(java.lang.String password)

Returns the score for this password.

Returns:

the score given to this password.

isAtLeast

public boolean isAtLeast(java.lang.String password,
                         java.lang.String level)

Indicates whether the specified password matches at least the supplied level.

Parameters:

password - The password to evaluate.

level - The level that must be matched.

Returns:

true if the score is sufficient to match at least this level; false otherwise.

Throws:

java.lang.IllegalArgumentException - If the level is not defined in the config.

java.lang.NullPointerException - If the level is null.

configuration

public PasswordConfig configuration()

Returns the configuration used by this password meter.

Returns:

the configuration used by this password meter.

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

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException

Parameters:

args -

Throws:

java.io.IOException