org.apache.nifi.ssl

Class StandardSSLContextService

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.ssl.StandardSSLContextService

All Implemented Interfaces:

ConfigurableComponent, ControllerService, SSLContextService

@Tags(value={"ssl","secure","certificate","keystore","truststore","jks","p12","pkcs12","pkcs"})
 @CapabilityDescription(value="Standard implementation of the SSLContextService. Provides the ability to configure keystore and/or truststore properties once and reuse that configuration throughout the application")
public class StandardSSLContextService
extends AbstractControllerService
implements SSLContextService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StandardSSLContextService.KeystoreValidationGroup

Nested classes/interfaces inherited from interface org.apache.nifi.ssl.SSLContextService

SSLContextService.ClientAuth

Field Summary

Fields

Modifier and Type	Field and Description
private ConfigurationContext	configContext
static PropertyDescriptor	KEYSTORE
static PropertyDescriptor	KEYSTORE_PASSWORD
static PropertyDescriptor	KEYSTORE_TYPE
private static List<PropertyDescriptor>	properties
static PropertyDescriptor	SSL_ALGORITHM
static String	STORE_TYPE_JKS
static String	STORE_TYPE_PKCS12
static PropertyDescriptor	TRUSTSTORE
static PropertyDescriptor	TRUSTSTORE_PASSWORD
static PropertyDescriptor	TRUSTSTORE_TYPE

Constructor Summary

Constructors

Constructor and Description
StandardSSLContextService()

Method Summary

Modifier and Type	Method and Description
private static AllowableValue[]	buildAlgorithmAllowableValues()
private static int	countNulls(Object... objects)
private static Validator	createFileExistsAndReadableValidator()
SSLContext	createSSLContext(SSLContextService.ClientAuth clientAuth)
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
String	getKeyStoreFile()
String	getKeyStorePassword()
String	getKeyStoreType()
String	getSslAlgorithm()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
String	getTrustStoreFile()
String	getTrustStorePassword()
String	getTrustStoreType()
boolean	isKeyStoreConfigured()
boolean	isTrustStoreConfigured()
void	onConfigured(ConfigurationContext context)
String	toString()
private static Collection<ValidationResult>	validateStore(Map<PropertyDescriptor,String> properties, StandardSSLContextService.KeystoreValidationGroup keyStoreOrTrustStore)
private void	verifySslConfig(ValidationContext validationContext)

Methods inherited from class org.apache.nifi.controller.AbstractControllerService

getControllerServiceLookup, getIdentifier, getLogger, getProperties, getProperty, init, initialize, onConfigurationChange

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, onPropertyModified, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

initialize

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

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

STORE_TYPE_JKS

public static final String STORE_TYPE_JKS

See Also:

Constant Field Values

STORE_TYPE_PKCS12

public static final String STORE_TYPE_PKCS12

See Also:

Constant Field Values

TRUSTSTORE

public static final PropertyDescriptor TRUSTSTORE

TRUSTSTORE_TYPE

public static final PropertyDescriptor TRUSTSTORE_TYPE

TRUSTSTORE_PASSWORD

public static final PropertyDescriptor TRUSTSTORE_PASSWORD

KEYSTORE

public static final PropertyDescriptor KEYSTORE

KEYSTORE_TYPE

public static final PropertyDescriptor KEYSTORE_TYPE

KEYSTORE_PASSWORD

public static final PropertyDescriptor KEYSTORE_PASSWORD

SSL_ALGORITHM

public static final PropertyDescriptor SSL_ALGORITHM

properties

private static final List<PropertyDescriptor> properties

configContext

private ConfigurationContext configContext

Constructor Detail

StandardSSLContextService

public StandardSSLContextService()

Method Detail

onConfigured

@OnEnabled
public void onConfigured(ConfigurationContext context)
                             throws InitializationException

Throws:

InitializationException

createFileExistsAndReadableValidator

private static Validator createFileExistsAndReadableValidator()

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

verifySslConfig

private void verifySslConfig(ValidationContext validationContext)
                      throws ProcessException

Throws:

ProcessException

createSSLContext

public SSLContext createSSLContext(SSLContextService.ClientAuth clientAuth)
                            throws ProcessException

Specified by:

createSSLContext in interface SSLContextService

Throws:

ProcessException

getTrustStoreFile

public String getTrustStoreFile()

Specified by:

getTrustStoreFile in interface SSLContextService

getTrustStoreType

public String getTrustStoreType()

Specified by:

getTrustStoreType in interface SSLContextService

getTrustStorePassword

public String getTrustStorePassword()

Specified by:

getTrustStorePassword in interface SSLContextService

isTrustStoreConfigured

public boolean isTrustStoreConfigured()

Specified by:

isTrustStoreConfigured in interface SSLContextService

getKeyStoreFile

public String getKeyStoreFile()

Specified by:

getKeyStoreFile in interface SSLContextService

getKeyStoreType

public String getKeyStoreType()

Specified by:

getKeyStoreType in interface SSLContextService

getKeyStorePassword

public String getKeyStorePassword()

Specified by:

getKeyStorePassword in interface SSLContextService

isKeyStoreConfigured

public boolean isKeyStoreConfigured()

Specified by:

isKeyStoreConfigured in interface SSLContextService

getSslAlgorithm

public String getSslAlgorithm()

Specified by:

getSslAlgorithm in interface SSLContextService

validateStore

private static Collection<ValidationResult> validateStore(Map<PropertyDescriptor,String> properties,
                                                          StandardSSLContextService.KeystoreValidationGroup keyStoreOrTrustStore)

countNulls

private static int countNulls(Object... objects)

buildAlgorithmAllowableValues

private static AllowableValue[] buildAlgorithmAllowableValues()

toString

public String toString()

Overrides:

toString in class AbstractConfigurableComponent