SSLContextConfigurator (grizzly-framework 2.4.4 API)

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

```
public class SSLContextConfigurator
extends Object
```
Utility class, which helps to configure SSLContext.

Author:

Alexey Stashok, Hubert Iwaniuk, Bruno Harbulot

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SSLContextConfigurator.GenericStoreException

Nested Classes
Modifier and Type	Class and Description
`static class`	`SSLContextConfigurator.GenericStoreException`

Field Summary

Fields
Modifier and Type	Field and Description
`static SSLContextConfigurator`	`DEFAULT_CONFIG` Default SSL configuration.
`static String`	`KEY_FACTORY_MANAGER_ALGORITHM`
`static String`	`KEY_STORE_FILE`
`static String`	`KEY_STORE_PASSWORD`
`static String`	`KEY_STORE_PROVIDER`
`static String`	`KEY_STORE_TYPE`
`static String`	`TRUST_FACTORY_MANAGER_ALGORITHM`
`static String`	`TRUST_STORE_FILE`
`static String`	`TRUST_STORE_PASSWORD`
`static String`	`TRUST_STORE_PROVIDER`
`static String`	`TRUST_STORE_TYPE`

Constructor Summary

Constructors
Constructor and Description
`SSLContextConfigurator()` Default constructor.
`SSLContextConfigurator(boolean readSystemProperties)` Constructor that allows you creating empty configuration.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`SSLContext`	`createSSLContext()` Deprecated. Use `createSSLContext(boolean)`.
`SSLContext`	`createSSLContext(boolean throwException)` Create a new `SSLContext`.
`void`	`retrieve(Properties props)`
`void`	`setKeyManagerFactoryAlgorithm(String keyManagerFactoryAlgorithm)` Sets the key manager factory algorithm.
`void`	`setKeyPass(char[] keyPass)` Password of the key in the key store.
`void`	`setKeyPass(String keyPass)` Password of the key in the key store.
`void`	`setKeyStoreBytes(byte[] keyStoreBytes)` Sets key store payload as byte array.
`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.
`void`	`setKeyStorePass(char[] keyStorePass)` Password of key store.
`void`	`setKeyStorePass(String keyStorePass)` Password of key store.
`void`	`setKeyStoreProvider(String keyStoreProvider)` Sets the key store provider name.
`void`	`setKeyStoreType(String keyStoreType)` Type of key store.
`void`	`setSecurityProtocol(String securityProtocol)` Sets the SSLContext protocol.
`void`	`setTrustManagerFactoryAlgorithm(String trustManagerFactoryAlgorithm)` Sets the trust manager factory algorithm.
`void`	`setTrustStoreBytes(byte[] trustStoreBytes)` Sets trust store payload as byte array.
`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.
`void`	`setTrustStorePass(String trustStorePass)` Password of trust store.
`void`	`setTrustStoreProvider(String trustStoreProvider)` Sets the trust store provider name.
`void`	`setTrustStoreType(String trustStoreType)` Type of trust store.
`boolean`	`validateConfiguration()` Deprecated. Use `createSSLContext(boolean)`.
`boolean`	`validateConfiguration(boolean needsKeyStore)` Deprecated. Use `createSSLContext(boolean)`.

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 String TRUST_STORE_PROVIDER
```
    See Also:
    
    Constant Field Values
  - KEY_STORE_PROVIDER
```
public static final String KEY_STORE_PROVIDER
```
    See Also:
    
    Constant Field Values
  - TRUST_STORE_FILE
```
public static final String TRUST_STORE_FILE
```
    See Also:
    
    Constant Field Values
  - KEY_STORE_FILE
```
public static final String KEY_STORE_FILE
```
    See Also:
    
    Constant Field Values
  - TRUST_STORE_PASSWORD
```
public static final String TRUST_STORE_PASSWORD
```
    See Also:
    
    Constant Field Values
  - KEY_STORE_PASSWORD
```
public static final String KEY_STORE_PASSWORD
```
    See Also:
    
    Constant Field Values
  - TRUST_STORE_TYPE
```
public static final String TRUST_STORE_TYPE
```
    See Also:
    
    Constant Field Values
  - KEY_STORE_TYPE
```
public static final String KEY_STORE_TYPE
```
    See Also:
    
    Constant Field Values
  - KEY_FACTORY_MANAGER_ALGORITHM
```
public static final String KEY_FACTORY_MANAGER_ALGORITHM
```
    See Also:
    
    Constant Field Values
  - TRUST_FACTORY_MANAGER_ALGORITHM
```
public static final 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(String trustStoreProvider)
```
    Sets the trust store provider name.
    
    Parameters:
    
    trustStoreProvider - Trust store provider to set.
  - setKeyStoreProvider
```
public void setKeyStoreProvider(String keyStoreProvider)
```
    Sets the key store provider name.
    
    Parameters:
    
    keyStoreProvider - Key store provider to set.
  - setTrustStoreType
```
public void setTrustStoreType(String trustStoreType)
```
    Type of trust store.
    
    Parameters:
    
    trustStoreType - Type of trust store to set.
  - setKeyStoreType
```
public void setKeyStoreType(String keyStoreType)
```
    Type of key store.
    
    Parameters:
    
    keyStoreType - Type of key store to set.
  - setTrustStorePass
```
public void setTrustStorePass(String trustStorePass)
```
    Password of trust store.
    
    Parameters:
    
    trustStorePass - Password of trust store to set.
  - setKeyStorePass
```
public void setKeyStorePass(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(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(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 - File name of trust store.
  - setTrustStoreBytes
```
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 - trust store payload.
  - setKeyStoreFile
```
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 - File name of key store.
  - setKeyStoreBytes
```
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 - key store payload.
  - setTrustManagerFactoryAlgorithm
```
public void setTrustManagerFactoryAlgorithm(String trustManagerFactoryAlgorithm)
```
    Sets the trust manager factory algorithm.
    
    Parameters:
    
    trustManagerFactoryAlgorithm - the trust manager factory algorithm.
  - setKeyManagerFactoryAlgorithm
```
public void setKeyManagerFactoryAlgorithm(String keyManagerFactoryAlgorithm)
```
    Sets the key manager factory algorithm.
    
    Parameters:
    
    keyManagerFactoryAlgorithm - the key manager factory algorithm.
  - setSecurityProtocol
```
public void setSecurityProtocol(String securityProtocol)
```
    Sets the SSLContext protocol. The default value is TLS if this is null.
    
    Parameters:
    
    securityProtocol - Protocol for SSLContext.getProtocol().
  - validateConfiguration
```
@Deprecated
public boolean validateConfiguration()
```
    Deprecated. Use createSSLContext(boolean).
    
    Validates SSLContextConfigurator configuration.
    
    Returns:
    
    true if configuration is valid, else false.
  - validateConfiguration
```
@Deprecated
public boolean validateConfiguration(boolean needsKeyStore)
```
    Deprecated. Use createSSLContext(boolean).
    
    Validates SSLContextConfigurator configuration.
    
    Parameters:
    
    needsKeyStore - forces failure if no keystore is specified.
    
    Returns:
    
    true if configuration is valid, else false.
  - createSSLContext
```
@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:
    
    a new SSLContext
  - createSSLContext
```
public SSLContext createSSLContext(boolean throwException)
```
    Create a new SSLContext. If the SSLContext cannot be created for whatever reason, a SSLContextConfigurator.GenericStoreException will be raised containing the root cause of the failure.
    
    Parameters:
    
    throwException - true if an exception should be raised upon failure.
    
    Returns:
    
    a new SSLContext
    
    Throws:
    
    SSLContextConfigurator.GenericStoreException - throwException is true and the SSLContext cannot be created
    
    Since:
    
    2.3.28
  - retrieve
```
public void retrieve(Properties props)
```

Class SSLContextConfigurator

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TRUST_STORE_PROVIDER

KEY_STORE_PROVIDER

TRUST_STORE_FILE

KEY_STORE_FILE

TRUST_STORE_PASSWORD

KEY_STORE_PASSWORD

TRUST_STORE_TYPE

KEY_STORE_TYPE

KEY_FACTORY_MANAGER_ALGORITHM

TRUST_FACTORY_MANAGER_ALGORITHM

DEFAULT_CONFIG

Constructor Detail

SSLContextConfigurator

SSLContextConfigurator

Method Detail

setTrustStoreProvider

setKeyStoreProvider

setTrustStoreType

setKeyStoreType

setTrustStorePass

setKeyStorePass

setKeyStorePass

setKeyPass

setKeyPass

setTrustStoreFile

setTrustStoreBytes

setKeyStoreFile

setKeyStoreBytes

setTrustManagerFactoryAlgorithm

setKeyManagerFactoryAlgorithm

setSecurityProtocol

validateConfiguration

validateConfiguration

createSSLContext

createSSLContext

retrieve