Package org.apache.nifi.processors.aws.v2

Class AbstractAwsProcessor<T extends software.amazon.awssdk.core.SdkClient>

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processors.aws.v2.AbstractAwsProcessor<T>

Type Parameters:

T - client type

All Implemented Interfaces:

ConfigurableComponent, Processor, VerifiableProcessor

Direct Known Subclasses:

AbstractAwsAsyncProcessor, AbstractAwsSyncProcessor

public abstract class AbstractAwsProcessor<T extends software.amazon.awssdk.core.SdkClient>
extends AbstractSessionFactoryProcessor
implements VerifiableProcessor

Base class for aws processors using the AWS v2 SDK.

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<software.amazon.awssdk.regions.Region,T>	clientCache
private static final String	CREDENTIALS_SERVICE_CLASSNAME
protected static final String	DEFAULT_USER_AGENT
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
private static final Set<Relationship>	relationships
static final PropertyDescriptor	SSL_CONTEXT_SERVICE
static final PropertyDescriptor	TIMEOUT

Constructor Summary

Constructors

Constructor	Description
AbstractAwsProcessor()

Method Summary

Modifier and Type	Method	Description
protected <C extends software.amazon.awssdk.core.SdkClient, B extends software.amazon.awssdk.awscore.client.builder.AwsClientBuilder<B, C>> void	configureClientBuilder(B clientBuilder, software.amazon.awssdk.regions.Region region, ProcessContext context)
protected <C extends software.amazon.awssdk.core.SdkClient, B extends software.amazon.awssdk.awscore.client.builder.AwsClientBuilder<B, C>> void	configureClientBuilder(B clientBuilder, software.amazon.awssdk.regions.Region region, ProcessContext context, PropertyDescriptor endpointOverrideDescriptor)
protected void	configureEndpoint(ProcessContext context, software.amazon.awssdk.core.client.builder.SdkClientBuilder<?,?> clientBuilder, PropertyDescriptor endpointOverrideDescriptor)
protected abstract <B extends software.amazon.awssdk.awscore.client.builder.AwsClientBuilder> void	configureHttpClient(B clientBuilder, ProcessContext context)	Configure the http client on the builder.
protected void	configureSdkHttpClient(ProcessContext context, AwsHttpClientConfigurer httpClientConfigurer)
protected T	createClient(ProcessContext context)
protected abstract T	createClient(ProcessContext context, software.amazon.awssdk.regions.Region region)	Creates an AWS client using process context and AWS client details.
protected T	getClient(ProcessContext context)
protected T	getClient(ProcessContext context, software.amazon.awssdk.regions.Region region)	Creates an AWS service client from the context or returns an existing client from the cache
protected software.amazon.awssdk.auth.credentials.AwsCredentialsProvider	getCredentialsProvider(ProcessContext context)	Get credentials provider using the AwsCredentialsProvider
protected software.amazon.awssdk.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()
abstract void	onTrigger(ProcessContext context, ProcessSession session)
void	onTrigger(ProcessContext context, ProcessSessionFactory sessionFactory)
List<ConfigVerificationResult>	verify(ProcessContext context, ComponentLog verificationLogger, Map<String,String> attributes)

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

REL_SUCCESS

public static final Relationship REL_SUCCESS

REL_FAILURE

public static final Relationship REL_FAILURE

relationships

private static final Set<Relationship> relationships

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

DEFAULT_USER_AGENT

protected static final String DEFAULT_USER_AGENT

See Also:

• Constant Field Values

clientCache

private final com.github.benmanes.caffeine.cache.Cache<software.amazon.awssdk.regions.Region,T extends software.amazon.awssdk.core.SdkClient> clientCache

Constructor Details

AbstractAwsProcessor

public AbstractAwsProcessor()

Method Details

configureHttpClient

protected abstract <B extends software.amazon.awssdk.awscore.client.builder.AwsClientBuilder>
void configureHttpClient(B clientBuilder,
 ProcessContext context)

Configure the http client on the builder.

Type Parameters:

B - The builder type

Parameters:

clientBuilder - The client builder

context - The process context

onTrigger

public void onTrigger(ProcessContext context,
 ProcessSessionFactory sessionFactory)
               throws ProcessException

Specified by:

onTrigger in interface Processor

Throws:

ProcessException

onTrigger

public abstract void onTrigger(ProcessContext context,
 ProcessSession session)
                        throws ProcessException

Throws:

ProcessException

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

migrateProperties

public void migrateProperties(PropertyConfiguration config)

Specified by:

migrateProperties in interface Processor

migrateAuthenticationProperties

private void migrateAuthenticationProperties(PropertyConfiguration config)

migrateProxyProperties

private void migrateProxyProperties(PropertyConfiguration config)

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)

onStopped

@OnStopped
public void onStopped()

verify

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

Specified by:

verify in interface VerifiableProcessor

getClient

protected T getClient(ProcessContext context,
 software.amazon.awssdk.regions.Region region)

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

Returns:

The created or cached client

getClient

protected T getClient(ProcessContext context)

configureClientBuilder

protected <C extends software.amazon.awssdk.core.SdkClient,
B extends software.amazon.awssdk.awscore.client.builder.AwsClientBuilder<B,
C>>
void configureClientBuilder(B clientBuilder,
 software.amazon.awssdk.regions.Region region,
 ProcessContext context)

configureClientBuilder

protected <C extends software.amazon.awssdk.core.SdkClient,
B extends software.amazon.awssdk.awscore.client.builder.AwsClientBuilder<B,
C>>
void configureClientBuilder(B clientBuilder,
 software.amazon.awssdk.regions.Region region,
 ProcessContext context,
 PropertyDescriptor endpointOverrideDescriptor)

configureSdkHttpClient

protected void configureSdkHttpClient(ProcessContext context,
 AwsHttpClientConfigurer httpClientConfigurer)

getRegion

protected software.amazon.awssdk.regions.Region getRegion(ProcessContext context)

configureEndpoint

protected void configureEndpoint(ProcessContext context,
 software.amazon.awssdk.core.client.builder.SdkClientBuilder<?,?> clientBuilder,
 PropertyDescriptor endpointOverrideDescriptor)

getCredentialsProvider

protected software.amazon.awssdk.auth.credentials.AwsCredentialsProvider getCredentialsProvider(ProcessContext context)

Get credentials provider using the AwsCredentialsProvider

Parameters:

context - the process context

Returns:

AwsCredentialsProvider the credential provider

createClient

protected T createClient(ProcessContext context)

createClient

protected abstract T createClient(ProcessContext context,
 software.amazon.awssdk.regions.Region region)

Creates an AWS client using process context and AWS client details.

Parameters:

context - process context

region - the AWS Region

Returns:

AWS client