net.nicholaswilliams.java.licensing.licensor.interfaces.spi

Interface PasswordPrompter

All Known Subinterfaces:

TextInterfaceDevice

All Known Implementing Classes:

AbstractPasswordPrompter, AbstractTextInterfaceDevice, ConsoleInterfaceDevice

public interface PasswordPrompter

Interface for prompting for passwords.

Since:

1.0.0

Version:

1.0.0

Author:

Nick Williams

Method Summary

Methods

Modifier and Type	Method and Description
boolean	passwordsMatch(char[] password1, char[] password2) Checks whether the two passwords match.
char[]	promptForValidPassword(int minLength, int maxLength, String what) Prompts for a valid password by asking for the password using readPassword(String, Object...), checking its length against the constraints, asking for the password to be confirmed, and checking to make sure the passwords match.
char[]	promptForValidPassword(int minLength, int maxLength, String promptMessage, String promptConfirmMessage, String lengthError, String matchError, OutputDevice device) Prompts for a valid password by asking for the password using readPassword(String, Object...), checking its length against the constraints, asking for the password to be confirmed, and checking to make sure the passwords match.
char[]	readPassword() Reads a password or passphrase from the device with echoing disabled.
char[]	readPassword(String format, Object... arguments) Provides a formatted prompt, then reads a password or passphrase from the device with echoing disabled.

Method Detail

readPassword

char[] readPassword()
                    throws IOError

Reads a password or passphrase from the device with echoing disabled.

Returns:

a character array containing the password or passphrase read from the device, not including any line-termination characters, or null if an end of stream has been reached.

Throws:

IOError - if an I/O error occurs.

readPassword

char[] readPassword(String format,
                  Object... arguments)
                    throws IllegalFormatException,
                           IOError

Provides a formatted prompt, then reads a password or passphrase from the device with echoing disabled.

Parameters:

format - A format string as described in #syntax

arguments - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero. The maximum number of arguments is limited by the maximum dimension of a Java array as defined by the Java Virtual Machine Specification. The behaviour on a null argument depends on the conversion.

Returns:

a character array containing the password or passphrase read from the device, not including any line-termination characters, or null if an end of stream has been reached.

Throws:

IllegalFormatException - if a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions. For specification of all possible formatting errors, see the Details section of the formatter class specification.

IOError - if an I/O error occurs.

passwordsMatch

boolean passwordsMatch(char[] password1,
                     char[] password2)

Checks whether the two passwords match.

Parameters:

password1 - The entered password

password2 - The confirmed password

Returns:

true if the passwords match, false otherwise.

promptForValidPassword

char[] promptForValidPassword(int minLength,
                            int maxLength,
                            String promptMessage,
                            String promptConfirmMessage,
                            String lengthError,
                            String matchError,
                            OutputDevice device)
                              throws IOError

Prompts for a valid password by asking for the password using readPassword(String, Object...), checking its length against the constraints, asking for the password to be confirmed, and checking to make sure the passwords match.

This method should continue to ask for the password over and over again until a valid password is entered and confirmed or the user cancels the operation.

Parameters:

minLength - The minimum legal length for the password

maxLength - The maximum legal length for the password

promptMessage - The message to prompt for the password initially (the message should not include format specifiers)

promptConfirmMessage - The message to prompt to confirm the password (the message should not include format specifiers)

lengthError - The message to display if the password does not meet the minimum or maximum length requirements (the message should not include format specifiers)

matchError - The message to display if the two entered passwords do not match (the message should not include format specifiers)

device - The device that should be used to output messages and errors

Returns:

the valid, confirmed password entered by the user.

Throws:

IOError - if an I/O error occurs.

promptForValidPassword

char[] promptForValidPassword(int minLength,
                            int maxLength,
                            String what)
                              throws IOError

Prompts for a valid password by asking for the password using readPassword(String, Object...), checking its length against the constraints, asking for the password to be confirmed, and checking to make sure the passwords match.

This method should continue to ask for the password over and over again until a valid password is entered and confirmed or the user cancels the operation.

Parameters:

minLength - The minimum legal length for the password

maxLength - The maximum legal length for the password

what - What we're prompting for a password for

Returns:

the valid, confirmed password entered by the user.

Throws:

IOError - if an I/O error occurs.