io.axual.common.config

Class SslConfig.Builder

java.lang.Object

io.axual.common.config.SslConfig.Builder

Enclosing class:

SslConfig

public static class SslConfig.Builder
extends java.lang.Object

The Builder class for SslConfig.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SslConfig	build() Builds and returns an SslConfig.
boolean	getEnableHostnameVerification() Check whether hostname verification is enabled.
boolean	getEnableValidateTruststore() Checks whether the validation of expired or not yet valid certification is enabled.
PasswordConfig	getKeyPassword() Gets the password to access the private key in the keystore.
PasswordConfig	getKeystoreCertificateChain() Gets the keystore certificates in PEM format.
PasswordConfig	getKeystoreKey() Gets the keystore certificates in form of PEM.
java.lang.String	getKeystoreLocation() Gets the keystore location, being either a path name to a locally stored keystore, or a location to a resource bundled in the application's binary.
PasswordConfig	getKeystorePassword() Gets the password to access the truststore.
SslConfig.KeystoreType	getKeystoreType()
java.lang.String	getSslProtocol() Gets SSL protocol.
PasswordConfig	getTruststoreCertificates() Gets the truststore certificates in PEM format.
java.lang.String	getTruststoreLocation() Gets the truststore location, being either a path name to a locally stored truststore, or a location to a resource bundled in the application's binary.
PasswordConfig	getTruststorePassword() Gets truststore password.
SslConfig.TruststoreType	getTruststoreType()
SslConfig.Builder	setEnableHostnameVerification(boolean enableHostnameVerification) Sets enable hostname verification.
SslConfig.Builder	setEnableValidateTruststore(boolean enableValidateTruststore) Sets enable validate truststore.
SslConfig.Builder	setKeyPassword(PasswordConfig keyPassword) Sets the password to access the private key in the keystore.
SslConfig.Builder	setKeyPassword(java.lang.String keyPassword) Sets the password to access the private key in the keystore.
SslConfig.Builder	setKeystoreCertificateChain(PasswordConfig keystoreCertificateChain) Sets the keystore cert chain.
SslConfig.Builder	setKeystoreCertificateChain(java.lang.String keystoreCertificateChain) Sets the keystore cert chain.
SslConfig.Builder	setKeystoreKey(PasswordConfig keystoreKey) Sets the private key in the format specified by 'ssl.keystore.type'.
SslConfig.Builder	setKeystoreKey(java.lang.String keystoreKey) Sets the private key in the format specified by 'ssl.keystore.type'.
SslConfig.Builder	setKeystoreLocation(java.lang.String keystoreLocation) Sets keystore location.
SslConfig.Builder	setKeystorePassword(PasswordConfig keystorePassword) Sets password to access the keystore.
SslConfig.Builder	setKeystorePassword(java.lang.String keystorePassword) Sets password to access the keystore.
SslConfig.Builder	setKeystoreType(SslConfig.KeystoreType keystoreType) Sets the keystore type format
SslConfig.Builder	setSslProtocol(java.lang.String sslProtocol) Sets configured SSL protocol.
SslConfig.Builder	setTruststoreCertificates(PasswordConfig truststoreCertificates) Sets the truststore location, being either a path name to a locally stored truststore, or a location to a resource bundled in the application's binary.
SslConfig.Builder	setTruststoreCertificates(java.lang.String truststoreCertificates) Sets the truststore location, being either a path name to a locally stored truststore, or a location to a resource bundled in the application's binary.
SslConfig.Builder	setTruststoreLocation(java.lang.String truststoreLocation) Sets the truststore location, being either a path name to a locally stored truststore, or a location to a resource bundled in the application's binary.
SslConfig.Builder	setTruststorePassword(PasswordConfig truststorePassword) Sets truststore password.
SslConfig.Builder	setTruststorePassword(java.lang.String truststorePassword) Sets truststore password.
SslConfig.Builder	setTruststoreType(SslConfig.TruststoreType truststoreType) Sets truststore type format

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

setKeystoreType

public SslConfig.Builder setKeystoreType(SslConfig.KeystoreType keystoreType)

Sets the keystore type format

Parameters:

keystoreType -

Returns:

getKeystoreType

public SslConfig.KeystoreType getKeystoreType()

Returns:

the keystore type

setTruststoreType

public SslConfig.Builder setTruststoreType(SslConfig.TruststoreType truststoreType)

Sets truststore type format

Parameters:

truststoreType -

Returns:

getTruststoreType

public SslConfig.TruststoreType getTruststoreType()

Returns:

truststore type

getKeyPassword

public PasswordConfig getKeyPassword()

Gets the password to access the private key in the keystore.

Returns:

the key password

setKeyPassword

public SslConfig.Builder setKeyPassword(PasswordConfig keyPassword)

Sets the password to access the private key in the keystore.

Parameters:

keyPassword - the key password

Returns:

the Builder

setKeyPassword

public SslConfig.Builder setKeyPassword(java.lang.String keyPassword)

Sets the password to access the private key in the keystore.

Parameters:

keyPassword - the key password

Returns:

the Builder

getKeystoreLocation

public java.lang.String getKeystoreLocation()

Gets the keystore location, being either a path name to a locally stored keystore, or a location to a resource bundled in the application's binary.

Returns:

the keystore location

setKeystoreLocation

public SslConfig.Builder setKeystoreLocation(java.lang.String keystoreLocation)

Sets keystore location.

Parameters:

keystoreLocation - the keystore location

Returns:

the Builder

getKeystorePassword

public PasswordConfig getKeystorePassword()

Gets the password to access the truststore.

Returns:

the truststore password

setKeystorePassword

public SslConfig.Builder setKeystorePassword(PasswordConfig keystorePassword)

Sets password to access the keystore.

Parameters:

keystorePassword - the keystore password

Returns:

the Builder

setKeystorePassword

public SslConfig.Builder setKeystorePassword(java.lang.String keystorePassword)

Sets password to access the keystore.

Parameters:

keystorePassword - the keystore password

Returns:

the Builder

getTruststoreLocation

public java.lang.String getTruststoreLocation()

Gets the truststore location, being either a path name to a locally stored truststore, or a location to a resource bundled in the application's binary.

Returns:

the truststore location

setTruststoreLocation

public SslConfig.Builder setTruststoreLocation(java.lang.String truststoreLocation)

Sets the truststore location, being either a path name to a locally stored truststore, or a location to a resource bundled in the application's binary.

Parameters:

truststoreLocation - the truststore location

Returns:

the Builder

getTruststoreCertificates

public PasswordConfig getTruststoreCertificates()

Gets the truststore certificates in PEM format.

Returns:

the truststore PEM

setTruststoreCertificates

public SslConfig.Builder setTruststoreCertificates(java.lang.String truststoreCertificates)

Sets the truststore location, being either a path name to a locally stored truststore, or a location to a resource bundled in the application's binary.

Parameters:

truststoreCertificates - the truststore certificate pem

Returns:

the Builder

setTruststoreCertificates

public SslConfig.Builder setTruststoreCertificates(PasswordConfig truststoreCertificates)

Sets the truststore location, being either a path name to a locally stored truststore, or a location to a resource bundled in the application's binary.

Parameters:

truststoreCertificates - the truststore certificate pem

Returns:

the Builder

getKeystoreCertificateChain

public PasswordConfig getKeystoreCertificateChain()

Gets the keystore certificates in PEM format.

Returns:

the truststore PEM

setKeystoreCertificateChain

public SslConfig.Builder setKeystoreCertificateChain(java.lang.String keystoreCertificateChain)

Sets the keystore cert chain.

Parameters:

keystoreCertificateChain - Certificate chain in the format specified by 'ssl.keystore.type'. Default SSL engine factory supports only PEM format with a list of X.509 certificates.

Returns:

the Builder

setKeystoreCertificateChain

public SslConfig.Builder setKeystoreCertificateChain(PasswordConfig keystoreCertificateChain)

Sets the keystore cert chain.

Parameters:

keystoreCertificateChain - Certificate chain in the format specified by 'ssl.keystore.type'. Default SSL engine factory supports only PEM format with a list of X.509 certificates.

Returns:

the Builder

getKeystoreKey

public PasswordConfig getKeystoreKey()

Gets the keystore certificates in form of PEM.

Returns:

the truststore PEM

setKeystoreKey

public SslConfig.Builder setKeystoreKey(PasswordConfig keystoreKey)

Sets the private key in the format specified by 'ssl.keystore.type'. If the key is encrypted, key password must be specified using 'ssl.key.password'

Parameters:

keystoreKey - the keystore certificate pem

Returns:

the Builder

setKeystoreKey

public SslConfig.Builder setKeystoreKey(java.lang.String keystoreKey)

Sets the private key in the format specified by 'ssl.keystore.type'. If the key is encrypted, key password must be specified using 'ssl.key.password'

Parameters:

keystoreKey - the keystore certificate pem

Returns:

the Builder

getTruststorePassword

public PasswordConfig getTruststorePassword()

Gets truststore password.

Returns:

the truststore password

setTruststorePassword

public SslConfig.Builder setTruststorePassword(PasswordConfig truststorePassword)

Sets truststore password.

Parameters:

truststorePassword - the truststore password

Returns:

the Builder

setTruststorePassword

public SslConfig.Builder setTruststorePassword(java.lang.String truststorePassword)

Sets truststore password.

Parameters:

truststorePassword - the truststore password

Returns:

the Builder

getSslProtocol

public java.lang.String getSslProtocol()

Gets SSL protocol.

Returns:

the configured SSL protocol

setSslProtocol

public SslConfig.Builder setSslProtocol(java.lang.String sslProtocol)

Sets configured SSL protocol. Default is "TLS".

Parameters:

sslProtocol - the protocols by the client application's JVM.

Returns:

the SSL protocol

getEnableHostnameVerification

public boolean getEnableHostnameVerification()

Check whether hostname verification is enabled. When so, HTTPS verification is done by the client application to verify that the server has presented a certificate with the right domain or SAN.

Returns:

true if hostname verification is enabled, false otherwise

setEnableHostnameVerification

public SslConfig.Builder setEnableHostnameVerification(boolean enableHostnameVerification)

Sets enable hostname verification.

Parameters:

enableHostnameVerification - the enable hostname verification

Returns:

the Builder

getEnableValidateTruststore

public boolean getEnableValidateTruststore()

Checks whether the validation of expired or not yet valid certification is enabled.

Returns:

true if truststore validation is enabled, false otherwise

setEnableValidateTruststore

public SslConfig.Builder setEnableValidateTruststore(boolean enableValidateTruststore)

Sets enable validate truststore.

Parameters:

enableValidateTruststore - enables truststore validation at startup

Returns:

the Builder

build

public SslConfig build()

Builds and returns an SslConfig.

Returns:

the newly created SslConfig