Package org.apache.nifi.processors.aws.dynamodb

Class AbstractDynamoDBProcessor

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processors.aws.v2.AbstractAwsProcessor<software.amazon.awssdk.services.dynamodb.DynamoDbClient>

org.apache.nifi.processors.aws.v2.AbstractAwsSyncProcessor<software.amazon.awssdk.services.dynamodb.DynamoDbClient,software.amazon.awssdk.services.dynamodb.DynamoDbClientBuilder>

org.apache.nifi.processors.aws.dynamodb.AbstractDynamoDBProcessor

All Implemented Interfaces:

ConfigurableComponent, Processor, VerifiableProcessor

public abstract class AbstractDynamoDBProcessor
extends AbstractAwsSyncProcessor<software.amazon.awssdk.services.dynamodb.DynamoDbClient,software.amazon.awssdk.services.dynamodb.DynamoDbClientBuilder>

Base class for NiFi dynamo db related processors

Field Summary

Fields

Modifier and Type	Field	Description
static final AllowableValue	ALLOWABLE_VALUE_NUMBER
static final AllowableValue	ALLOWABLE_VALUE_STRING
static final String	AWS_DYNAMO_DB_ITEM_SIZE_ERROR
static final PropertyDescriptor	BATCH_SIZE
static final PropertyDescriptor	DOCUMENT_CHARSET
static final String	DYNAMODB_ERROR_CODE
static final String	DYNAMODB_ERROR_EXCEPTION_MESSAGE
static final String	DYNAMODB_ERROR_MESSAGE
static final String	DYNAMODB_ERROR_REQUEST_ID
static final String	DYNAMODB_ERROR_RETRYABLE
static final String	DYNAMODB_ERROR_SERVICE
static final String	DYNAMODB_ERROR_STATUS_CODE
static final String	DYNAMODB_HASH_KEY_VALUE_ERROR
static final String	DYNAMODB_ITEM_HASH_KEY_VALUE
static final String	DYNAMODB_ITEM_IO_ERROR
static final String	DYNAMODB_ITEM_RANGE_KEY_VALUE
static final String	DYNAMODB_KEY_ERROR_NOT_FOUND
protected static final String	DYNAMODB_KEY_ERROR_NOT_FOUND_MESSAGE
static final String	DYNAMODB_KEY_ERROR_UNPROCESSED
static final String	DYNAMODB_RANGE_KEY_VALUE_ERROR
static final Set<Relationship>	dynamoDBrelationships
static final PropertyDescriptor	HASH_KEY_NAME
static final PropertyDescriptor	HASH_KEY_VALUE
static final PropertyDescriptor	HASH_KEY_VALUE_TYPE
static final PropertyDescriptor	JSON_DOCUMENT
static final PropertyDescriptor	RANGE_KEY_NAME
static final PropertyDescriptor	RANGE_KEY_VALUE
static final PropertyDescriptor	RANGE_KEY_VALUE_TYPE
static final Relationship	REL_UNPROCESSED
static final PropertyDescriptor	TABLE

Fields inherited from class org.apache.nifi.processors.aws.v2.AbstractAwsProcessor

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

Constructor Summary

Constructors

Constructor	Description
AbstractDynamoDBProcessor()

Method Summary

Modifier and Type	Method	Description
protected software.amazon.awssdk.services.dynamodb.DynamoDbClientBuilder	createClientBuilder(ProcessContext context)	Construct the AWS SDK client builder and perform any service-specific configuration of the builder.
protected software.amazon.awssdk.services.dynamodb.model.AttributeValue	getAttributeValue(ProcessContext context, PropertyDescriptor type, PropertyDescriptor value, Map<String,String> attributes)
Set<Relationship>	getRelationships()
protected static boolean	isBlank(software.amazon.awssdk.services.dynamodb.model.AttributeValue attributeValue)
protected boolean	isHashKeyValueConsistent(String hashKeyName, software.amazon.awssdk.services.dynamodb.model.AttributeValue hashKeyValue, ProcessSession session, FlowFile flowFile)
protected boolean	isRangeKeyValueConsistent(String rangeKeyName, software.amazon.awssdk.services.dynamodb.model.AttributeValue rangeKeyValue, ProcessSession session, FlowFile flowFile)
protected List<FlowFile>	processException(ProcessSession session, List<FlowFile> flowFiles, Exception exception)
protected List<FlowFile>	processSdkException(ProcessSession session, List<FlowFile> flowFiles, software.amazon.awssdk.core.exception.SdkException exception)
protected List<FlowFile>	processServiceException(ProcessSession session, List<FlowFile> flowFiles, software.amazon.awssdk.awscore.exception.AwsServiceException exception)
protected void	sendUnprocessedToUnprocessedRelationship(ProcessSession session, Map<ItemKeys,FlowFile> keysToFlowFileMap, software.amazon.awssdk.services.dynamodb.model.AttributeValue hashKeyValue, software.amazon.awssdk.services.dynamodb.model.AttributeValue rangeKeyValue)	Send unhandled items to failure and remove the flow files from key to flow file map
protected void	validateHashKeyValue(software.amazon.awssdk.services.dynamodb.model.AttributeValue hashKeyValue)
protected void	validateRangeKeyValue(String rangeKeyName, software.amazon.awssdk.services.dynamodb.model.AttributeValue rangeKeyValue)

Methods inherited from class org.apache.nifi.processors.aws.v2.AbstractAwsSyncProcessor

configureHttpClient, createClient, createClient

Methods inherited from class org.apache.nifi.processors.aws.v2.AbstractAwsProcessor

configureClientBuilder, configureClientBuilder, configureEndpoint, configureSdkHttpClient, getClient, getClient, getCredentialsProvider, getRegion, migrateProperties, onScheduled, onStopped, onTrigger, onTrigger, verify

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

REL_UNPROCESSED

public static final Relationship REL_UNPROCESSED

ALLOWABLE_VALUE_STRING

public static final AllowableValue ALLOWABLE_VALUE_STRING

ALLOWABLE_VALUE_NUMBER

public static final AllowableValue ALLOWABLE_VALUE_NUMBER

DYNAMODB_KEY_ERROR_UNPROCESSED

public static final String DYNAMODB_KEY_ERROR_UNPROCESSED

See Also:

• Constant Field Values

DYNAMODB_RANGE_KEY_VALUE_ERROR

public static final String DYNAMODB_RANGE_KEY_VALUE_ERROR

See Also:

• Constant Field Values

DYNAMODB_HASH_KEY_VALUE_ERROR

public static final String DYNAMODB_HASH_KEY_VALUE_ERROR

See Also:

• Constant Field Values

DYNAMODB_KEY_ERROR_NOT_FOUND

public static final String DYNAMODB_KEY_ERROR_NOT_FOUND

See Also:

• Constant Field Values

DYNAMODB_ERROR_EXCEPTION_MESSAGE

public static final String DYNAMODB_ERROR_EXCEPTION_MESSAGE

See Also:

• Constant Field Values

DYNAMODB_ERROR_CODE

public static final String DYNAMODB_ERROR_CODE

See Also:

• Constant Field Values

DYNAMODB_ERROR_MESSAGE

public static final String DYNAMODB_ERROR_MESSAGE

See Also:

• Constant Field Values

DYNAMODB_ERROR_SERVICE

public static final String DYNAMODB_ERROR_SERVICE

See Also:

• Constant Field Values

DYNAMODB_ERROR_RETRYABLE

public static final String DYNAMODB_ERROR_RETRYABLE

See Also:

• Constant Field Values

DYNAMODB_ERROR_REQUEST_ID

public static final String DYNAMODB_ERROR_REQUEST_ID

See Also:

• Constant Field Values

DYNAMODB_ERROR_STATUS_CODE

public static final String DYNAMODB_ERROR_STATUS_CODE

See Also:

• Constant Field Values

DYNAMODB_ITEM_HASH_KEY_VALUE

public static final String DYNAMODB_ITEM_HASH_KEY_VALUE

See Also:

• Constant Field Values

DYNAMODB_ITEM_RANGE_KEY_VALUE

public static final String DYNAMODB_ITEM_RANGE_KEY_VALUE

See Also:

• Constant Field Values

DYNAMODB_ITEM_IO_ERROR

public static final String DYNAMODB_ITEM_IO_ERROR

See Also:

• Constant Field Values

AWS_DYNAMO_DB_ITEM_SIZE_ERROR

public static final String AWS_DYNAMO_DB_ITEM_SIZE_ERROR

See Also:

• Constant Field Values

DYNAMODB_KEY_ERROR_NOT_FOUND_MESSAGE

protected static final String DYNAMODB_KEY_ERROR_NOT_FOUND_MESSAGE

See Also:

• Constant Field Values

TABLE

public static final PropertyDescriptor TABLE

HASH_KEY_VALUE

public static final PropertyDescriptor HASH_KEY_VALUE

RANGE_KEY_VALUE

public static final PropertyDescriptor RANGE_KEY_VALUE

HASH_KEY_VALUE_TYPE

public static final PropertyDescriptor HASH_KEY_VALUE_TYPE

RANGE_KEY_VALUE_TYPE

public static final PropertyDescriptor RANGE_KEY_VALUE_TYPE

HASH_KEY_NAME

public static final PropertyDescriptor HASH_KEY_NAME

RANGE_KEY_NAME

public static final PropertyDescriptor RANGE_KEY_NAME

JSON_DOCUMENT

public static final PropertyDescriptor JSON_DOCUMENT

BATCH_SIZE

public static final PropertyDescriptor BATCH_SIZE

DOCUMENT_CHARSET

public static final PropertyDescriptor DOCUMENT_CHARSET

dynamoDBrelationships

public static final Set<Relationship> dynamoDBrelationships

Constructor Details

AbstractDynamoDBProcessor

public AbstractDynamoDBProcessor()

Method Details

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractAwsProcessor<software.amazon.awssdk.services.dynamodb.DynamoDbClient>

createClientBuilder

protected software.amazon.awssdk.services.dynamodb.DynamoDbClientBuilder createClientBuilder(ProcessContext context)

Description copied from class: AbstractAwsSyncProcessor

Construct the AWS SDK client builder and perform any service-specific configuration of the builder.

Specified by:

createClientBuilder in class AbstractAwsSyncProcessor<software.amazon.awssdk.services.dynamodb.DynamoDbClient,software.amazon.awssdk.services.dynamodb.DynamoDbClientBuilder>

Parameters:

context - The process context

Returns:

The SDK client builder

getAttributeValue

protected software.amazon.awssdk.services.dynamodb.model.AttributeValue getAttributeValue(ProcessContext context,
 PropertyDescriptor type,
 PropertyDescriptor value,
 Map<String,String> attributes)

processException

protected List<FlowFile> processException(ProcessSession session,
 List<FlowFile> flowFiles,
 Exception exception)

processSdkException

protected List<FlowFile> processSdkException(ProcessSession session,
 List<FlowFile> flowFiles,
 software.amazon.awssdk.core.exception.SdkException exception)

processServiceException

protected List<FlowFile> processServiceException(ProcessSession session,
 List<FlowFile> flowFiles,
 software.amazon.awssdk.awscore.exception.AwsServiceException exception)

sendUnprocessedToUnprocessedRelationship

protected void sendUnprocessedToUnprocessedRelationship(ProcessSession session,
 Map<ItemKeys,FlowFile> keysToFlowFileMap,
 software.amazon.awssdk.services.dynamodb.model.AttributeValue hashKeyValue,
 software.amazon.awssdk.services.dynamodb.model.AttributeValue rangeKeyValue)

Send unhandled items to failure and remove the flow files from key to flow file map

Parameters:

session - used for sending the flow file

keysToFlowFileMap - - ItemKeys to flow file map

hashKeyValue - the items hash key value

rangeKeyValue - the items hash key value

isRangeKeyValueConsistent

protected boolean isRangeKeyValueConsistent(String rangeKeyName,
 software.amazon.awssdk.services.dynamodb.model.AttributeValue rangeKeyValue,
 ProcessSession session,
 FlowFile flowFile)

validateRangeKeyValue

protected void validateRangeKeyValue(String rangeKeyName,
 software.amazon.awssdk.services.dynamodb.model.AttributeValue rangeKeyValue)

isHashKeyValueConsistent

protected boolean isHashKeyValueConsistent(String hashKeyName,
 software.amazon.awssdk.services.dynamodb.model.AttributeValue hashKeyValue,
 ProcessSession session,
 FlowFile flowFile)

validateHashKeyValue

protected void validateHashKeyValue(software.amazon.awssdk.services.dynamodb.model.AttributeValue hashKeyValue)

isBlank

protected static boolean isBlank(software.amazon.awssdk.services.dynamodb.model.AttributeValue attributeValue)

Parameters:

attributeValue - At attribute value

Returns:

True if the AttributeValue is null or both 's' and 'n' are null or blank