org.ldaptive.ssl

Class KeyStoreSSLContextInitializer

java.lang.Object

org.ldaptive.ssl.AbstractSSLContextInitializer

org.ldaptive.ssl.KeyStoreSSLContextInitializer

All Implemented Interfaces:

SSLContextInitializer

public class KeyStoreSSLContextInitializer
extends AbstractSSLContextInitializer

Provides an SSL context initializer which can use java KeyStores to create key and trust managers.

Field Summary

Fields

Modifier and Type	Field and Description
private String[]	authenticationAliases Aliases of key entries to use.
private KeyStore	authenticationKeystore KeyStore used to create key managers.
private char[]	authenticationPassword Password used to access the authentication keystore.
private String[]	trustAliases Aliases of trust entries to use.
private KeyStore	trustKeystore KeyStore used to create trust managers.

Fields inherited from class org.ldaptive.ssl.AbstractSSLContextInitializer

hostnameVerifierConfig, logger, trustManagers

Constructor Summary

Constructors

Constructor and Description
KeyStoreSSLContextInitializer()

Method Summary

Modifier and Type	Method and Description
protected TrustManager[]	createTrustManagers() Creates any trust managers specific to this context initializer.
String[]	getAuthenticationAliases() Returns the aliases of the entries to use in the authentication keystore
KeyStore	getAuthenticationKeystore() Returns the keystore to use for creating the key managers.
char[]	getAuthenticationPassword() Returns the password used for accessing the authentication keystore.
protected KeyManagerFactory	getKeyManagerFactory(KeyStore keystore, char[] password, String... aliases) Creates a new key manager factory.
KeyManager[]	getKeyManagers() Returns the key managers used when creating SSL contexts.
String[]	getTrustAliases() Returns the aliases of the entries to use in the trust keystore
KeyStore	getTrustKeystore() Returns the keystore to use for creating the trust managers.
protected TrustManagerFactory	getTrustManagerFactory(KeyStore keystore, String... aliases) Creates a new trust manager factory.
void	setAuthenticationAliases(String... aliases) Sets the aliases of the entries to use in the authentication keystore.
void	setAuthenticationKeystore(KeyStore keystore) Sets the keystore to use for creating the key managers.
void	setAuthenticationPassword(char[] password) Sets the password used for accessing the authentication keystore.
void	setTrustAliases(String... aliases) Sets the aliases of the entries to use in the trust keystore.
void	setTrustKeystore(KeyStore keystore) Sets the keystore to use for creating the trust managers.
String	toString()

Methods inherited from class org.ldaptive.ssl.AbstractSSLContextInitializer

aggregateTrustManagers, getHostnameVerifierConfig, getTrustManagers, initSSLContext, setHostnameVerifierConfig, setTrustManagers

Methods inherited from class java.lang.Object

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

Field Detail

trustKeystore

private KeyStore trustKeystore

KeyStore used to create trust managers.

trustAliases

private String[] trustAliases

Aliases of trust entries to use.

authenticationKeystore

private KeyStore authenticationKeystore

KeyStore used to create key managers.

authenticationAliases

private String[] authenticationAliases

Aliases of key entries to use.

authenticationPassword

private char[] authenticationPassword

Password used to access the authentication keystore.

Constructor Detail

KeyStoreSSLContextInitializer

public KeyStoreSSLContextInitializer()

Method Detail

getTrustKeystore

public KeyStore getTrustKeystore()

Returns the keystore to use for creating the trust managers.

Returns:

keystore

setTrustKeystore

public void setTrustKeystore(KeyStore keystore)

Sets the keystore to use for creating the trust managers.

Parameters:

keystore - to set

getTrustAliases

public String[] getTrustAliases()

Returns the aliases of the entries to use in the trust keystore

Returns:

trust aliases

setTrustAliases

public void setTrustAliases(String... aliases)

Sets the aliases of the entries to use in the trust keystore.

Parameters:

aliases - to use

getAuthenticationKeystore

public KeyStore getAuthenticationKeystore()

Returns the keystore to use for creating the key managers.

Returns:

keystore

setAuthenticationKeystore

public void setAuthenticationKeystore(KeyStore keystore)

Sets the keystore to use for creating the key managers.

Parameters:

keystore - to set

getAuthenticationAliases

public String[] getAuthenticationAliases()

Returns the aliases of the entries to use in the authentication keystore

Returns:

authentication aliases

setAuthenticationAliases

public void setAuthenticationAliases(String... aliases)

Sets the aliases of the entries to use in the authentication keystore.

Parameters:

aliases - to use

getAuthenticationPassword

public char[] getAuthenticationPassword()

Returns the password used for accessing the authentication keystore.

Returns:

authentication password

setAuthenticationPassword

public void setAuthenticationPassword(char[] password)

Sets the password used for accessing the authentication keystore.

Parameters:

password - to use for authentication

createTrustManagers

protected TrustManager[] createTrustManagers()
                                      throws GeneralSecurityException

Description copied from class: AbstractSSLContextInitializer

Creates any trust managers specific to this context initializer.

Specified by:

createTrustManagers in class AbstractSSLContextInitializer

Returns:

trust managers

Throws:

GeneralSecurityException - if an errors occurs while loading the TrustManagers

getTrustManagerFactory

protected TrustManagerFactory getTrustManagerFactory(KeyStore keystore,
                                                     String... aliases)
                                              throws GeneralSecurityException

Creates a new trust manager factory.

Parameters:

keystore - to initialize the trust manager factory

aliases - to include from the supplied keystore or null to include all entries

Returns:

trust manager factory

Throws:

GeneralSecurityException - if the trust manager factory cannot be initialized

getKeyManagers

public KeyManager[] getKeyManagers()
                            throws GeneralSecurityException

Description copied from interface: SSLContextInitializer

Returns the key managers used when creating SSL contexts.

Returns:

key managers

Throws:

GeneralSecurityException - if an errors occurs while loading the KeyManagers

getKeyManagerFactory

protected KeyManagerFactory getKeyManagerFactory(KeyStore keystore,
                                                 char[] password,
                                                 String... aliases)
                                          throws GeneralSecurityException

Creates a new key manager factory.

Parameters:

keystore - to initialize the key manager factory

password - to unlock the supplied keystore

aliases - to include from the supplied keystore or null to include all entries

Returns:

key manager factory

Throws:

GeneralSecurityException - if the key manager factory cannot be initialized

toString

public String toString()

Overrides:

toString in class Object