com.adaptris.core.security

Class ConfiguredPrivateKeyPasswordProvider

java.lang.Object

com.adaptris.core.security.ConfiguredPrivateKeyPasswordProvider

All Implemented Interfaces:

PrivateKeyPasswordProvider

public class ConfiguredPrivateKeyPasswordProvider
extends java.lang.Object
implements PrivateKeyPasswordProvider

Private key password provider which explicitly configures the password in configuration

Although there is nothing to stop you from having a plain text private key password configured in adapter configuration using this provider; it is strongly discouraged. You should consider using the Password.encode(String, String) method to generate an encoded password for inserting into configuration.

See Also:

Password.decode(String)

In the adapter configuration file this class is aliased as configured-private-key-password-provider which is the preferred alternative to the fully qualified classname when building your configuration.

Constructor Summary

Constructors

Constructor and Description
ConfiguredPrivateKeyPasswordProvider()
ConfiguredPrivateKeyPasswordProvider(java.lang.String encPassword)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEncodedPassword()
char[]	retrievePrivateKeyPassword() Return the private key password as a char[] array.
void	setEncodedPassword(java.lang.String encodedPassword)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfiguredPrivateKeyPasswordProvider

public ConfiguredPrivateKeyPasswordProvider()

ConfiguredPrivateKeyPasswordProvider

public ConfiguredPrivateKeyPasswordProvider(java.lang.String encPassword)

Method Detail

retrievePrivateKeyPassword

public char[] retrievePrivateKeyPassword()
                                  throws PasswordException

Return the private key password as a char[] array.

Specified by:

retrievePrivateKeyPassword in interface PrivateKeyPasswordProvider

Returns:

the configured private key, decoded using Password.decode(String)

Throws:

PasswordException - wrapping any other exception.

getEncodedPassword

public java.lang.String getEncodedPassword()

setEncodedPassword

public void setEncodedPassword(java.lang.String encodedPassword)