Package org.apache.nifi.processors.aws.wag

Class AbstractAWSGatewayApiProcessor

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

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

org.apache.nifi.processors.aws.wag.AbstractAWSGatewayApiProcessor

All Implemented Interfaces:

ConfigurableComponent, Processor, VerifiableProcessor

public abstract class AbstractAWSGatewayApiProcessor
extends AbstractAWSCredentialsProviderProcessor<GenericApiGatewayClient>

This class is the base class for invoking aws gateway api endpoints

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_CONTENT_TYPE
private Set<String>	dynamicPropertyNames
static final String	ENDPOINT_ATTR
static final String	EXCEPTION_CLASS
static final String	EXCEPTION_MESSAGE
static final Set<String>	IGNORED_ATTRIBUTES
static final PropertyDescriptor	PROP_ADD_HEADERS_TO_REQUEST
static final PropertyDescriptor	PROP_ATTRIBUTES_TO_SEND
static final PropertyDescriptor	PROP_AWS_API_KEY
static final PropertyDescriptor	PROP_AWS_GATEWAY_API_ENDPOINT
static final PropertyDescriptor	PROP_CONTENT_TYPE
static final PropertyDescriptor	PROP_METHOD
static final PropertyDescriptor	PROP_OUTPUT_RESPONSE_REGARDLESS
static final PropertyDescriptor	PROP_PENALIZE_NO_RETRY
static final PropertyDescriptor	PROP_PUT_ATTRIBUTE_MAX_LENGTH
static final PropertyDescriptor	PROP_PUT_OUTPUT_IN_ATTRIBUTE
static final PropertyDescriptor	PROP_QUERY_PARAMS
static final PropertyDescriptor	PROP_RESOURCE_NAME
static final PropertyDescriptor	PROP_SEND_BODY
private com.amazonaws.http.AmazonHttpClient	providedClient
private Pattern	regexAttributesToSend
protected static final String	REL_FAILURE_NAME
protected static final String	REL_NO_RETRY_NAME
protected static final String	REL_RESPONSE_NAME
protected static final String	REL_RETRY_NAME
protected static final String	REL_SUCCESS_REQ_NAME
static final String	RESOURCE_NAME_ATTR
static final String	RESPONSE_BODY
static final String	STATUS_CODE
static final String	STATUS_MESSAGE
static final String	TRANSACTION_ID

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
AbstractAWSGatewayApiProcessor()
AbstractAWSGatewayApiProcessor(com.amazonaws.http.AmazonHttpClient client)

Method Summary

Modifier and Type	Method	Description
protected GenericApiGatewayRequest	configureRequest(ProcessContext context, ProcessSession session, String resourcePath, FlowFile requestFlowFile, com.amazonaws.http.HttpMethodName methodName, Map<String,String> attributes)
protected GenericApiGatewayRequest	configureRequest(ProcessContext context, ProcessSession session, String resourcePath, FlowFile requestFlowFile, Map<String,String> attributes)
protected Map<String,String>	convertAttributesFromHeaders(GenericApiGatewayResponse responseHttp)	Returns a Map of flowfile attributes from the response http headers.
protected GenericApiGatewayClient	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.
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
protected String	getLogString(Map<String,?> map)
protected Map<String,List<String>>	getParameters(ProcessContext context, Map<String,String> flowFileAttributes)	Returns a map of Query Parameter Name to Values
protected Relationship	getRelationshipForName(String name, Set<Relationship> relationships)
protected InputStream	getRequestBodyToSend(ProcessSession session, ProcessContext context, FlowFile requestFlowFile)
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
protected boolean	isSuccess(int statusCode)
protected void	logRequest(ComponentLog logger, URI endpoint, GenericApiGatewayRequest request)
protected void	logResponse(ComponentLog logger, GenericApiGatewayResponse response)
void	onPropertyModified(PropertyDescriptor descriptor, String oldValue, String newValue)
protected void	route(FlowFile request, FlowFile response, ProcessSession session, ProcessContext context, int statusCode, Set<Relationship> relationships)
protected GenericApiGatewayRequestBuilder	setHeaderProperties(ProcessContext context, GenericApiGatewayRequestBuilder requestBuilder, com.amazonaws.http.HttpMethodName methodName, Map<String,String> requestAttributes)

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

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

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, getSupportedPropertyDescriptors, hashCode, 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, validate

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

isStateful, migrateRelationships

Field Details

dynamicPropertyNames

private volatile Set<String> dynamicPropertyNames

regexAttributesToSend

private volatile Pattern regexAttributesToSend

providedClient

private volatile com.amazonaws.http.AmazonHttpClient providedClient

STATUS_CODE

public static final String STATUS_CODE

See Also:

• Constant Field Values

STATUS_MESSAGE

public static final String STATUS_MESSAGE

See Also:

• Constant Field Values

RESPONSE_BODY

public static final String RESPONSE_BODY

See Also:

• Constant Field Values

RESOURCE_NAME_ATTR

public static final String RESOURCE_NAME_ATTR

See Also:

• Constant Field Values

ENDPOINT_ATTR

public static final String ENDPOINT_ATTR

See Also:

• Constant Field Values

TRANSACTION_ID

public static final String TRANSACTION_ID

See Also:

• Constant Field Values

EXCEPTION_CLASS

public static final String EXCEPTION_CLASS

See Also:

• Constant Field Values

EXCEPTION_MESSAGE

public static final String EXCEPTION_MESSAGE

See Also:

• Constant Field Values

REL_RESPONSE_NAME

protected static final String REL_RESPONSE_NAME

See Also:

• Constant Field Values

REL_SUCCESS_REQ_NAME

protected static final String REL_SUCCESS_REQ_NAME

See Also:

• Constant Field Values

REL_RETRY_NAME

protected static final String REL_RETRY_NAME

See Also:

• Constant Field Values

REL_NO_RETRY_NAME

protected static final String REL_NO_RETRY_NAME

See Also:

• Constant Field Values

REL_FAILURE_NAME

protected static final String REL_FAILURE_NAME

See Also:

• Constant Field Values

DEFAULT_CONTENT_TYPE

public static final String DEFAULT_CONTENT_TYPE

See Also:

• Constant Field Values

IGNORED_ATTRIBUTES

public static final Set<String> IGNORED_ATTRIBUTES

PROP_METHOD

public static final PropertyDescriptor PROP_METHOD

PROP_AWS_API_KEY

public static final PropertyDescriptor PROP_AWS_API_KEY

PROP_AWS_GATEWAY_API_ENDPOINT

public static final PropertyDescriptor PROP_AWS_GATEWAY_API_ENDPOINT

PROP_RESOURCE_NAME

public static final PropertyDescriptor PROP_RESOURCE_NAME

PROP_QUERY_PARAMS

public static final PropertyDescriptor PROP_QUERY_PARAMS

PROP_ATTRIBUTES_TO_SEND

public static final PropertyDescriptor PROP_ATTRIBUTES_TO_SEND

PROP_PUT_OUTPUT_IN_ATTRIBUTE

public static final PropertyDescriptor PROP_PUT_OUTPUT_IN_ATTRIBUTE

PROP_OUTPUT_RESPONSE_REGARDLESS

public static final PropertyDescriptor PROP_OUTPUT_RESPONSE_REGARDLESS

PROP_PENALIZE_NO_RETRY

public static final PropertyDescriptor PROP_PENALIZE_NO_RETRY

PROP_PUT_ATTRIBUTE_MAX_LENGTH

public static final PropertyDescriptor PROP_PUT_ATTRIBUTE_MAX_LENGTH

PROP_CONTENT_TYPE

public static final PropertyDescriptor PROP_CONTENT_TYPE

PROP_SEND_BODY

public static final PropertyDescriptor PROP_SEND_BODY

PROP_ADD_HEADERS_TO_REQUEST

public static final PropertyDescriptor PROP_ADD_HEADERS_TO_REQUEST

Constructor Details

AbstractAWSGatewayApiProcessor

public AbstractAWSGatewayApiProcessor()

AbstractAWSGatewayApiProcessor

public AbstractAWSGatewayApiProcessor(com.amazonaws.http.AmazonHttpClient client)

Method Details

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

onPropertyModified

public void onPropertyModified(PropertyDescriptor descriptor,
 String oldValue,
 String newValue)

Specified by:

onPropertyModified in interface ConfigurableComponent

Overrides:

onPropertyModified in class AbstractConfigurableComponent

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

createClient

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

Description copied from class: AbstractAWSCredentialsProviderProcessor

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

Specified by:

createClient in class AbstractAWSCredentialsProviderProcessor<GenericApiGatewayClient>

Parameters:

context - process context

credentialsProvider - AWS credentials provider

config - AWS client configuration

Returns:

ClientType the client

configureRequest

protected GenericApiGatewayRequest configureRequest(ProcessContext context,
 ProcessSession session,
 String resourcePath,
 FlowFile requestFlowFile,
 Map<String,String> attributes)

configureRequest

protected GenericApiGatewayRequest configureRequest(ProcessContext context,
 ProcessSession session,
 String resourcePath,
 FlowFile requestFlowFile,
 com.amazonaws.http.HttpMethodName methodName,
 Map<String,String> attributes)

getRequestBodyToSend

protected InputStream getRequestBodyToSend(ProcessSession session,
 ProcessContext context,
 FlowFile requestFlowFile)

setHeaderProperties

protected GenericApiGatewayRequestBuilder setHeaderProperties(ProcessContext context,
 GenericApiGatewayRequestBuilder requestBuilder,
 com.amazonaws.http.HttpMethodName methodName,
 Map<String,String> requestAttributes)

getParameters

protected Map<String,List<String>> getParameters(ProcessContext context,
 Map<String,String> flowFileAttributes)

Returns a map of Query Parameter Name to Values

Parameters:

context - ProcessContext

flowFileAttributes - map of FlowFile attributes used for EL evaluation

Returns:

Map of names and values

convertAttributesFromHeaders

protected Map<String,String> convertAttributesFromHeaders(GenericApiGatewayResponse responseHttp)

Returns a Map of flowfile attributes from the response http headers. Multivalue headers are naively converted to comma separated strings.

getRelationshipForName

protected Relationship getRelationshipForName(String name,
 Set<Relationship> relationships)

route

protected void route(FlowFile request,
 FlowFile response,
 ProcessSession session,
 ProcessContext context,
 int statusCode,
 Set<Relationship> relationships)

isSuccess

protected boolean isSuccess(int statusCode)

logRequest

protected void logRequest(ComponentLog logger,
 URI endpoint,
 GenericApiGatewayRequest request)

logResponse

protected void logResponse(ComponentLog logger,
 GenericApiGatewayResponse response)

getLogString

protected String getLogString(Map<String,?> map)