TlsConfiguration (nifi-security-utils-api 1.15.0 API)

```
public interface TlsConfiguration
```
This interface serves as an immutable domain object (acting as an internal DTO) for the various keystore and truststore configuration settings necessary for building SSLContexts.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`JAVA_11_MAX_SUPPORTED_TLS_PROTOCOL_VERSION`
`static String[]`	`JAVA_11_SUPPORTED_TLS_PROTOCOL_VERSIONS`
`static String`	`JAVA_8_MAX_SUPPORTED_TLS_PROTOCOL_VERSION`
`static String[]`	`JAVA_8_SUPPORTED_TLS_PROTOCOL_VERSIONS`
`static String[]`	`LEGACY_TLS_PROTOCOL_VERSIONS`
`static String`	`SSL_PROTOCOL`
`static String`	`TLS_1_0_PROTOCOL`
`static String`	`TLS_1_1_PROTOCOL`
`static String`	`TLS_1_2_PROTOCOL`
`static String`	`TLS_PROTOCOL`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static String[]`	`getCurrentSupportedTlsProtocolVersions()` Returns a `String[]` of supported TLS protocol versions based on the current Java platform version.
`String[]`	`getEnabledProtocols()` Get Enabled TLS Protocol Versions
`String`	`getFunctionalKeyPassword()` Returns the "working" key password -- if the key password is populated, it is returned; otherwise the `getKeystorePassword()` is returned.
`String`	`getFunctionalKeyPasswordForLogging()` Returns `"********"` if the functional key password is populated, `"null"` if not.
`static String`	`getHighestCurrentSupportedTlsProtocolVersion()` Returns the highest supported TLS protocol version based on the current Java platform version.
`static int`	`getJavaVersion()` Returns the JVM Java major version based on the System properties (e.g.
`String`	`getKeyPassword()`
`String`	`getKeyPasswordForLogging()` Returns `"********"` if the key password is populated, `"null"` if not.
`String`	`getKeystorePassword()`
`String`	`getKeystorePasswordForLogging()` Returns `"********"` if the keystore password is populated, `"null"` if not.
`String`	`getKeystorePath()`
`String[]`	`getKeystorePropertiesForLogging()` Returns a `String[]` containing the keystore properties for logging.
`KeystoreType`	`getKeystoreType()`
`String`	`getProtocol()`
`String`	`getTruststorePassword()`
`String`	`getTruststorePasswordForLogging()` Returns `"********"` if the truststore password is populated, `"null"` if not.
`String`	`getTruststorePath()`
`String[]`	`getTruststorePropertiesForLogging()` Returns a `String[]` containing the truststore properties for logging.
`KeystoreType`	`getTruststoreType()`
`boolean`	`isAnyKeystorePopulated()` Returns `true` if any of the keystore properties is populated, indicating that the caller expects a valid keystore to be generated.
`boolean`	`isAnyTruststorePopulated()` Returns `true` if any of the truststore properties is populated, indicating that the caller expects a valid truststore to be generated.
`static boolean`	`isEmpty(TlsConfiguration tlsConfiguration)` Returns `true` if the provided TlsConfiguration is `null` or empty (i.e.
`boolean`	`isKeystorePopulated()` Returns `true` if the necessary properties are populated to instantiate a keystore.
`boolean`	`isKeystoreValid()` Returns `true` if the necessary properties are populated and the keystore can be successfully instantiated (i.e.
`boolean`	`isTruststorePopulated()` Returns `true` if the necessary properties are populated to instantiate a truststore.
`boolean`	`isTruststoreValid()` Returns `true` if the necessary properties are populated and the truststore can be successfully instantiated (i.e.
`static int`	`parseJavaVersion(String version)` Returns the major version parsed from the provided Java version string (e.g.

- Field Detail
  - SSL_PROTOCOL
```
static final String SSL_PROTOCOL
```
    See Also:
    
    Constant Field Values
  - TLS_PROTOCOL
```
static final String TLS_PROTOCOL
```
    See Also:
    
    Constant Field Values
  - TLS_1_0_PROTOCOL
```
static final String TLS_1_0_PROTOCOL
```
    See Also:
    
    Constant Field Values
  - TLS_1_1_PROTOCOL
```
static final String TLS_1_1_PROTOCOL
```
    See Also:
    
    Constant Field Values
  - TLS_1_2_PROTOCOL
```
static final String TLS_1_2_PROTOCOL
```
    See Also:
    
    Constant Field Values
  - LEGACY_TLS_PROTOCOL_VERSIONS
```
static final String[] LEGACY_TLS_PROTOCOL_VERSIONS
```
  - JAVA_8_MAX_SUPPORTED_TLS_PROTOCOL_VERSION
```
static final String JAVA_8_MAX_SUPPORTED_TLS_PROTOCOL_VERSION
```
    See Also:
    
    Constant Field Values
  - JAVA_11_MAX_SUPPORTED_TLS_PROTOCOL_VERSION
```
static final String JAVA_11_MAX_SUPPORTED_TLS_PROTOCOL_VERSION
```
    See Also:
    
    Constant Field Values
  - JAVA_8_SUPPORTED_TLS_PROTOCOL_VERSIONS
```
static final String[] JAVA_8_SUPPORTED_TLS_PROTOCOL_VERSIONS
```
  - JAVA_11_SUPPORTED_TLS_PROTOCOL_VERSIONS
```
static final String[] JAVA_11_SUPPORTED_TLS_PROTOCOL_VERSIONS
```
- Method Detail
  - isEmpty
```
static boolean isEmpty(TlsConfiguration tlsConfiguration)
```
    Returns true if the provided TlsConfiguration is null or empty (i.e. neither any of the keystore nor truststore properties are populated).
    
    Parameters:
    
    tlsConfiguration - the container object to check
    
    Returns:
    
    true if this container is empty or null
  - getKeystorePath
```
String getKeystorePath()
```
  - getKeystorePassword
```
String getKeystorePassword()
```
  - getKeystorePasswordForLogging
```
String getKeystorePasswordForLogging()
```
    Returns "********" if the keystore password is populated, "null" if not.
    
    Returns:
    
    a loggable String representation of the keystore password
  - getKeyPassword
```
String getKeyPassword()
```
  - getKeyPasswordForLogging
```
String getKeyPasswordForLogging()
```
    Returns "********" if the key password is populated, "null" if not.
    
    Returns:
    
    a loggable String representation of the key password
  - getFunctionalKeyPassword
```
String getFunctionalKeyPassword()
```
    Returns the "working" key password -- if the key password is populated, it is returned; otherwise the getKeystorePassword() is returned.
    
    Returns:
    
    the key or keystore password actually populated
  - getFunctionalKeyPasswordForLogging
```
String getFunctionalKeyPasswordForLogging()
```
    Returns "********" if the functional key password is populated, "null" if not.
    
    Returns:
    
    a loggable String representation of the functional key password
  - getKeystoreType
```
KeystoreType getKeystoreType()
```
  - getTruststorePath
```
String getTruststorePath()
```
  - getTruststorePassword
```
String getTruststorePassword()
```
  - getTruststorePasswordForLogging
```
String getTruststorePasswordForLogging()
```
    Returns "********" if the truststore password is populated, "null" if not.
    
    Returns:
    
    a loggable String representation of the truststore password
  - getTruststoreType
```
KeystoreType getTruststoreType()
```
  - getProtocol
```
String getProtocol()
```
  - isKeystorePopulated
```
boolean isKeystorePopulated()
```
    Returns true if the necessary properties are populated to instantiate a keystore. This does not validate the values (see isKeystoreValid()).
    
    Returns:
    
    true if the path, password, and type are present
  - isAnyKeystorePopulated
```
boolean isAnyKeystorePopulated()
```
    Returns true if any of the keystore properties is populated, indicating that the caller expects a valid keystore to be generated.
    
    Returns:
    
    true if any keystore properties are present
  - isKeystoreValid
```
boolean isKeystoreValid()
```
    Returns true if the necessary properties are populated and the keystore can be successfully instantiated (i.e. the path is valid and the password(s) are correct).
    
    Returns:
    
    true if the keystore properties are valid
  - isTruststorePopulated
```
boolean isTruststorePopulated()
```
    Returns true if the necessary properties are populated to instantiate a truststore. This does not validate the values (see isTruststoreValid()).
    
    Returns:
    
    true if the path, password, and type are present
  - isAnyTruststorePopulated
```
boolean isAnyTruststorePopulated()
```
    Returns true if any of the truststore properties is populated, indicating that the caller expects a valid truststore to be generated.
    
    Returns:
    
    true if any truststore properties are present
  - isTruststoreValid
```
boolean isTruststoreValid()
```
    Returns true if the necessary properties are populated and the truststore can be successfully instantiated (i.e. the path is valid and the password is correct).
    
    Returns:
    
    true if the truststore properties are valid
  - getKeystorePropertiesForLogging
```
String[] getKeystorePropertiesForLogging()
```
    Returns a String[] containing the keystore properties for logging. The order is getKeystorePath(), getKeystorePasswordForLogging(), getFunctionalKeyPasswordForLogging(), getKeystoreType() (using the type or "null").
    
    Returns:
    
    a loggable String[]
  - getTruststorePropertiesForLogging
```
String[] getTruststorePropertiesForLogging()
```
    Returns a String[] containing the truststore properties for logging. The order is getTruststorePath(), getTruststorePasswordForLogging(), getTruststoreType() (using the type or "null").
    
    Returns:
    
    a loggable String[]
  - getEnabledProtocols
```
String[] getEnabledProtocols()
```
    Get Enabled TLS Protocol Versions
    
    Returns:
    
    Enabled TLS Protocols
  - getJavaVersion
```
static int getJavaVersion()
```
    Returns the JVM Java major version based on the System properties (e.g. JVM 1.8.0.231 -> {code 8}).
    
    Returns:
    
    the Java major version
  - parseJavaVersion
```
static int parseJavaVersion(String version)
```
    Returns the major version parsed from the provided Java version string (e.g. "1.8.0.231" -> 8).
    
    Parameters:
    
    version - the Java version string
    
    Returns:
    
    the major version as an int
  - getCurrentSupportedTlsProtocolVersions
```
static String[] getCurrentSupportedTlsProtocolVersions()
```
    Returns a String[] of supported TLS protocol versions based on the current Java platform version.
    
    Returns:
    
    the supported TLS protocol version(s)
  - getHighestCurrentSupportedTlsProtocolVersion
```
static String getHighestCurrentSupportedTlsProtocolVersion()
```
    Returns the highest supported TLS protocol version based on the current Java platform version.
    
    Returns:
    
    the TLS protocol (e.g. "TLSv1.2")

Interface TlsConfiguration

Field Summary

Method Summary

Field Detail

SSL_PROTOCOL

TLS_PROTOCOL

TLS_1_0_PROTOCOL

TLS_1_1_PROTOCOL

TLS_1_2_PROTOCOL

LEGACY_TLS_PROTOCOL_VERSIONS

JAVA_8_MAX_SUPPORTED_TLS_PROTOCOL_VERSION

JAVA_11_MAX_SUPPORTED_TLS_PROTOCOL_VERSION

JAVA_8_SUPPORTED_TLS_PROTOCOL_VERSIONS

JAVA_11_SUPPORTED_TLS_PROTOCOL_VERSIONS

Method Detail

isEmpty

getKeystorePath

getKeystorePassword

getKeystorePasswordForLogging

getKeyPassword

getKeyPasswordForLogging

getFunctionalKeyPassword

getFunctionalKeyPasswordForLogging

getKeystoreType

getTruststorePath

getTruststorePassword

getTruststorePasswordForLogging

getTruststoreType

getProtocol

isKeystorePopulated

isAnyKeystorePopulated

isKeystoreValid

isTruststorePopulated

isAnyTruststorePopulated

isTruststoreValid

getKeystorePropertiesForLogging

getTruststorePropertiesForLogging

getEnabledProtocols

getJavaVersion

parseJavaVersion

getCurrentSupportedTlsProtocolVersions

getHighestCurrentSupportedTlsProtocolVersion