org.apache.nifi.ssl

Interface SSLContextService

All Superinterfaces:

ConfigurableComponent, ControllerService

All Known Subinterfaces:

RestrictedSSLContextService

@Tags(value={"ssl","secure","certificate","keystore","truststore","jks","p12","pkcs12","pkcs"})
 @CapabilityDescription(value="Provides the ability to configure keystore and/or truststore properties once and reuse that configuration throughout the application")
public interface SSLContextService
extends ControllerService

Definition for SSLContextService.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SSLContextService.ClientAuth Deprecated.

Method Summary

Modifier and Type	Method and Description
SSLContext	createContext() Create and initialize SSLContext using configured properties.
SSLContext	createSSLContext(ClientAuth clientAuth) Deprecated. The createContext() method should be used instead
SSLContext	createSSLContext(SSLContextService.ClientAuth clientAuth) Deprecated. The createContext() method should be used instead
TlsConfiguration	createTlsConfiguration()
X509TrustManager	createTrustManager() Create X.509 Trust Manager using configured properties
String	getKeyPassword()
String	getKeyStoreFile()
String	getKeyStorePassword()
String	getKeyStoreType()
String	getSslAlgorithm()
String	getTrustStoreFile()
String	getTrustStorePassword()
String	getTrustStoreType()
boolean	isKeyStoreConfigured()
boolean	isTrustStoreConfigured()

Methods inherited from interface org.apache.nifi.controller.ControllerService

initialize, isStateful

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Method Detail

createTlsConfiguration

TlsConfiguration createTlsConfiguration()

createContext

SSLContext createContext()

Create and initialize SSLContext using configured properties. This method is preferred over deprecated create methods due to not requiring a client authentication policy.

Returns:

SSLContext initialized using configured properties

createSSLContext

@Deprecated
SSLContext createSSLContext(ClientAuth clientAuth)
                                 throws ProcessException

Deprecated. The createContext() method should be used instead

Returns a configured SSLContext from the populated configuration values. This method is deprecated due to ClientAuth not being applicable or used when initializing the SSLContext

Parameters:

clientAuth - the desired level of client authentication

Returns:

the configured SSLContext

Throws:

ProcessException - if there is a problem configuring the context

createSSLContext

@Deprecated
SSLContext createSSLContext(SSLContextService.ClientAuth clientAuth)
                                 throws ProcessException

Deprecated. The createContext() method should be used instead

Returns a configured SSLContext from the populated configuration values. This method is deprecated due to the use of the deprecated SSLContextService.ClientAuth enum and the (createContext()) method is preferred.

Parameters:

clientAuth - the desired level of client authentication

Returns:

the configured SSLContext

Throws:

ProcessException - if there is a problem configuring the context

createTrustManager

X509TrustManager createTrustManager()

Create X.509 Trust Manager using configured properties

Returns:

X509TrustManager initialized using configured properties

getTrustStoreFile

String getTrustStoreFile()

getTrustStoreType

String getTrustStoreType()

getTrustStorePassword

String getTrustStorePassword()

isTrustStoreConfigured

boolean isTrustStoreConfigured()

getKeyStoreFile

String getKeyStoreFile()

getKeyStoreType

String getKeyStoreType()

getKeyStorePassword

String getKeyStorePassword()

getKeyPassword

String getKeyPassword()

isKeyStoreConfigured

boolean isKeyStoreConfigured()

getSslAlgorithm

String getSslAlgorithm()