SslConfig.Builder (axual-common 0.0.5 API)

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()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`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.
`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`	`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`	`setTruststoreLocation(java.lang.String truststoreLocation)` 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.
`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)
```
    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.
    
    Parameters:
    
    truststoreLocation - the truststore location
    
    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

Class SslConfig.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

setKeystoreType

getKeystoreType

setTruststoreType

getTruststoreType

getKeyPassword

setKeyPassword

setKeyPassword

getKeystoreLocation

setKeystoreLocation

getKeystorePassword

setKeystorePassword

setKeystorePassword

getTruststoreLocation

setTruststoreLocation

getTruststorePassword

setTruststorePassword

setTruststorePassword

getSslProtocol

setSslProtocol

getEnableHostnameVerification

setEnableHostnameVerification

getEnableValidateTruststore

setEnableValidateTruststore

build