Package com.couchbase.client.core.env

Interface SecureEnvironment

All Known Subinterfaces:

CoreEnvironment

All Known Implementing Classes:

DefaultCoreEnvironment

public interface SecureEnvironment

A SecureEnvironment interface defines all methods which environment implementation should have to be accepted by SSLEngineFactory.

Method Summary

Modifier and Type	Method	Description
boolean	sslEnabled()	Identifies if SSL should be enabled.
boolean	sslHostnameVerificationEnabled()	If set to true, hostname verification is enabled.
KeyStore	sslKeystore()	Allows to directly configure a KeyStore.
String	sslKeystoreFile()	Identifies the filepath to the ssl keystore.
String	sslKeystorePassword()	The password which is used to protect the keystore.
KeyStore	sslTruststore()	Allows to directly configure a KeyStore.
String	sslTruststoreFile()	Identifies the filepath to the ssl TrustManager keystore.
String	sslTruststorePassword()	The password which is used to protect the TrustManager keystore.

Method Detail

sslEnabled

boolean sslEnabled()

Identifies if SSL should be enabled.

Returns:

true if SSL is enabled, false otherwise.

sslKeystoreFile

String sslKeystoreFile()

Identifies the filepath to the ssl keystore. If this method is used without also specifying sslTruststoreFile() this keystore will be used to initialize both the key factory as well as the trust factory with java SSL. This needs to be the case for backwards compatibility, but if you do not need X.509 client cert authentication you might as well just use sslTruststoreFile() alone.

Returns:

the path to the keystore file.

sslKeystorePassword

String sslKeystorePassword()

The password which is used to protect the keystore. Only needed if sslKeystoreFile() is used.

Returns:

the keystore password.

sslKeystore

KeyStore sslKeystore()

Allows to directly configure a KeyStore. If this method is used without also specifying sslTruststore() this keystore will be used to initialize both the key factory as well as the trust factory with java SSL. This needs to be the case for backwards compatibility, but if you do not need X.509 client cert authentication you might as well just use sslTruststore() alone.

Returns:

the keystore to use.

sslTruststoreFile

String sslTruststoreFile()

Identifies the filepath to the ssl TrustManager keystore. If this method is used without also specifying sslKeystoreFile() this keystore will be used to initialize both the key factory as well as the trust factory with java SSL. Prefer this method over the sslKeystoreFile() if you do not need X.509 client auth and just need server side certificate checking.

Returns:

the path to the truststore file.

sslTruststorePassword

String sslTruststorePassword()

The password which is used to protect the TrustManager keystore. Only needed if sslTruststoreFile() is used.

Returns:

the keystore password.

sslTruststore

KeyStore sslTruststore()

Allows to directly configure a KeyStore. If this method is used without also specifying sslKeystore() this keystore will be used to initialize both the key factory as well as the trust factory with java SSL. Prefer this method over the sslKeystore() if you do not need X.509 client auth and just need server side certificate checking.

Returns:

the keystore to use when initializing the factory/factories.

sslHostnameVerificationEnabled

boolean sslHostnameVerificationEnabled()

If set to true, hostname verification is enabled.

Returns:

true if enabled.