Grizzly NIO 5.0.2 · org.glassfish.grizzly.ssl.SSLContextConfigurator

Modifier and Type	Class and Description
public static class	SSLContextConfigurator.GenericStoreException

Modifier and Type	Field and Description
public static final SSLContextConfigurator	DEFAULT_CONFIG Default SSL configuration.
public static final String	KEY_FACTORY_MANAGER_ALGORITHM
public static final String	KEY_STORE_FILE
public static final String	KEY_STORE_PASSWORD
public static final String	KEY_STORE_PROVIDER
public static final String	KEY_STORE_TYPE
private String	keyManagerFactoryAlgorithm
private char[]	keyPass
private byte[]	keyStoreBytes
private String	keyStoreFile
private char[]	keyStorePass
private String	keyStoreProvider
private String	keyStoreType
private static final Logger	LOGGER Default Logger.
private String	securityProtocol
public static final String	TRUST_FACTORY_MANAGER_ALGORITHM
public static final String	TRUST_STORE_FILE
public static final String	TRUST_STORE_PASSWORD
public static final String	TRUST_STORE_PROVIDER
public static final String	TRUST_STORE_TYPE
private String	trustManagerFactoryAlgorithm
private byte[]	trustStoreBytes
private String	trustStoreFile
private char[]	trustStorePass
private String	trustStoreProvider
private String	trustStoreType

Access	Constructor and Description
public	SSLContextConfigurator() Default constructor.
public	SSLContextConfigurator(boolean If `true` populates configuration from `System#getProperties()`, else you have empty configuration. readSystemProperties) Constructor that allows you creating empty configuration.

Method Summary

Modifier and Type	Method and Description
public SSLContext	Returns: a new `SSLContext` createSSLContext() Deprecated Use `createSSLContext(boolean)`. Create a new `SSLContext`.
public SSLContext	Returns: a new `SSLContext` createSSLContext(final boolean `true` if an exception should be raised upon failure. throwException) Create a new `SSLContext`.
private static void	loadBytes(final byte[] bytes, final String storeFile, final char[] password, final KeyStore store)
public void	retrieve(Properties props)
public void	setKeyManagerFactoryAlgorithm(String the key manager factory algorithm. keyManagerFactoryAlgorithm) Sets the key manager factory algorithm.
public void	setKeyPass(String Password of key to set. keyPass) Password of the key in the key store.
public void	setKeyPass(char[] Password of key to set. keyPass) Password of the key in the key store.
public void	setKeyStoreBytes(byte[] key store payload. keyStoreBytes) Sets key store payload as byte array.
public void	setKeyStoreFile(String File name of key store. 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.
public void	setKeyStorePass(String Password of key store to set. keyStorePass) Password of key store.
public void	setKeyStorePass(char[] Password of key store to set. keyStorePass) Password of key store.
public void	setKeyStoreProvider(String Key store provider to set. keyStoreProvider) Sets the key store provider name.
public void	setKeyStoreType(String Type of key store to set. keyStoreType) Type of key store.
public void	setSecurityProtocol(String Protocol for `javax.net.ssl.SSLContext#getProtocol()`. securityProtocol) Sets the SSLContext protocol.
public void	setTrustManagerFactoryAlgorithm(String the trust manager factory algorithm. trustManagerFactoryAlgorithm) Sets the trust manager factory algorithm.
public void	setTrustStoreBytes(byte[] trust store payload. trustStoreBytes) Sets trust store payload as byte array.
public void	setTrustStoreFile(String File name of trust store. trustStoreFile) Sets trust store file name, also makes sure that if other trust store configuration parameters are not set to set them to default values.
public void	setTrustStorePass(String Password of trust store to set. trustStorePass) Password of trust store.
public void	setTrustStoreProvider(String Trust store provider to set. trustStoreProvider) Sets the trust store provider name.
public void	setTrustStoreType(String Type of trust store to set. trustStoreType) Type of trust store.
public boolean	Returns: `true` if configuration is valid, else `false`. validateConfiguration() Deprecated Use `createSSLContext(boolean)`. Validates `SSLContextConfigurator` configuration.
public boolean	Returns: `true` if configuration is valid, else `false`. validateConfiguration(boolean forces failure if no keystore is specified. needsKeyStore) Deprecated Use `createSSLContext(boolean)`. Validates `SSLContextConfigurator` configuration.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DEFAULT_CONFIG	back to summary
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)`.

KEY_FACTORY_MANAGER_ALGORITHM	back to summary
public static final String KEY_FACTORY_MANAGER_ALGORITHM

KEY_STORE_FILE	back to summary
public static final String KEY_STORE_FILE

KEY_STORE_PASSWORD	back to summary
public static final String KEY_STORE_PASSWORD

KEY_STORE_PROVIDER	back to summary
public static final String KEY_STORE_PROVIDER

KEY_STORE_TYPE	back to summary
public static final String KEY_STORE_TYPE

keyManagerFactoryAlgorithm	back to summary
private String keyManagerFactoryAlgorithm

keyPass	back to summary
private char[] keyPass

keyStoreBytes	back to summary
private byte[] keyStoreBytes

keyStoreFile	back to summary
private String keyStoreFile

keyStorePass	back to summary
private char[] keyStorePass

keyStoreProvider	back to summary
private String keyStoreProvider

keyStoreType	back to summary
private String keyStoreType

LOGGER	back to summary
private static final Logger LOGGER Default Logger.

securityProtocol	back to summary
private String securityProtocol

TRUST_FACTORY_MANAGER_ALGORITHM	back to summary
public static final String TRUST_FACTORY_MANAGER_ALGORITHM

TRUST_STORE_FILE	back to summary
public static final String TRUST_STORE_FILE

TRUST_STORE_PASSWORD	back to summary
public static final String TRUST_STORE_PASSWORD

TRUST_STORE_PROVIDER	back to summary
public static final String TRUST_STORE_PROVIDER

TRUST_STORE_TYPE	back to summary
public static final String TRUST_STORE_TYPE

trustManagerFactoryAlgorithm	back to summary
private String trustManagerFactoryAlgorithm

trustStoreBytes	back to summary
private byte[] trustStoreBytes

trustStoreFile	back to summary
private String trustStoreFile

trustStorePass	back to summary
private char[] trustStorePass

trustStoreProvider	back to summary
private String trustStoreProvider

trustStoreType	back to summary
private String trustStoreType

Constructor Detail

SSLContextConfigurator	back to summary
public SSLContextConfigurator() Default constructor. Reads configuration properties from `System#getProperties()`. Calls `SSLContextConfigurator(boolean)` with `true`.

SSLContextConfigurator back to summary

SSLContextConfigurator	back to summary
public SSLContextConfigurator(boolean readSystemProperties) Constructor that allows you creating empty configuration. Parameters readSystemProperties:boolean If `true` populates configuration from `System#getProperties()`, else you have empty configuration.

public SSLContextConfigurator(boolean readSystemProperties)

Constructor that allows you creating empty configuration.

Parameters

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

Method Detail

createSSLContext back to summary

createSSLContext	back to summary
public SSLContext createSSLContext() Deprecated Use `createSSLContext(boolean)`. Create a new `SSLContext`. Note that if there are any problems with the key or trust stores, that no exception will be thrown. Returns:SSLContext a new `SSLContext` Annotations @Deprecated

public SSLContext createSSLContext()

Deprecated

Use createSSLContext(boolean).

Create a new SSLContext. Note that if there are any problems with the key or trust stores, that no exception will be thrown.

Returns:SSLContext

a new SSLContext

Annotations

@Deprecated

createSSLContext back to summary

createSSLContext	back to summary
public SSLContext createSSLContext(final boolean throwException) Create a new `SSLContext`. If the `SSLContext` cannot be created for whatever reason, a `GenericStoreException` will be raised containing the root cause of the failure. Parameters throwException:boolean `true` if an exception should be raised upon failure. Returns:SSLContext a new `SSLContext` Exceptions GenericStoreException: `throwException` is `true` and the SSLContext cannot be created Since 2.3.28

public SSLContext createSSLContext(final boolean throwException)

Create a new SSLContext. If the SSLContext cannot be created for whatever reason, a GenericStoreException will be raised containing the root cause of the failure.

Parameters

throwException:boolean: true if an exception should be raised upon failure.

Returns:SSLContext

a new SSLContext

Exceptions

GenericStoreException:: throwException is true and the SSLContext cannot be created

Since

2.3.28

loadBytes	back to summary
private static void loadBytes(final byte[] bytes, final String storeFile, final char[] password, final KeyStore store) throws IOException, CertificateException, NoSuchAlgorithmException

retrieve	back to summary
public void retrieve(Properties props)

setKeyManagerFactoryAlgorithm	back to summary
public void setKeyManagerFactoryAlgorithm(String keyManagerFactoryAlgorithm) Sets the key manager factory algorithm. Parameters keyManagerFactoryAlgorithm:String the key manager factory algorithm.

setKeyManagerFactoryAlgorithm

back to summary

public void setKeyManagerFactoryAlgorithm(String keyManagerFactoryAlgorithm)

Sets the key manager factory algorithm.

Parameters

keyManagerFactoryAlgorithm:String: the key manager factory algorithm.

setKeyPass	back to summary
public void setKeyPass(String keyPass) Password of the key in the key store. Parameters keyPass:String Password of key to set.

setKeyPass

back to summary

public void setKeyPass(String keyPass)

Password of the key in the key store.

Parameters

keyPass:String: Password of key to set.

setKeyPass	back to summary
public void setKeyPass(char[] keyPass) Password of the key in the key store. Parameters keyPass:char[] Password of key to set.

setKeyPass

back to summary

public void setKeyPass(char[] keyPass)

Password of the key in the key store.

Parameters

keyPass:char[]: Password of key to set.

setKeyStoreBytes back to summary

setKeyStoreBytes	back to summary
public void setKeyStoreBytes(byte[] keyStoreBytes) Sets key store payload as byte array. Method resets key store file if any has been set before via `setKeyStoreFile(java.lang.String)`. Parameters keyStoreBytes:byte[] key store payload.

public void setKeyStoreBytes(byte[] keyStoreBytes)

Sets key store payload as byte array. Method resets key store file if any has been set before via setKeyStoreFile(java.lang.String).

Parameters

keyStoreBytes:byte[]: key store payload.

setKeyStoreFile back to summary

setKeyStoreFile	back to summary
public void setKeyStoreFile(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. Method resets key store bytes if any have been set before via `setKeyStoreBytes(byte[])`. Parameters keyStoreFile:String File name of key store.

public void setKeyStoreFile(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. Method resets key store bytes if any have been set before via setKeyStoreBytes(byte[]).

Parameters

keyStoreFile:String: File name of key store.

setKeyStorePass	back to summary
public void setKeyStorePass(String keyStorePass) Password of key store. Parameters keyStorePass:String Password of key store to set.

setKeyStorePass

back to summary

public void setKeyStorePass(String keyStorePass)

Password of key store.

Parameters

keyStorePass:String: Password of key store to set.

setKeyStorePass	back to summary
public void setKeyStorePass(char[] keyStorePass) Password of key store. Parameters keyStorePass:char[] Password of key store to set.

setKeyStorePass

back to summary

public void setKeyStorePass(char[] keyStorePass)

Password of key store.

Parameters

keyStorePass:char[]: Password of key store to set.

setKeyStoreProvider	back to summary
public void setKeyStoreProvider(String keyStoreProvider) Sets the key store provider name. Parameters keyStoreProvider:String Key store provider to set.

setKeyStoreProvider

back to summary

public void setKeyStoreProvider(String keyStoreProvider)

Sets the key store provider name.

Parameters

keyStoreProvider:String: Key store provider to set.

setKeyStoreType	back to summary
public void setKeyStoreType(String keyStoreType) Type of key store. Parameters keyStoreType:String Type of key store to set.

setKeyStoreType

back to summary

public void setKeyStoreType(String keyStoreType)

Type of key store.

Parameters

keyStoreType:String: Type of key store to set.

setSecurityProtocol back to summary

setSecurityProtocol	back to summary
public void setSecurityProtocol(String securityProtocol) Sets the SSLContext protocol. The default value is `TLS` if this is null. Parameters securityProtocol:String Protocol for `javax.net.ssl.SSLContext#getProtocol()`.

public void setSecurityProtocol(String securityProtocol)

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

Parameters

securityProtocol:String: Protocol for javax.net.ssl.SSLContext#getProtocol().

setTrustManagerFactoryAlgorithm	back to summary
public void setTrustManagerFactoryAlgorithm(String trustManagerFactoryAlgorithm) Sets the trust manager factory algorithm. Parameters trustManagerFactoryAlgorithm:String the trust manager factory algorithm.

setTrustManagerFactoryAlgorithm

back to summary

public void setTrustManagerFactoryAlgorithm(String trustManagerFactoryAlgorithm)

Sets the trust manager factory algorithm.

Parameters

trustManagerFactoryAlgorithm:String: the trust manager factory algorithm.

setTrustStoreBytes back to summary

setTrustStoreBytes	back to summary
public void setTrustStoreBytes(byte[] trustStoreBytes) Sets trust store payload as byte array. Method resets trust store file if any has been set before via `setTrustStoreFile(java.lang.String)`. Parameters trustStoreBytes:byte[] trust store payload.

public void setTrustStoreBytes(byte[] trustStoreBytes)

Sets trust store payload as byte array. Method resets trust store file if any has been set before via setTrustStoreFile(java.lang.String).

Parameters

trustStoreBytes:byte[]: trust store payload.

setTrustStoreFile back to summary

setTrustStoreFile	back to summary
public void setTrustStoreFile(String trustStoreFile) Sets trust store file name, also makes sure that if other trust store configuration parameters are not set to set them to default values. Method resets trust store bytes if any have been set before via `setTrustStoreBytes(byte[])`. Parameters trustStoreFile:String File name of trust store.

public void setTrustStoreFile(String trustStoreFile)

Sets trust store file name, also makes sure that if other trust store configuration parameters are not set to set them to default values. Method resets trust store bytes if any have been set before via setTrustStoreBytes(byte[]).

Parameters

trustStoreFile:String: File name of trust store.

setTrustStorePass	back to summary
public void setTrustStorePass(String trustStorePass) Password of trust store. Parameters trustStorePass:String Password of trust store to set.

setTrustStorePass

back to summary

public void setTrustStorePass(String trustStorePass)

Password of trust store.

Parameters

trustStorePass:String: Password of trust store to set.

setTrustStoreProvider

back to summary

public void setTrustStoreProvider(String trustStoreProvider)

Sets the trust store provider name.

Parameters

trustStoreProvider:String: Trust store provider to set.

setTrustStoreType

back to summary

public void setTrustStoreType(String trustStoreType)

Type of trust store.

Parameters

trustStoreType:String: Type of trust store to set.

validateConfiguration back to summary

public boolean validateConfiguration()

Deprecated

Use createSSLContext(boolean).

Validates SSLContextConfigurator configuration.

Returns:boolean

true if configuration is valid, else false.

Annotations

@Deprecated

validateConfiguration back to summary

public boolean validateConfiguration(boolean needsKeyStore)

Deprecated

Use createSSLContext(boolean).

Validates SSLContextConfigurator configuration.

Parameters

needsKeyStore:boolean: forces failure if no keystore is specified.

Returns:boolean

true if configuration is valid, else false.

Annotations

@Deprecated

public Class SSLContextConfigurator

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class SSLContextConfigurator.GenericStoreException

Constructor Summary

Constructor Detail