Package org.glassfish.tyrus.container.jdk.client

Class SslContextConfigurator

java.lang.Object
org.glassfish.tyrus.container.jdk.client.SslContextConfigurator
public class SslContextConfigurator extends Object
Deprecated.
Please use SslContextConfigurator.
Utility class, which helps to configure ssl context.

Used to configure SslEngineConfigurator, which will be passed to client via configuration properties. Example: 

      SslContextConfigurator sslContextConfigurator = new SslContextConfigurator();
      sslContextConfigurator.setTrustStoreFile("...");
      sslContextConfigurator.setTrustStorePassword("...");
      sslContextConfigurator.setTrustStoreType("...");
      sslContextConfigurator.setKeyStoreFile("...");
      sslContextConfigurator.setKeyStorePassword("...");
      sslContextConfigurator.setKeyStoreType("...");
      SslEngineConfigurator sslEngineConfigurator = new SslEngineConfigurator(sslContextConfigurator, true, false,
 false);
      client.getProperties().put(ClientManager.SSL_ENGINE_CONFIGURATOR, sslEngineConfigurator);
Author:
Alexey Stashok, Hubert Iwaniuk, Bruno Harbulot, Marek Potociar

  • Field Details

    • TRUST_STORE_PROVIDER

      public static final String TRUST_STORE_PROVIDER
      Deprecated.
      Trust store provider name.

      The value MUST be a String representing the name of a trust store provider.

      No default value is set.

      The name of the configuration property is "javax.net.ssl.trustStoreProvider".

      See Also:

    • KEY_STORE_PROVIDER

      public static final String KEY_STORE_PROVIDER
      Deprecated.
      Key store provider name.

      The value MUST be a String representing the name of a trust store provider.

      No default value is set.

      The name of the configuration property is "javax.net.ssl.keyStoreProvider".

      See Also:

    • TRUST_STORE_FILE

      public static final String TRUST_STORE_FILE
      Deprecated.
      Trust store file name.

      The value MUST be a String representing the name of a trust store file.

      No default value is set.

      The name of the configuration property is "javax.net.ssl.trustStore".

      See Also:

    • KEY_STORE_FILE

      public static final String KEY_STORE_FILE
      Deprecated.
      Key store file name.

      The value MUST be a String representing the name of a key store file.

      No default value is set.

      The name of the configuration property is "javax.net.ssl.keyStore".

      See Also:

    • TRUST_STORE_PASSWORD

      public static final String TRUST_STORE_PASSWORD
      Deprecated.
      Trust store file password - the password used to unlock the trust store file.

      The value MUST be a String representing the trust store file password.

      No default value is set.

      The name of the configuration property is "javax.net.ssl.trustStorePassword".

      See Also:

    • KEY_STORE_PASSWORD

      public static final String KEY_STORE_PASSWORD
      Deprecated.
      Key store file password - the password used to unlock the trust store file.

      The value MUST be a String representing the key store file password.

      No default value is set.

      The name of the configuration property is "javax.net.ssl.keyStorePassword".

      See Also:

    • TRUST_STORE_TYPE

      public static final String TRUST_STORE_TYPE
      Deprecated.
      Trust store type (see KeyStore.getType() for more info).

      The value MUST be a String representing the trust store type name.

      No default value is set.

      The name of the configuration property is "javax.net.ssl.trustStoreType".

      See Also:

    • KEY_STORE_TYPE

      public static final String KEY_STORE_TYPE
      Deprecated.
      Key store type (see KeyStore.getType() for more info).

      The value MUST be a String representing the key store type name.

      No default value is set.

      The name of the configuration property is "javax.net.ssl.keyStoreType".

      See Also:

    • KEY_FACTORY_MANAGER_ALGORITHM

      public static final String KEY_FACTORY_MANAGER_ALGORITHM
      Deprecated.
      Key manager factory algorithm name.

      The value MUST be a String representing the key manager factory algorithm name.

      No default value is set.

      The name of the configuration property is "ssl.KeyManagerFactory.algorithm".

      See Also:

    • TRUST_FACTORY_MANAGER_ALGORITHM

      public static final String TRUST_FACTORY_MANAGER_ALGORITHM
      Deprecated.
      Trust manager factory algorithm name.

      The value MUST be a String representing the trust manager factory algorithm name.

      No default value is set.

      The name of the configuration property is "ssl.TrustManagerFactory.algorithm".

      See Also:

    • DEFAULT_CONFIG

      public static final SslContextConfigurator DEFAULT_CONFIG
      Deprecated.
      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 Details

    • SslContextConfigurator

      public SslContextConfigurator()
      Deprecated.
      Default constructor. Reads configuration properties from System.getProperties(). Calls SslContextConfigurator(boolean) with true.

    • SslContextConfigurator

      public SslContextConfigurator(boolean readSystemProperties)
      Deprecated.
      Constructor that allows you creating empty configuration.
      Parameters:
      readSystemProperties - If true populates configuration from System.getProperties(), else you have empty configuration.

  • Method Details

    • setTrustStoreProvider

      public void setTrustStoreProvider(String trustStoreProvider)
      Deprecated.
      Sets the trust store provider name.
      Parameters:
      trustStoreProvider - Trust store provider to set.

    • setKeyStoreProvider

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

    • setTrustStoreType

      public void setTrustStoreType(String trustStoreType)
      Deprecated.
      Type of trust store.
      Parameters:
      trustStoreType - Type of trust store to set.

    • setKeyStoreType

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

    • setTrustStorePassword

      public void setTrustStorePassword(String trustStorePassword)
      Deprecated.
      Password of trust store.
      Parameters:
      trustStorePassword - Password of trust store to set.

    • setKeyStorePassword

      public void setKeyStorePassword(String keyStorePassword)
      Deprecated.
      Password of key store.
      Parameters:
      keyStorePassword - Password of key store to set.

    • setKeyStorePassword

      public void setKeyStorePassword(char[] keyStorePassword)
      Deprecated.
      Password of key store.
      Parameters:
      keyStorePassword - Password of key store to set.

    • setKeyPassword

      public void setKeyPassword(String keyPassword)
      Deprecated.
      Password of the key in the key store.
      Parameters:
      keyPassword - Password of key to set.

    • setKeyPassword

      public void setKeyPassword(char[] keyPassword)
      Deprecated.
      Password of the key in the key store.
      Parameters:
      keyPassword - Password of key to set.

    • setTrustStoreFile

      public void setTrustStoreFile(String trustStoreFile)
      Deprecated.
      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)
      Deprecated.
      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)
      Deprecated.
      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)
      Deprecated.
      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)
      Deprecated.
      Sets the trust manager factory algorithm.
      Parameters:
      trustManagerFactoryAlgorithm - the trust manager factory algorithm.

    • setKeyManagerFactoryAlgorithm

      public void setKeyManagerFactoryAlgorithm(String keyManagerFactoryAlgorithm)
      Deprecated.
      Sets the key manager factory algorithm.
      Parameters:
      keyManagerFactoryAlgorithm - the key manager factory algorithm.

    • setSecurityProtocol

      public void setSecurityProtocol(String securityProtocol)
      Deprecated.
      Sets the SSLContext protocol. The default value is TLS if this is null.
      Parameters:
      securityProtocol - Protocol for SSLContext.getProtocol().

    • validateConfiguration

      public boolean validateConfiguration()
      Deprecated.
      Validates SslContextConfigurator configuration.
      Returns:
      true if configuration is valid, else false.

    • validateConfiguration

      public boolean validateConfiguration(boolean needsKeyStore)
      Deprecated.
      Validates SslContextConfigurator configuration.
      Parameters:
      needsKeyStore - forces failure if no keystore is specified.
      Returns:
      true if configuration is valid, else false.

    • createSSLContext

      public SSLContext createSSLContext()
      Deprecated.

    • retrieve

      public void retrieve(Properties props)
      Deprecated.