Package org.apache.nifi.processors.aws

Class AbstractAWSCredentialsProviderProcessor<ClientType extends com.amazonaws.AmazonWebServiceClient>

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.aws.AbstractAWSCredentialsProviderProcessor<ClientType>

Type Parameters:

ClientType - client type

All Implemented Interfaces:

ConfigurableComponent, Processor, VerifiableProcessor

Direct Known Subclasses:

AbstractAWSGatewayApiProcessor, AbstractS3Processor

public abstract class AbstractAWSCredentialsProviderProcessor<ClientType extends com.amazonaws.AmazonWebServiceClient>
extends AbstractProcessor
implements VerifiableProcessor

Base class for AWS processors that uses AWSCredentialsProvider interface for creating AWS clients.

See Also:

• AWSCredentialsProvider

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	AUTH_SERVICE_ACCESS_KEY
private static final String	AUTH_SERVICE_CREDENTIALS_FILE
private static final String	AUTH_SERVICE_DEFAULT_CREDENTIALS
private static final String	AUTH_SERVICE_SECRET_KEY
static final PropertyDescriptor	AWS_CREDENTIALS_PROVIDER_SERVICE
private final com.github.benmanes.caffeine.cache.Cache<String,ClientType>	clientCache
private static final String	CREDENTIALS_SERVICE_CLASSNAME
static final PropertyDescriptor	ENDPOINT_OVERRIDE
private static final String	OBSOLETE_ACCESS_KEY
private static final String	OBSOLETE_CREDENTIALS_FILE
private static final String	OBSOLETE_PROXY_HOST
private static final String	OBSOLETE_PROXY_PASSWORD
private static final String	OBSOLETE_PROXY_PORT
private static final String	OBSOLETE_PROXY_USERNAME
private static final String	OBSOLETE_SECRET_KEY
static final PropertyDescriptor	PROXY_CONFIGURATION_SERVICE
private static final String	PROXY_SERVICE_CLASSNAME
private static final String	PROXY_SERVICE_HOST
private static final String	PROXY_SERVICE_PASSWORD
private static final String	PROXY_SERVICE_PORT
private static final String	PROXY_SERVICE_TYPE
private static final String	PROXY_SERVICE_USERNAME
static final PropertyDescriptor	REGION
static final Relationship	REL_FAILURE
static final Relationship	REL_SUCCESS
static final Set<Relationship>	relationships
static final PropertyDescriptor	SSL_CONTEXT_SERVICE
static final PropertyDescriptor	TIMEOUT

Constructor Summary

Constructors

Constructor	Description
AbstractAWSCredentialsProviderProcessor()

Method Summary

Modifier and Type	Method	Description
static AllowableValue	createAllowableValue(com.amazonaws.regions.Regions region)
protected ClientType	createClient(ProcessContext context)
protected abstract ClientType	createClient(ProcessContext context, com.amazonaws.auth.AWSCredentialsProvider credentialsProvider, com.amazonaws.regions.Region region, com.amazonaws.ClientConfiguration config, com.amazonaws.client.builder.AwsClientBuilder.EndpointConfiguration endpointConfiguration)	Abstract method to create AWS client using credentials provider.
ClientType	createClient(ProcessContext context, com.amazonaws.regions.Region region)	Attempts to create the client using the controller service first before falling back to the standard configuration.
protected com.amazonaws.ClientConfiguration	createConfiguration(PropertyContext context, int maxConcurrentTasks)
protected com.amazonaws.ClientConfiguration	createConfiguration(ProcessContext context)
static AllowableValue[]	getAvailableRegions()
protected ClientType	getClient(ProcessContext context)
protected ClientType	getClient(ProcessContext context, com.amazonaws.regions.Region region)	Creates an AWS service client from the context or returns an existing client from the cache
protected com.amazonaws.auth.AWSCredentialsProvider	getCredentialsProvider(ProcessContext context)
protected com.amazonaws.client.builder.AwsClientBuilder.EndpointConfiguration	getEndpointConfiguration(ProcessContext context, com.amazonaws.regions.Region region)
protected com.amazonaws.regions.Region	getRegion(ProcessContext context)
Set<Relationship>	getRelationships()
private void	migrateAuthenticationProperties(PropertyConfiguration config)
void	migrateProperties(PropertyConfiguration config)
private void	migrateProxyProperties(PropertyConfiguration config)
void	onScheduled(ProcessContext context)
void	onStopped()
List<ConfigVerificationResult>	verify(ProcessContext context, ComponentLog verificationLogger, Map<String,String> attributes)

Methods inherited from class org.apache.nifi.processor.AbstractProcessor

onTrigger, onTrigger

Methods inherited from class org.apache.nifi.processor.AbstractSessionFactoryProcessor

getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, init, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

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

customValidate, equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, getSupportedPropertyDescriptors, 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.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Methods inherited from interface org.apache.nifi.processor.Processor

isStateful, migrateRelationships

Field Details

CREDENTIALS_SERVICE_CLASSNAME

private static final String CREDENTIALS_SERVICE_CLASSNAME

See Also:

• Constant Field Values

PROXY_SERVICE_CLASSNAME

private static final String PROXY_SERVICE_CLASSNAME

See Also:

• Constant Field Values

OBSOLETE_ACCESS_KEY

private static final String OBSOLETE_ACCESS_KEY

See Also:

• Constant Field Values

OBSOLETE_SECRET_KEY

private static final String OBSOLETE_SECRET_KEY

See Also:

• Constant Field Values

OBSOLETE_CREDENTIALS_FILE

private static final String OBSOLETE_CREDENTIALS_FILE

See Also:

• Constant Field Values

OBSOLETE_PROXY_HOST

private static final String OBSOLETE_PROXY_HOST

See Also:

• Constant Field Values

OBSOLETE_PROXY_PORT

private static final String OBSOLETE_PROXY_PORT

See Also:

• Constant Field Values

OBSOLETE_PROXY_USERNAME

private static final String OBSOLETE_PROXY_USERNAME

See Also:

• Constant Field Values

OBSOLETE_PROXY_PASSWORD

private static final String OBSOLETE_PROXY_PASSWORD

See Also:

• Constant Field Values

AUTH_SERVICE_ACCESS_KEY

private static final String AUTH_SERVICE_ACCESS_KEY

See Also:

• Constant Field Values

AUTH_SERVICE_SECRET_KEY

private static final String AUTH_SERVICE_SECRET_KEY

See Also:

• Constant Field Values

AUTH_SERVICE_CREDENTIALS_FILE

private static final String AUTH_SERVICE_CREDENTIALS_FILE

See Also:

• Constant Field Values

AUTH_SERVICE_DEFAULT_CREDENTIALS

private static final String AUTH_SERVICE_DEFAULT_CREDENTIALS

See Also:

• Constant Field Values

PROXY_SERVICE_HOST

private static final String PROXY_SERVICE_HOST

See Also:

• Constant Field Values

PROXY_SERVICE_PORT

private static final String PROXY_SERVICE_PORT

See Also:

• Constant Field Values

PROXY_SERVICE_USERNAME

private static final String PROXY_SERVICE_USERNAME

See Also:

• Constant Field Values

PROXY_SERVICE_PASSWORD

private static final String PROXY_SERVICE_PASSWORD

See Also:

• Constant Field Values

PROXY_SERVICE_TYPE

private static final String PROXY_SERVICE_TYPE

See Also:

• Constant Field Values

REGION

public static final PropertyDescriptor REGION

TIMEOUT

public static final PropertyDescriptor TIMEOUT

SSL_CONTEXT_SERVICE

public static final PropertyDescriptor SSL_CONTEXT_SERVICE

ENDPOINT_OVERRIDE

public static final PropertyDescriptor ENDPOINT_OVERRIDE

AWS_CREDENTIALS_PROVIDER_SERVICE

public static final PropertyDescriptor AWS_CREDENTIALS_PROVIDER_SERVICE

PROXY_CONFIGURATION_SERVICE

public static final PropertyDescriptor PROXY_CONFIGURATION_SERVICE

REL_SUCCESS

public static final Relationship REL_SUCCESS

REL_FAILURE

public static final Relationship REL_FAILURE

relationships

public static final Set<Relationship> relationships

clientCache

private final com.github.benmanes.caffeine.cache.Cache<String,ClientType extends com.amazonaws.AmazonWebServiceClient> clientCache

Constructor Details

AbstractAWSCredentialsProviderProcessor

public AbstractAWSCredentialsProviderProcessor()

Method Details

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)

onStopped

@OnStopped
public void onStopped()

createAllowableValue

public static AllowableValue createAllowableValue(com.amazonaws.regions.Regions region)

getAvailableRegions

public static AllowableValue[] getAvailableRegions()

migrateProperties

public void migrateProperties(PropertyConfiguration config)

Specified by:

migrateProperties in interface Processor

migrateAuthenticationProperties

private void migrateAuthenticationProperties(PropertyConfiguration config)

migrateProxyProperties

private void migrateProxyProperties(PropertyConfiguration config)

createConfiguration

protected com.amazonaws.ClientConfiguration createConfiguration(ProcessContext context)

createConfiguration

protected com.amazonaws.ClientConfiguration createConfiguration(PropertyContext context,
 int maxConcurrentTasks)

createClient

protected ClientType createClient(ProcessContext context)

createClient

public ClientType createClient(ProcessContext context,
 com.amazonaws.regions.Region region)

Attempts to create the client using the controller service first before falling back to the standard configuration.

Parameters:

context - The process context

Returns:

The created client

getEndpointConfiguration

protected com.amazonaws.client.builder.AwsClientBuilder.EndpointConfiguration getEndpointConfiguration(ProcessContext context,
 com.amazonaws.regions.Region region)

verify

public List<ConfigVerificationResult> verify(ProcessContext context,
 ComponentLog verificationLogger,
 Map<String,String> attributes)

Specified by:

verify in interface VerifiableProcessor

getCredentialsProvider

protected com.amazonaws.auth.AWSCredentialsProvider getCredentialsProvider(ProcessContext context)

getRegion

protected com.amazonaws.regions.Region getRegion(ProcessContext context)

getClient

protected ClientType getClient(ProcessContext context,
 com.amazonaws.regions.Region region)

Creates an AWS service client from the context or returns an existing client from the cache

getClient

protected ClientType getClient(ProcessContext context)

createClient

protected abstract ClientType createClient(ProcessContext context,
 com.amazonaws.auth.AWSCredentialsProvider credentialsProvider,
 com.amazonaws.regions.Region region,
 com.amazonaws.ClientConfiguration config,
 com.amazonaws.client.builder.AwsClientBuilder.EndpointConfiguration endpointConfiguration)

Abstract method to create AWS client using credentials provider. This is the preferred method for creating AWS clients

Parameters:

context - process context

credentialsProvider - AWS credentials provider

config - AWS client configuration

Returns:

ClientType the client