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.AbstractAWSProcessor<ClientType>

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

Type Parameters:

ClientType - client type

All Implemented Interfaces:

ConfigurableComponent, Processor

Direct Known Subclasses:

AbstractAWSLambdaProcessor, AbstractBaseKinesisProcessor, AbstractDynamoDBProcessor, AbstractS3Processor, AbstractSNSProcessor, AbstractSQSProcessor, MockAWSProcessor, PutCloudWatchMetric

public abstract class AbstractAWSCredentialsProviderProcessor<ClientType extends com.amazonaws.AmazonWebServiceClient>
extends AbstractAWSProcessor<ClientType>

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

See Also:

AWSCredentialsProvider

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	AWS_CREDENTIALS_PROVIDER_SERVICE AWS credentials provider service

Fields inherited from class org.apache.nifi.processors.aws.AbstractAWSProcessor

ACCESS_KEY, client, CREDENTIALS_FILE, DEFAULT_PROTOCOL, DEFAULT_USER_AGENT, ENDPOINT_OVERRIDE, PROXY_HOST, PROXY_HOST_PORT, region, REGION, REL_FAILURE, REL_SUCCESS, relationships, SECRET_KEY, SSL_CONTEXT_SERVICE, TIMEOUT

Constructor Summary

Constructors

Constructor and Description
AbstractAWSCredentialsProviderProcessor()

Method Summary

Modifier and Type	Method and Description
protected abstract ClientType	createClient(ProcessContext context, com.amazonaws.auth.AWSCredentialsProvider credentialsProvider, com.amazonaws.ClientConfiguration config) Abstract method to create aws client using credentials provider.
protected com.amazonaws.auth.AWSCredentialsProvider	getCredentialsProvider(ProcessContext context) Get credentials provider using the AWSCredentialsProviderService
void	onScheduled(ProcessContext context) This method checks if {#link AWS_CREDENTIALS_PROVIDER_SERVICE is available and if it is, uses the credentials provider, otherwise it invokes the AbstractAWSProcessor.onScheduled(ProcessContext) which uses static AWSCredentials for the aws processors
protected void	onScheduledUsingControllerService(ProcessContext context) Create aws client using credentials provider
void	onShutDown()

Methods inherited from class org.apache.nifi.processors.aws.AbstractAWSProcessor

createClient, createConfiguration, customValidate, getClient, getCredentials, getRegion, getRelationships, initializeRegionAndEndpoint, onShutdown

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

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

Field Detail

AWS_CREDENTIALS_PROVIDER_SERVICE

public static final PropertyDescriptor AWS_CREDENTIALS_PROVIDER_SERVICE

AWS credentials provider service

See Also:

AWSCredentialsProvider

Constructor Detail

AbstractAWSCredentialsProviderProcessor

public AbstractAWSCredentialsProviderProcessor()

Method Detail

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)

This method checks if {#link AWS_CREDENTIALS_PROVIDER_SERVICE is available and if it is, uses the credentials provider, otherwise it invokes the AbstractAWSProcessor.onScheduled(ProcessContext) which uses static AWSCredentials for the aws processors

Overrides:

onScheduled in class AbstractAWSProcessor<ClientType extends com.amazonaws.AmazonWebServiceClient>

onScheduledUsingControllerService

protected void onScheduledUsingControllerService(ProcessContext context)

Create aws client using credentials provider

Parameters:

context - the process context

onShutDown

@OnShutdown
public void onShutDown()

getCredentialsProvider

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

Get credentials provider using the AWSCredentialsProviderService

Parameters:

context - the process context

Returns:

AWSCredentialsProvider the credential provider

See Also:

AWSCredentialsProvider

createClient

protected abstract ClientType createClient(ProcessContext context,
                                           com.amazonaws.auth.AWSCredentialsProvider credentialsProvider,
                                           com.amazonaws.ClientConfiguration config)

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