oracle.oud

Interface PasswordStorageScheme<T extends Password>

Type Parameters:

T - the type of password supported by this managed password storage scheme.

All Known Subinterfaces:

ManagedPasswordStorageScheme<T>

All Known Implementing Classes:

AbstractPasswordStorageScheme

public interface PasswordStorageScheme<T extends Password>

This interface defines a password storage scheme.

Method Summary

Modifier and Type	Method and Description
T	encodePassword(ByteSequence plaintextPassword) Returns the specified plaintext password encoded by this password storage scheme.
java.lang.String	getName() Retrieves the name of this password storage scheme.
ByteString	getPlaintextValue(T storedPassword) Returns the plaintext value obtained from the provided stored password if this password storage scheme is reversible.
boolean	isReversible() Returns true is the original plaintext value can be obtained from the stored password; false otherwise.
boolean	passwordMatches(ByteSequence plaintextPassword, T storedPassword) Returns true if the provided plain text password matches the specified stored password; false otherwise.

Method Detail

isReversible

boolean isReversible()

Returns true is the original plaintext value can be obtained from the stored password; false otherwise.

Returns:

true is the original plaintext value can be obtained from the stored password; false otherwise.

getName

java.lang.String getName()

Retrieves the name of this password storage scheme.

Note that the name may require to be compliant with the password syntax associated to this password storage scheme.

Returns:

the name of this password storage scheme.

encodePassword

T encodePassword(ByteSequence plaintextPassword)
          throws PasswordStorageSchemeException

Returns the specified plaintext password encoded by this password storage scheme.

The server will then store the returned password in the appropriate form according to the associated password's syntax.

Parameters:

plaintextPassword - the plaintext password to encode.

Returns:

the password encoded by this password storage scheme.

Throws:

PasswordStorageSchemeException - if the plaintext password could not be encoded successfully.

passwordMatches

boolean passwordMatches(ByteSequence plaintextPassword,
                        T storedPassword)

Returns true if the provided plain text password matches the specified stored password; false otherwise.

Parameters:

plaintextPassword - the plaintext password to compare.

storedPassword - the stored password to compare against the provided plaintext password.

Returns:

true if the provided plain text password matches the specified stored password; false otherwise.

getPlaintextValue

ByteString getPlaintextValue(T storedPassword)
                      throws PasswordStorageSchemeException

Returns the plaintext value obtained from the provided stored password if this password storage scheme is reversible.

Parameters:

storedPassword - the stored password to decode.

Returns:

the plaintext value obtained from the provided stored password.

Throws:

PasswordStorageSchemeException - if the plaintext value could not be obtained from the provided stored password.