Package org.apache.nifi.processors.aws.s3

Class AbstractS3Processor

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.aws.AbstractAWSCredentialsProviderProcessor<com.amazonaws.services.s3.AmazonS3Client>

org.apache.nifi.processors.aws.s3.AbstractS3Processor

All Implemented Interfaces:

ConfigurableComponent, Processor, VerifiableProcessor

public abstract class AbstractS3Processor
extends AbstractAWSCredentialsProviderProcessor<com.amazonaws.services.s3.AmazonS3Client>

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final AllowableValue	ATTRIBUTE_DEFINED_REGION
static final PropertyDescriptor	BUCKET_WITH_DEFAULT_VALUE
static final PropertyDescriptor	BUCKET_WITHOUT_DEFAULT_VALUE
static final PropertyDescriptor	CANNED_ACL
static final PropertyDescriptor	ENCRYPTION_SERVICE
static final PropertyDescriptor	FULL_CONTROL_USER_LIST
static final PropertyDescriptor	KEY
static final PropertyDescriptor	OWNER
static final PropertyDescriptor	READ_ACL_LIST
static final PropertyDescriptor	READ_USER_LIST
static final PropertyDescriptor	S3_CUSTOM_SIGNER_CLASS_NAME
static final PropertyDescriptor	S3_CUSTOM_SIGNER_MODULE_LOCATION
static final PropertyDescriptor	S3_REGION
static final String	S3_REGION_ATTRIBUTE
static final PropertyDescriptor	SIGNER_OVERRIDE
static final PropertyDescriptor	USE_CHUNKED_ENCODING
static final PropertyDescriptor	USE_PATH_STYLE_ACCESS
static final PropertyDescriptor	WRITE_ACL_LIST
static final PropertyDescriptor	WRITE_USER_LIST

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

AWS_CREDENTIALS_PROVIDER_SERVICE, ENDPOINT_OVERRIDE, PROXY_CONFIGURATION_SERVICE, REGION, REL_FAILURE, REL_SUCCESS, relationships, SSL_CONTEXT_SERVICE, TIMEOUT

Constructor Summary

Constructors

Constructor	Description
AbstractS3Processor()

Method Summary

Modifier and Type	Method	Description
protected final com.amazonaws.services.s3.model.AccessControlList	createACL(ProcessContext context, FlowFile flowFile)	Create AccessControlList if appropriate properties are configured.
protected final com.amazonaws.services.s3.model.CannedAccessControlList	createCannedACL(ProcessContext context, FlowFile flowFile)	Create CannedAccessControlList if CANNED_ACL property specified.
protected com.amazonaws.services.s3.AmazonS3Client	createClient(ProcessContext context, com.amazonaws.auth.AWSCredentialsProvider credentialsProvider, com.amazonaws.regions.Region region, com.amazonaws.ClientConfiguration config, com.amazonaws.client.builder.AwsClientBuilder.EndpointConfiguration endpointConfiguration)	Create client using credentials provider.
protected com.amazonaws.services.s3.AmazonS3Client	createClient(ProcessContext context, Map<String,String> attributes)	Creates the client from the context and FlowFile attributes
protected com.amazonaws.services.s3.model.Grantee	createGrantee(String value)
protected final List<com.amazonaws.services.s3.model.Grantee>	createGrantees(String value)
protected FlowFile	extractExceptionDetails(Exception e, ProcessSession session, FlowFile flowFile)
private static AllowableValue[]	getAvailableS3Regions()
protected com.amazonaws.services.s3.AmazonS3Client	getS3Client(ProcessContext context, Map<String,String> attributes)	Creates and configures the client from the context and FlowFile attributes or returns an existing client from cache
private void	initializeSignerOverride(ProcessContext context, com.amazonaws.ClientConfiguration config)
private boolean	isAttributeDefinedRegion(ProcessContext context)
void	onScheduled(ProcessContext context)
private com.amazonaws.regions.Region	parseRegionValue(String regionValue)
private FlowFile	putAttribute(ProcessSession session, FlowFile flowFile, String key, Object value)
private com.amazonaws.regions.Region	resolveRegion(ProcessContext context, Map<String,String> attributes)
List<ConfigVerificationResult>	verify(ProcessContext context, ComponentLog verificationLogger, Map<String,String> attributes)

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

createAllowableValue, createClient, createClient, createConfiguration, createConfiguration, getAvailableRegions, getClient, getClient, getCredentialsProvider, getEndpointConfiguration, getRegion, getRelationships, migrateProperties, onStopped

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

FULL_CONTROL_USER_LIST

public static final PropertyDescriptor FULL_CONTROL_USER_LIST

READ_USER_LIST

public static final PropertyDescriptor READ_USER_LIST

WRITE_USER_LIST

public static final PropertyDescriptor WRITE_USER_LIST

READ_ACL_LIST

public static final PropertyDescriptor READ_ACL_LIST

WRITE_ACL_LIST

public static final PropertyDescriptor WRITE_ACL_LIST

CANNED_ACL

public static final PropertyDescriptor CANNED_ACL

OWNER

public static final PropertyDescriptor OWNER

BUCKET_WITHOUT_DEFAULT_VALUE

public static final PropertyDescriptor BUCKET_WITHOUT_DEFAULT_VALUE

BUCKET_WITH_DEFAULT_VALUE

public static final PropertyDescriptor BUCKET_WITH_DEFAULT_VALUE

KEY

public static final PropertyDescriptor KEY

SIGNER_OVERRIDE

public static final PropertyDescriptor SIGNER_OVERRIDE

S3_CUSTOM_SIGNER_CLASS_NAME

public static final PropertyDescriptor S3_CUSTOM_SIGNER_CLASS_NAME

S3_CUSTOM_SIGNER_MODULE_LOCATION

public static final PropertyDescriptor S3_CUSTOM_SIGNER_MODULE_LOCATION

S3_REGION_ATTRIBUTE

public static final String S3_REGION_ATTRIBUTE

See Also:

• Constant Field Values

ATTRIBUTE_DEFINED_REGION

static final AllowableValue ATTRIBUTE_DEFINED_REGION

S3_REGION

public static final PropertyDescriptor S3_REGION

ENCRYPTION_SERVICE

public static final PropertyDescriptor ENCRYPTION_SERVICE

USE_CHUNKED_ENCODING

public static final PropertyDescriptor USE_CHUNKED_ENCODING

USE_PATH_STYLE_ACCESS

public static final PropertyDescriptor USE_PATH_STYLE_ACCESS

Constructor Details

AbstractS3Processor

public AbstractS3Processor()

Method Details

createClient

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

Create client using credentials provider. This is the preferred way for creating clients

Specified by:

createClient in class AbstractAWSCredentialsProviderProcessor<com.amazonaws.services.s3.AmazonS3Client>

Parameters:

context - process context

credentialsProvider - AWS credentials provider

config - AWS client configuration

Returns:

ClientType the client

verify

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

Specified by:

verify in interface VerifiableProcessor

Overrides:

verify in class AbstractAWSCredentialsProviderProcessor<com.amazonaws.services.s3.AmazonS3Client>

getS3Client

protected com.amazonaws.services.s3.AmazonS3Client getS3Client(ProcessContext context,
 Map<String,String> attributes)

Creates and configures the client from the context and FlowFile attributes or returns an existing client from cache

Parameters:

context - the process context

attributes - FlowFile attributes

Returns:

The created S3 client

createClient

protected com.amazonaws.services.s3.AmazonS3Client createClient(ProcessContext context,
 Map<String,String> attributes)

Creates the client from the context and FlowFile attributes

Parameters:

context - the process context

attributes - FlowFile attributes

Returns:

The newly created S3 client

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)

Overrides:

onScheduled in class AbstractAWSCredentialsProviderProcessor<com.amazonaws.services.s3.AmazonS3Client>

initializeSignerOverride

private void initializeSignerOverride(ProcessContext context,
 com.amazonaws.ClientConfiguration config)

createGrantee

protected com.amazonaws.services.s3.model.Grantee createGrantee(String value)

createGrantees

protected final List<com.amazonaws.services.s3.model.Grantee> createGrantees(String value)

createACL

protected final com.amazonaws.services.s3.model.AccessControlList createACL(ProcessContext context,
 FlowFile flowFile)

Create AccessControlList if appropriate properties are configured.

Parameters:

context - ProcessContext

flowFile - FlowFile

Returns:

AccessControlList or null if no ACL properties were specified

extractExceptionDetails

protected FlowFile extractExceptionDetails(Exception e,
 ProcessSession session,
 FlowFile flowFile)

putAttribute

private FlowFile putAttribute(ProcessSession session,
 FlowFile flowFile,
 String key,
 Object value)

createCannedACL

protected final com.amazonaws.services.s3.model.CannedAccessControlList createCannedACL(ProcessContext context,
 FlowFile flowFile)

Create CannedAccessControlList if CANNED_ACL property specified.

Parameters:

context - ProcessContext

flowFile - FlowFile

Returns:

CannedAccessControlList or null if not specified

parseRegionValue

private com.amazonaws.regions.Region parseRegionValue(String regionValue)

resolveRegion

private com.amazonaws.regions.Region resolveRegion(ProcessContext context,
 Map<String,String> attributes)

isAttributeDefinedRegion

private boolean isAttributeDefinedRegion(ProcessContext context)

getAvailableS3Regions

private static AllowableValue[] getAvailableS3Regions()