org.glassfish.grizzly.ssl
Class SSLContextConfigurator

java.lang.Object
  org.glassfish.grizzly.ssl.SSLContextConfigurator

public class SSLContextConfigurator
extends java.lang.Object

Utility class, which helps to configure SSLContext.

Author:

Alexey Stashok, Hubert Iwaniuk, Bruno Harbulot

Field Summary

static SSLContextConfigurator	DEFAULT_CONFIG Default SSL configuration.
static java.lang.String	KEY_FACTORY_MANAGER_ALGORITHM
static java.lang.String	KEY_STORE_FILE
static java.lang.String	KEY_STORE_PASSWORD
static java.lang.String	KEY_STORE_PROVIDER
static java.lang.String	KEY_STORE_TYPE
static java.lang.String	TRUST_FACTORY_MANAGER_ALGORITHM
static java.lang.String	TRUST_STORE_FILE
static java.lang.String	TRUST_STORE_PASSWORD
static java.lang.String	TRUST_STORE_PROVIDER
static java.lang.String	TRUST_STORE_TYPE

Constructor Summary

SSLContextConfigurator()
Default constructor.

SSLContextConfigurator(boolean readSystemProperties)
Constructor that allows you creating empty configuration.

Method Summary

javax.net.ssl.SSLContext	createSSLContext()
void	retrieve(java.util.Properties props)
void	setKeyManagerFactoryAlgorithm(java.lang.String keyManagerFactoryAlgorithm) Sets the key manager factory algorithm.
void	setKeyPass(char[] keyPass) Password of the key in the key store.
void	setKeyPass(java.lang.String keyPass) Password of the key in the key store.
void	setKeyStoreFile(java.lang.String keyStoreFile) Sets key store file name, also makes sure that if other key store configuration parameters are not set to set them to default values.
void	setKeyStorePass(char[] keyStorePass) Password of key store.
void	setKeyStorePass(java.lang.String keyStorePass) Password of key store.
void	setKeyStoreProvider(java.lang.String keyStoreProvider) Sets the key store provider name.
void	setKeyStoreType(java.lang.String keyStoreType) Type of key store.
void	setSecurityProtocol(java.lang.String securityProtocol) Sets the SSLContext protocol.
void	setTrustManagerFactoryAlgorithm(java.lang.String trustManagerFactoryAlgorithm) Sets the trust manager factory algorithm.
void	setTrustStoreFile(java.lang.String trustStoreFile) Sets trust store file name, also makes sute that if other trust store configuration parameters are not set to set them to default values.
void	setTrustStorePass(java.lang.String trustStorePass) Password of trust store.
void	setTrustStoreProvider(java.lang.String trustStoreProvider) Sets the trust store provider name.
void	setTrustStoreType(java.lang.String trustStoreType) Type of trust store.
boolean	validateConfiguration() Validates SSLContextConfigurator configuration.
boolean	validateConfiguration(boolean needsKeyStore) Validates SSLContextConfigurator configuration.

Methods inherited from class java.lang.Object

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

Field Detail

TRUST_STORE_PROVIDER

public static final java.lang.String TRUST_STORE_PROVIDER

See Also:

Constant Field Values

KEY_STORE_PROVIDER

public static final java.lang.String KEY_STORE_PROVIDER

See Also:

Constant Field Values

TRUST_STORE_FILE

public static final java.lang.String TRUST_STORE_FILE

See Also:

Constant Field Values

KEY_STORE_FILE

public static final java.lang.String KEY_STORE_FILE

See Also:

Constant Field Values

TRUST_STORE_PASSWORD

public static final java.lang.String TRUST_STORE_PASSWORD

See Also:

Constant Field Values

KEY_STORE_PASSWORD

public static final java.lang.String KEY_STORE_PASSWORD

See Also:

Constant Field Values

TRUST_STORE_TYPE

public static final java.lang.String TRUST_STORE_TYPE

See Also:

Constant Field Values

KEY_STORE_TYPE

public static final java.lang.String KEY_STORE_TYPE

See Also:

Constant Field Values

KEY_FACTORY_MANAGER_ALGORITHM

public static final java.lang.String KEY_FACTORY_MANAGER_ALGORITHM

See Also:

Constant Field Values

TRUST_FACTORY_MANAGER_ALGORITHM

public static final java.lang.String TRUST_FACTORY_MANAGER_ALGORITHM

See Also:

Constant Field Values

DEFAULT_CONFIG

public static final SSLContextConfigurator DEFAULT_CONFIG

Default SSL configuration. If you have changed any of System.getProperties() of javax.net.ssl family you should refresh this configuration by calling retrieve(java.util.Properties).

Constructor Detail

SSLContextConfigurator

public SSLContextConfigurator()

Default constructor. Reads configuration properties from System.getProperties(). Calls SSLContextConfigurator(boolean) with true.

SSLContextConfigurator

public SSLContextConfigurator(boolean readSystemProperties)

Constructor that allows you creating empty configuration.

Parameters:

readSystemProperties - If true populates configuration from System.getProperties(), else you have empty configuration.

Method Detail

setTrustStoreProvider

public void setTrustStoreProvider(java.lang.String trustStoreProvider)

Sets the trust store provider name.

Parameters:

trustStoreProvider - Trust store provider to set.

setKeyStoreProvider

public void setKeyStoreProvider(java.lang.String keyStoreProvider)

Sets the key store provider name.

Parameters:

keyStoreProvider - Key store provider to set.

setTrustStoreType

public void setTrustStoreType(java.lang.String trustStoreType)

Type of trust store.

Parameters:

trustStoreType - Type of trust store to set.

setKeyStoreType

public void setKeyStoreType(java.lang.String keyStoreType)

Type of key store.

Parameters:

keyStoreType - Type of key store to set.

setTrustStorePass

public void setTrustStorePass(java.lang.String trustStorePass)

Password of trust store.

Parameters:

trustStorePass - Password of trust store to set.

setKeyStorePass

public void setKeyStorePass(java.lang.String keyStorePass)

Password of key store.

Parameters:

keyStorePass - Password of key store to set.

setKeyStorePass

public void setKeyStorePass(char[] keyStorePass)

Password of key store.

Parameters:

keyStorePass - Password of key store to set.

setKeyPass

public void setKeyPass(java.lang.String keyPass)

Password of the key in the key store.

Parameters:

keyPass - Password of key to set.

setKeyPass

public void setKeyPass(char[] keyPass)

Password of the key in the key store.

Parameters:

keyPass - Password of key to set.

setTrustStoreFile

public void setTrustStoreFile(java.lang.String trustStoreFile)

Sets trust store file name, also makes sute that if other trust store configuration parameters are not set to set them to default values.

Parameters:

trustStoreFile - File name of trust store.

setKeyStoreFile

public void setKeyStoreFile(java.lang.String keyStoreFile)

Sets key store file name, also makes sure that if other key store configuration parameters are not set to set them to default values.

Parameters:

keyStoreFile - File name of key store.

setTrustManagerFactoryAlgorithm

public void setTrustManagerFactoryAlgorithm(java.lang.String trustManagerFactoryAlgorithm)

Sets the trust manager factory algorithm.

Parameters:

trustManagerFactoryAlgorithm - the trust manager factory algorithm.

setKeyManagerFactoryAlgorithm

public void setKeyManagerFactoryAlgorithm(java.lang.String keyManagerFactoryAlgorithm)

Sets the key manager factory algorithm.

Parameters:

keyManagerFactoryAlgorithm - the key manager factory algorithm.

setSecurityProtocol

public void setSecurityProtocol(java.lang.String securityProtocol)

Sets the SSLContext protocol. The default value is TLS if this is null.

Parameters:

securityProtocol - Protocol for SSLContext.getProtocol().

validateConfiguration

public boolean validateConfiguration()

Validates SSLContextConfigurator configuration.

Returns:

true if configuration is valid, else false.

validateConfiguration

public boolean validateConfiguration(boolean needsKeyStore)

Validates SSLContextConfigurator configuration.

Parameters:

needsKeyStore - forces failure if no keystore is specified.

Returns:

true if configuration is valid, else false.

createSSLContext

public javax.net.ssl.SSLContext createSSLContext()

retrieve

public void retrieve(java.util.Properties props)