public class ReplicationSSLConfig extends ReplicationNetworkConfig
Modifier and Type | Field and Description |
---|---|
static String |
SSL_AUTHENTICATOR
The specification for an SSL authenicator.
|
static String |
SSL_AUTHENTICATOR_CLASS
The string identifying a class to be instantiated to check whether
incoming client SSL connections are to be trusted.
|
static String |
SSL_AUTHENTICATOR_PARAMS
A string encoding the parameters for configuring the authenticator class.
|
static String |
SSL_CIPHER_SUITES
The list of SSL cipher suites that are acceptable for SSL data channel
factories.
|
static String |
SSL_CLIENT_KEY_ALIAS
The alias name of the preferred key for use by a client connecting
to the service dispatcher.
|
static String |
SSL_HOST_VERIFIER
The configuration to be used for verifying the certificate of
a server when a connection is made.
|
static String |
SSL_HOST_VERIFIER_CLASS
The class to be instantiated to check whether the target host of a
connection initiated by a client is to be trusted.
|
static String |
SSL_HOST_VERIFIER_PARAMS
A string encoding the parameters for configuring the host verifier
class, if needed.
|
static String |
SSL_KEYSTORE_FILE
The path to the Java keystore file for SSL data channnel factories.
|
static String |
SSL_KEYSTORE_PASSWORD
The password for accessing the Java keystore file for SSL data channnel
factories.
|
static String |
SSL_KEYSTORE_PASSWORD_CLASS
A class that will be instantiated in order to retrieve a password that
allows access to the keystore file.
|
static String |
SSL_KEYSTORE_PASSWORD_PARAMS
A string encoding the parameters for configuring the password class.
|
static String |
SSL_KEYSTORE_TYPE
The type of the Java keystore file.
|
static String |
SSL_PROTOCOLS
The list of SSL protocols that are acceptable for SSL data channel
factories.
|
static String |
SSL_SERVER_KEY_ALIAS
The alias name of the preferred key for use by the service dispatcher
acting in SSL server mode.
|
static String |
SSL_TRUSTSTORE_FILE
The path to the Java truststore file for SSL data channel factories.
|
static String |
SSL_TRUSTSTORE_TYPE
The type of the Java truststore file.
|
CHANNEL_FACTORY_CLASS, CHANNEL_FACTORY_PARAMS, CHANNEL_LOG_NAME, CHANNEL_TYPE, props, validateParams
Constructor and Description |
---|
ReplicationSSLConfig()
Constructs a ReplicationSSLConfig initialized with the system default
settings.
|
ReplicationSSLConfig(Properties properties)
Creates an ReplicationSSLConfig which includes the properties
specified in the properties parameter.
|
Modifier and Type | Method and Description |
---|---|
ReplicationSSLConfig |
clone()
Returns a copy of this configuration object.
|
String |
getChannelType()
Get the channel type setting for the replication service.
|
String |
getSSLAuthenticator()
Returns the SSLAuthenticator configuration to be used for authenticating
incoming client connections.
|
String |
getSSLAuthenticatorClass()
Returns the SSLAuthenticator factory class to be used for creating
new Authenticator instances
|
String |
getSSLAuthenticatorParams()
Returns the SSLAuthenticator parameters to be used for creating
new Authenticator instances
|
String |
getSSLCipherSuites()
Returns the list of SSL cipher suites that are acceptable
|
String |
getSSLClientKeyAlias()
Returns the Java KeyStore alias associated with the key that should be
used when initiating SSL connections .
|
String |
getSSLHostVerifier()
Returns the HostnameVerifier factory class to be used for creating
new host verifier instances for client-mode operation
|
String |
getSSLHostVerifierClass()
Returns the HostnameVerifier factory class to be used for creating
new host verifier instances for client-mode operation
|
String |
getSSLHostVerifierParams()
Returns the SSLHostVerifier parameters to be used for creating
new host verifier instances for operation in client mode, if needed.
|
String |
getSSLKeyStore()
Returns the name of the Java KeyStore file to be used for SSL key pair
retrieval.
|
String |
getSSLKeyStorePassword()
Returns the password for the Java KeyStore file to be used for SSL key
pair retrieval.
|
String |
getSSLKeyStorePasswordClass()
Returns the name of a class that should be instantiated to retrieve the
password for the Java KeyStore file.
|
String |
getSSLKeyStorePasswordParams()
Returns a string to be used in the constructor for a keystore password
source instance.
|
com.sleepycat.je.rep.net.PasswordSource |
getSSLKeyStorePasswordSource()
Gets the password source provided for KeyStore access by the SSL
implementation.
|
String |
getSSLKeyStoreType()
Returns the type of the Java Keystore file to be used for SSL key pair
retrieval.
|
String |
getSSLProtocols()
Returns the list of SSL protocols that are acceptable
|
String |
getSSLServerKeyAlias()
Returns the Java KeyStore alias associated with the key that should be
used to accept incoming SSL connections.
|
String |
getSSLTrustStore()
Returns the name of the Java TrustStore file to be used for SSL
certificate validation.
|
String |
getSSLTrustStoreType()
Returns the type of the Java Truststore file to be used for SSL key pair
retrieval.
|
protected boolean |
isValidConfigParam(String paramName)
Checks whether the named parameter is valid for this configuration type.
|
ReplicationNetworkConfig |
setSSLAuthenticator(String authenticator)
Sets the authenticator configuration to be used for authenticating
incoming client connections.
|
ReplicationNetworkConfig |
setSSLAuthenticatorClass(String authenticatorClass)
Sets the authenticator class to be instantiated for creation of
new SSL Authenticator instances.
|
void |
setSSLAuthenticatorClassVoid(String authenticatorClass) |
ReplicationNetworkConfig |
setSSLAuthenticatorParams(String authenticatorParams)
Sets the Authenticator parameters to be passed to the
SSL server Authenticator class when instantiated.
|
void |
setSSLAuthenticatorParamsVoid(String authenticatorParams) |
void |
setSSLAuthenticatorVoid(String authenticator) |
ReplicationNetworkConfig |
setSSLCipherSuites(String cipherSuites)
Sets the list of SSL cipher suites that are acceptable
|
void |
setSSLCipherSuitesVoid(String cipherSuites) |
ReplicationNetworkConfig |
setSSLClientKeyAlias(String alias)
Sets the alias associated with the key in the Java KeyStore file to be
used when initiating SSL connections.
|
void |
setSSLClientKeyAliasVoid(String alias) |
ReplicationNetworkConfig |
setSSLHostVerifier(String hostVerifier)
Sets the configuration to be used for verifying the certificate of
a server when a connection is made.
|
ReplicationNetworkConfig |
setSSLHostVerifierClass(String hostVerifierClass)
Sets the host verifier class to be instantiated for creation of
new SSL host verifier instances.
|
void |
setSSLHostVerifierClassVoid(String hostVerifierClass) |
ReplicationNetworkConfig |
setSSLHostVerifierParams(String hostVerifierParams)
Sets the host verifier parameters to be passed to the SSL host verifier
class when instantiated.
|
void |
setSSLHostVerifierParamsVoid(String hostVerifierParams) |
void |
setSSLHostVerifierVoid(String hostVerifier) |
ReplicationNetworkConfig |
setSSLKeyStore(String filename)
Sets the name of the Java KeyStore file to be used when creating
SSL connections.
|
ReplicationNetworkConfig |
setSSLKeyStorePassword(String password)
Sets the password for the Java KeyStore file to be used when creating
SSL connections.
|
ReplicationNetworkConfig |
setSSLKeyStorePasswordClass(String className)
Sets the name of a class that should be instantiated to retrieve the
password for the Java KeyStore file.
|
void |
setSSLKeyStorePasswordClassVoid(String className) |
ReplicationNetworkConfig |
setSSLKeyStorePasswordParams(String params)
Sets the string to be used in the constructor for a keystore password
source instance.
|
void |
setSSLKeyStorePasswordParamsVoid(String params) |
ReplicationNetworkConfig |
setSSLKeyStorePasswordSource(com.sleepycat.je.rep.net.PasswordSource passwordSource)
Sets the password source for KeyStore access by the SSL implementation.
|
void |
setSSLKeyStorePasswordSourceVoid(com.sleepycat.je.rep.net.PasswordSource passwordSource) |
void |
setSSLKeyStorePasswordVoid(String password) |
ReplicationNetworkConfig |
setSSLKeyStoreType(String keyStoreType)
Sets the type of the Java KeyStore file to be used when creating
SSL connections.
|
void |
setSSLKeyStoreTypeVoid(String keyStoreType) |
void |
setSSLKeyStoreVoid(String filename) |
ReplicationNetworkConfig |
setSSLProtocols(String protocols)
Sets the list of SSL protocols that are acceptable
|
void |
setSSLProtocolsVoid(String protocols) |
ReplicationNetworkConfig |
setSSLServerKeyAlias(String alias)
Sets the alias associated with the key in the Java KeyStore file to be
used when accepting incoming SSL connections.
|
void |
setSSLServerKeyAliasVoid(String alias) |
ReplicationNetworkConfig |
setSSLTrustStore(String filename)
Sets the name of the Java TrustStore file to be used when validating
SSL certificates.
|
ReplicationNetworkConfig |
setSSLTrustStoreType(String trustStoreType)
Sets the type of the Java Truststore file to be used when creating
SSL connections.
|
void |
setSSLTrustStoreTypeVoid(String trustStoreType) |
void |
setSSLTrustStoreVoid(String filename) |
applyRepNetProperties, create, create, createDefault, getChannelFactoryClass, getChannelFactoryParams, getLogName, getRepNetPropertySet, registerParams, setChannelFactoryClass, setChannelFactoryClassVoid, setChannelFactoryParams, setChannelFactoryParamsVoid, setConfigParam, setLogName, setLogNameVoid
public static final String SSL_KEYSTORE_FILE
javax.net.ssl.keyStore
is used.
Name | Type | Mutable | Default |
"je.rep.ssl.keyStoreFile" | String | No | "" |
public static final String SSL_KEYSTORE_PASSWORD
javax.net.ssl.keyStorePassword
is used.
Name | Type | Mutable | Default |
"je.rep.ssl.keyStorePassword" | String | No | "" |
public static final String SSL_KEYSTORE_PASSWORD_CLASS
com.sleepycat.je.rep.net.PasswordSource
interface.
Name | Type | Mutable | Default |
"je.rep.ssl.keyStorePasswordClass" | String | No | "" |
public static final String SSL_KEYSTORE_PASSWORD_PARAMS
Name | Type | Mutable | Default |
"je.rep.ssl.keyStorePasswordParams" | String | No | "" |
public static final String SSL_KEYSTORE_TYPE
Name | Type | Mutable | Default |
"je.rep.ssl.keyStoreType" | String | No | "" |
public static final String SSL_SERVER_KEY_ALIAS
Name | Type | Mutable | Default |
"je.rep.ssl.serverKeyAlias" | String | No | "" |
public static final String SSL_CLIENT_KEY_ALIAS
Name | Type | Mutable | Default |
"je.rep.ssl.clientKeyAlias" | String | No | "" |
public static final String SSL_TRUSTSTORE_FILE
javax.net.ssl.trustStore
is used.
Name | Type | Mutable | Default |
"je.rep.ssl.trustStoreFile" | String | No | "" |
public static final String SSL_TRUSTSTORE_TYPE
Name | Type | Mutable | Default |
"je.rep.ssl.trustStoreType" | String | No | "JKS" |
public static final String SSL_CIPHER_SUITES
Name | Type | Mutable | Default |
"je.rep.ssl.cipherSuites" | String | No | "" |
public static final String SSL_PROTOCOLS
Name | Type | Mutable | Default |
"je.rep.ssl.protocols" | String | No | "" |
public static final String SSL_AUTHENTICATOR
mirror
dnmatch(
<Regular Expression>)
mirror
option causes the authenticator to check that the
Distinguished Name(DN) in the certificate of the incoming client
connection matches the DN of the certificate that this server presents
when connecting as a client to another server.
The dnmatch()
option causes the authenticator to check that
the DN in the certificate of the incoming client connection matches the
regular expression provided in the dnmatch() specification.
Do not configure both the SSL authenticator and the SSL authenticator
class, or an exception will be thrown during DataChannelFactory
instantiation.
Name | Type | Mutable | Default |
"je.rep.ssl.authenticator" | String | No | "" |
public static final String SSL_AUTHENTICATOR_CLASS
SSLAuthenticator
interface and provides a public constructor with an argument list of
the form
( InstanceParams
).
Do not configure both the SSL authenticator and the SSL authenticator class, or an exception will be thrown during DataChannelFactory instantiation.
Name | Type | Mutable | Default |
"je.rep.ssl.authenticatorClass" | String | No | "" |
public static final String SSL_AUTHENTICATOR_PARAMS
Name | Type | Mutable | Default |
"je.rep.ssl.authenticatorParams" | String | No | "" |
public static final String SSL_HOST_VERIFIER
hostname
mirror
dnmatch(
<Regular Expression>)
The hostname
option causes the verifier to check that the
Distinguished Name(DN) or one of the Subject Alternative Names in the
certificate presented by the server contains the hostname that
was the target of the connection attempt. This assumes that server
certificates are unique per server.
The mirror
option causes the verifier to check that the
Distinguished Name(DN) in the certificate of the server matches the DN
of the certificate that this server presents to incoming client
connections. This assumes that all servers have equivalent certificates.
The dnmatch()
option causes the verifier to check that
the DN in the certificate of the server matches the regular expression
string provided in the dnmatch() specification.
Do not configure both the SSL host verifier and the SSL host verifier class, or an exception will be thrown during DataChannelFactory instantiation.
Name | Type | Mutable | Default |
"je.rep.ssl.hostVerifier" | String | No | "" |
public static final String SSL_HOST_VERIFIER_CLASS
javax.net.ssl.HostnameVerifier
interface
and provides a public constructor with an argument list of the form
(InstanceParams
).
Do not configure both the SSL host verifier and the SSL host verifier class, or an exception will be thrown during DataChannelFactory instantiation.
Name | Type | Mutable | Default |
"je.rep.ssl.hostVerifierClass" | String | No | "" |
public static final String SSL_HOST_VERIFIER_PARAMS
Name | Type | Mutable | Default |
"je.rep.ssl.hostVerifierParams" | String | No | "" |
public ReplicationSSLConfig()
public ReplicationSSLConfig(Properties properties) throws IllegalArgumentException
properties
- Supported properties are described as the string
constants in this class.IllegalArgumentException
- If any properties read from the
properties parameter are invalid.public String getChannelType()
getChannelType
in class ReplicationNetworkConfig
public String getSSLKeyStore()
public ReplicationNetworkConfig setSSLKeyStore(String filename)
filename
- the KeyStore filenamepublic void setSSLKeyStoreVoid(String filename)
public String getSSLKeyStoreType()
public ReplicationNetworkConfig setSSLKeyStoreType(String keyStoreType)
keyStoreType
- the Keystore typepublic void setSSLKeyStoreTypeVoid(String keyStoreType)
public String getSSLKeyStorePassword()
public ReplicationNetworkConfig setSSLKeyStorePassword(String password)
password
- the KeyStore passwordpublic void setSSLKeyStorePasswordVoid(String password)
public String getSSLKeyStorePasswordClass()
public ReplicationNetworkConfig setSSLKeyStorePasswordClass(String className)
className
- the name of the classpublic void setSSLKeyStorePasswordClassVoid(String className)
public String getSSLKeyStorePasswordParams()
public ReplicationNetworkConfig setSSLKeyStorePasswordParams(String params)
params
- a string that is to be passed to the constructorpublic void setSSLKeyStorePasswordParamsVoid(String params)
public String getSSLServerKeyAlias()
public ReplicationNetworkConfig setSSLServerKeyAlias(String alias)
alias
- the KeyStore aliaspublic void setSSLServerKeyAliasVoid(String alias)
public String getSSLClientKeyAlias()
public ReplicationNetworkConfig setSSLClientKeyAlias(String alias)
alias
- the KeyStore aliaspublic void setSSLClientKeyAliasVoid(String alias)
public String getSSLTrustStore()
public ReplicationNetworkConfig setSSLTrustStore(String filename)
filename
- the TrustStore filenamepublic void setSSLTrustStoreVoid(String filename)
public String getSSLTrustStoreType()
public ReplicationNetworkConfig setSSLTrustStoreType(String trustStoreType)
trustStoreType
- the Truststore typepublic void setSSLTrustStoreTypeVoid(String trustStoreType)
public String getSSLCipherSuites()
public ReplicationNetworkConfig setSSLCipherSuites(String cipherSuites)
cipherSuites
- a comma-delimited list of SSL cipher suitespublic void setSSLCipherSuitesVoid(String cipherSuites)
public String getSSLProtocols()
public ReplicationNetworkConfig setSSLProtocols(String protocols)
protocols
- a comma-delimited list of SSL protocolspublic void setSSLProtocolsVoid(String protocols)
public String getSSLAuthenticator()
public ReplicationNetworkConfig setSSLAuthenticator(String authenticator) throws IllegalArgumentException
SSL_AUTHENTICATOR
for a complete description of this
parameter.authenticator
- the authentication configuration to useIllegalArgumentException
- if the authenticator specification
is not syntactically validpublic void setSSLAuthenticatorVoid(String authenticator) throws IllegalArgumentException
IllegalArgumentException
public String getSSLAuthenticatorClass()
public ReplicationNetworkConfig setSSLAuthenticatorClass(String authenticatorClass)
authenticatorClass
- the class name to usepublic void setSSLAuthenticatorClassVoid(String authenticatorClass) throws IllegalArgumentException
IllegalArgumentException
public String getSSLAuthenticatorParams()
public ReplicationNetworkConfig setSSLAuthenticatorParams(String authenticatorParams)
authenticatorParams
- the parameter value to usepublic void setSSLAuthenticatorParamsVoid(String authenticatorParams)
public String getSSLHostVerifier()
public ReplicationNetworkConfig setSSLHostVerifier(String hostVerifier) throws IllegalArgumentException
SSL_HOST_VERIFIER
for a complete description of this
parameter.hostVerifier
- the verifier configuration to useIllegalArgumentException
- if the authenticator specification
is not syntactically validpublic void setSSLHostVerifierVoid(String hostVerifier) throws IllegalArgumentException
IllegalArgumentException
public String getSSLHostVerifierClass()
public ReplicationNetworkConfig setSSLHostVerifierClass(String hostVerifierClass)
hostVerifierClass
- the class name to usepublic void setSSLHostVerifierClassVoid(String hostVerifierClass)
public String getSSLHostVerifierParams()
public ReplicationNetworkConfig setSSLHostVerifierParams(String hostVerifierParams)
hostVerifierParams
- the parameter value to usepublic void setSSLHostVerifierParamsVoid(String hostVerifierParams)
public ReplicationSSLConfig clone()
clone
in class ReplicationNetworkConfig
public com.sleepycat.je.rep.net.PasswordSource getSSLKeyStorePasswordSource()
public ReplicationNetworkConfig setSSLKeyStorePasswordSource(com.sleepycat.je.rep.net.PasswordSource passwordSource)
je.rep.ssl.keyStorePassword
property instead.
This setting is not included in the serialized representation.public void setSSLKeyStorePasswordSourceVoid(com.sleepycat.je.rep.net.PasswordSource passwordSource)
protected boolean isValidConfigParam(String paramName)
isValidConfigParam
in class ReplicationNetworkConfig
paramName
- the configuration parameter name, one of the String
constants in this classCopyright (c) 2002, 2015 Oracle and/or its affiliates. All rights reserved.