com.adaptris.security.password

Interface PasswordCodec

All Known Implementing Classes:

AesCrypto, MicrosoftCrypto, PbeCrypto

public interface PasswordCodec

Primary interface for handling password encoding and decoding.

Method Summary

Modifier and Type	Method and Description
boolean	canHandle(java.lang.String type) Can this implementation handle an encoded password of this type.
java.lang.String	decode(java.lang.String encryptedPassword) Invokes decode(String, String) with null as the charset parameter
java.lang.String	decode(java.lang.String encryptedPassword, java.lang.String charset) Show the plain text.
java.lang.String	encode(java.lang.String plainText) Invokes encode(String, String) with null as the charset parameter
java.lang.String	encode(java.lang.String plainText, java.lang.String charset) Obfuscate the plain text.

Method Detail

encode

java.lang.String encode(java.lang.String plainText)
                 throws PasswordException

Invokes encode(String, String) with null as the charset parameter

Throws:

PasswordException

encode

java.lang.String encode(java.lang.String plainText,
                        java.lang.String charset)
                 throws PasswordException

Obfuscate the plain text.

Parameters:

plainText - the text to obfuscate

charset - the character set that should be used to create the resulting plain text password, if null uses UTF-8

Returns:

the obfuscated text.

Throws:

PasswordException

decode

java.lang.String decode(java.lang.String encryptedPassword,
                        java.lang.String charset)
                 throws PasswordException

Show the plain text.

Parameters:

encryptedPassword - the encrypted password

charset - the character set that should be used to create the resulting plain text password, if null uses UTF-8

Returns:

the plain text password

Throws:

PasswordException

decode

java.lang.String decode(java.lang.String encryptedPassword)
                 throws PasswordException

Invokes decode(String, String) with null as the charset parameter

Throws:

PasswordException

See Also:

decode(String, String)

canHandle

boolean canHandle(java.lang.String type)

Can this implementation handle an encoded password of this type.

Parameters:

type - the type

Returns:

true or false.