org.apache.nifi.processors.standard

Class InvokeHTTP

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.InvokeHTTP

All Implemented Interfaces:

ConfigurableComponent, Processor

@SupportsSensitiveDynamicProperties
 @SupportsBatching
 @Tags(value={"http","https","rest","client"})
 @InputRequirement(value=INPUT_ALLOWED)
 @CapabilityDescription(value="An HTTP client processor which can interact with a configurable HTTP Endpoint. The destination URL and HTTP Method are configurable. FlowFile attributes are converted to HTTP headers and the FlowFile contents are included as the body of the request (if the HTTP Method is PUT, POST or PATCH).")
 @WritesAttribute(attribute="invokehttp.status.code",description="The status code that is returned") @WritesAttribute(attribute="invokehttp.status.message",description="The status message that is returned") @WritesAttribute(attribute="invokehttp.response.body",description="In the instance where the status code received is not a success (2xx) then the response body will be put to the \'invokehttp.response.body\' attribute of the request FlowFile.") @WritesAttribute(attribute="invokehttp.request.url",description="The original request URL") @WritesAttribute(attribute="invokehttp.request.duration",description="Duration (in milliseconds) of the HTTP call to the external endpoint") @WritesAttribute(attribute="invokehttp.response.url",description="The URL that was ultimately requested after any redirects were followed") @WritesAttribute(attribute="invokehttp.tx.id",description="The transaction ID that is returned after reading the response") @WritesAttribute(attribute="invokehttp.remote.dn",description="The DN of the remote server") @WritesAttribute(attribute="invokehttp.java.exception.class",description="The Java exception class raised when the processor fails") @WritesAttribute(attribute="invokehttp.java.exception.message",description="The Java exception message raised when the processor fails") @WritesAttribute(attribute="user-defined",description="If the \'Put Response Body In Attribute\' property is set then whatever it is set to will become the attribute key and the value would be the body of the HTTP response.")
 @DynamicProperty(name="Header Name",value="Attribute Expression Language",expressionLanguageScope=FLOWFILE_ATTRIBUTES,description="Send request header with a key matching the Dynamic Property Key and a value created by evaluating the Attribute Expression Language set in the value of the Dynamic Property.") @DynamicProperty(name="post:form:<NAME>",value="Attribute Expression Language",expressionLanguageScope=FLOWFILE_ATTRIBUTES,description="When the HTTP Method is POST, dynamic properties with the property name in the form of post:form:<NAME>, where the <NAME> will be the form data name, will be used to fill out the multipart form parts.  If send message body is false, the flowfile will not be sent, but any other form data will be.")
public class InvokeHTTP
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	chunkedTransferEncoding
static String	DEFAULT_CONTENT_TYPE
private static DeprecationLogger	deprecationLogger
private Set<String>	dynamicPropertyNames
static String	EXCEPTION_CLASS
static String	EXCEPTION_MESSAGE
static Relationship	FAILURE
protected static String	FORM_DATA_NAME_BASE
private static String	FORM_DATA_NAME_GROUP
private static Pattern	FORM_DATA_NAME_PARAMETER_PATTERN
static PropertyDescriptor	HTTP_METHOD
static PropertyDescriptor	HTTP_URL
static PropertyDescriptor	HTTP2_DISABLED
private static Set<String>	IGNORED_REQUEST_ATTRIBUTES
private static String	MULTIPLE_HEADER_DELIMITER
static Relationship	NO_RETRY
private Optional<OAuth2AccessTokenProvider>	oauth2AccessTokenProviderOptional
private AtomicReference<okhttp3.OkHttpClient>	okHttpClientAtomicReference
static Relationship	ORIGINAL
static List<PropertyDescriptor>	PROPERTIES
private static PropertyDescriptor	PROXY_CONFIGURATION_SERVICE
static PropertyDescriptor	PROXY_HOST Deprecated.
static PropertyDescriptor	PROXY_PASSWORD Deprecated.
static PropertyDescriptor	PROXY_PORT Deprecated.
private static ProxySpec[]	PROXY_SPECS
static PropertyDescriptor	PROXY_TYPE Deprecated.
static PropertyDescriptor	PROXY_USERNAME Deprecated.
static Set<Relationship>	RELATIONSHIPS
static String	REMOTE_DN
static PropertyDescriptor	REQUEST_BODY_ENABLED
static PropertyDescriptor	REQUEST_CHUNKED_TRANSFER_ENCODING_ENABLED
static PropertyDescriptor	REQUEST_CONTENT_ENCODING
static PropertyDescriptor	REQUEST_CONTENT_TYPE
static PropertyDescriptor	REQUEST_DATE_HEADER_ENABLED
static PropertyDescriptor	REQUEST_DIGEST_AUTHENTICATION_ENABLED
static String	REQUEST_DURATION
static PropertyDescriptor	REQUEST_FAILURE_PENALIZATION_ENABLED
static PropertyDescriptor	REQUEST_FORM_DATA_FILENAME_ENABLED
static PropertyDescriptor	REQUEST_FORM_DATA_NAME
static PropertyDescriptor	REQUEST_HEADER_ATTRIBUTES_PATTERN
static PropertyDescriptor	REQUEST_OAUTH2_ACCESS_TOKEN_PROVIDER
static PropertyDescriptor	REQUEST_PASSWORD
static String	REQUEST_URL
static PropertyDescriptor	REQUEST_USER_AGENT
static PropertyDescriptor	REQUEST_USERNAME
private Pattern	requestHeaderAttributesPattern
static Relationship	RESPONSE
static String	RESPONSE_BODY
static PropertyDescriptor	RESPONSE_BODY_ATTRIBUTE_NAME
static PropertyDescriptor	RESPONSE_BODY_ATTRIBUTE_SIZE
static PropertyDescriptor	RESPONSE_BODY_IGNORED
static PropertyDescriptor	RESPONSE_CACHE_ENABLED
static PropertyDescriptor	RESPONSE_CACHE_SIZE
static PropertyDescriptor	RESPONSE_COOKIE_STRATEGY
static PropertyDescriptor	RESPONSE_FLOW_FILE_NAMING_STRATEGY
static PropertyDescriptor	RESPONSE_GENERATION_REQUIRED
static PropertyDescriptor	RESPONSE_HEADER_REQUEST_ATTRIBUTES_ENABLED
static PropertyDescriptor	RESPONSE_REDIRECTS_ENABLED
static String	RESPONSE_URL
static Relationship	RETRY
private static DateTimeFormatter	RFC_2616_DATE_TIME
static PropertyDescriptor	SOCKET_CONNECT_TIMEOUT
static PropertyDescriptor	SOCKET_IDLE_CONNECTIONS
static PropertyDescriptor	SOCKET_IDLE_TIMEOUT
static PropertyDescriptor	SOCKET_READ_TIMEOUT
static PropertyDescriptor	SOCKET_WRITE_TIMEOUT
static PropertyDescriptor	SSL_CONTEXT_SERVICE
static String	STATUS_CODE
static String	STATUS_MESSAGE
static String	TRANSACTION_ID

Constructor Summary

Constructors

Constructor and Description
InvokeHTTP()

Method Summary

Modifier and Type	Method and Description
private okhttp3.Request	configureRequest(ProcessContext context, ProcessSession session, FlowFile requestFlowFile, URL url)
private Map<String,String>	convertAttributesFromHeaders(okhttp3.Response responseHttp) Returns a Map of flowfile attributes from the response http headers.
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
private Optional<HttpMethod>	findRequestMethod(String method)
private Charset	getCharsetFromMediaType(okhttp3.MediaType contentType)
private String	getFileNameFromUrl(URL url)
private FlowFileNamingStrategy	getFlowFileNamingStrategy(ProcessContext context)
private String	getLogString(Map<String,List<String>> map)
Set<Relationship>	getRelationships()
private okhttp3.RequestBody	getRequestBodyToSend(ProcessSession session, ProcessContext context, FlowFile requestFlowFile, ContentEncodingStrategy contentEncodingStrategy)
private String	getRequestMethod(PropertyContext context, FlowFile flowFile)
private static File	getResponseCacheDirectory()
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	initOauth2AccessTokenProvider(ProcessContext context)
private boolean	isSuccess(int statusCode)
private void	logRequest(ComponentLog logger, okhttp3.Request request)
private void	logResponse(ComponentLog logger, URL url, okhttp3.Response response)
void	onPropertyModified(PropertyDescriptor descriptor, String oldValue, String newValue)
void	onTrigger(ProcessContext context, ProcessSession session)
private void	route(FlowFile request, FlowFile response, ProcessSession session, ProcessContext context, int statusCode)
private void	setAuthenticator(okhttp3.OkHttpClient.Builder okHttpClientBuilder, ProcessContext context)
private void	setHeaderProperties(ProcessContext context, okhttp3.Request.Builder requestBuilder, FlowFile requestFlowFile)
void	setUpClient(ProcessContext context)

Methods inherited from class org.apache.nifi.processor.AbstractProcessor

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

isStateful

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, validate

Field Detail

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

REQUEST_URL

public static final String REQUEST_URL

See Also:

Constant Field Values

REQUEST_DURATION

public static final String REQUEST_DURATION

See Also:

Constant Field Values

RESPONSE_URL

public static final String RESPONSE_URL

See Also:

Constant Field Values

TRANSACTION_ID

public static final String TRANSACTION_ID

See Also:

Constant Field Values

REMOTE_DN

public static final String REMOTE_DN

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

DEFAULT_CONTENT_TYPE

public static final String DEFAULT_CONTENT_TYPE

See Also:

Constant Field Values

FORM_DATA_NAME_BASE

protected static final String FORM_DATA_NAME_BASE

See Also:

Constant Field Values

FORM_DATA_NAME_PARAMETER_PATTERN

private static final Pattern FORM_DATA_NAME_PARAMETER_PATTERN

FORM_DATA_NAME_GROUP

private static final String FORM_DATA_NAME_GROUP

See Also:

Constant Field Values

IGNORED_REQUEST_ATTRIBUTES

private static final Set<String> IGNORED_REQUEST_ATTRIBUTES

HTTP_METHOD

public static final PropertyDescriptor HTTP_METHOD

HTTP_URL

public static final PropertyDescriptor HTTP_URL

HTTP2_DISABLED

public static final PropertyDescriptor HTTP2_DISABLED

SSL_CONTEXT_SERVICE

public static final PropertyDescriptor SSL_CONTEXT_SERVICE

SOCKET_CONNECT_TIMEOUT

public static final PropertyDescriptor SOCKET_CONNECT_TIMEOUT

SOCKET_READ_TIMEOUT

public static final PropertyDescriptor SOCKET_READ_TIMEOUT

SOCKET_WRITE_TIMEOUT

public static final PropertyDescriptor SOCKET_WRITE_TIMEOUT

SOCKET_IDLE_TIMEOUT

public static final PropertyDescriptor SOCKET_IDLE_TIMEOUT

SOCKET_IDLE_CONNECTIONS

public static final PropertyDescriptor SOCKET_IDLE_CONNECTIONS

PROXY_HOST

@Deprecated
public static final PropertyDescriptor PROXY_HOST

Deprecated.

PROXY_PORT

@Deprecated
public static final PropertyDescriptor PROXY_PORT

Deprecated.

PROXY_TYPE

@Deprecated
public static final PropertyDescriptor PROXY_TYPE

Deprecated.

PROXY_USERNAME

@Deprecated
public static final PropertyDescriptor PROXY_USERNAME

Deprecated.

PROXY_PASSWORD

@Deprecated
public static final PropertyDescriptor PROXY_PASSWORD

Deprecated.

REQUEST_OAUTH2_ACCESS_TOKEN_PROVIDER

public static final PropertyDescriptor REQUEST_OAUTH2_ACCESS_TOKEN_PROVIDER

REQUEST_USERNAME

public static final PropertyDescriptor REQUEST_USERNAME

REQUEST_PASSWORD

public static final PropertyDescriptor REQUEST_PASSWORD

REQUEST_DIGEST_AUTHENTICATION_ENABLED

public static final PropertyDescriptor REQUEST_DIGEST_AUTHENTICATION_ENABLED

REQUEST_FAILURE_PENALIZATION_ENABLED

public static final PropertyDescriptor REQUEST_FAILURE_PENALIZATION_ENABLED

REQUEST_BODY_ENABLED

public static final PropertyDescriptor REQUEST_BODY_ENABLED

REQUEST_FORM_DATA_NAME

public static final PropertyDescriptor REQUEST_FORM_DATA_NAME

REQUEST_FORM_DATA_FILENAME_ENABLED

public static final PropertyDescriptor REQUEST_FORM_DATA_FILENAME_ENABLED

REQUEST_CHUNKED_TRANSFER_ENCODING_ENABLED

public static final PropertyDescriptor REQUEST_CHUNKED_TRANSFER_ENCODING_ENABLED

REQUEST_CONTENT_ENCODING

public static final PropertyDescriptor REQUEST_CONTENT_ENCODING

REQUEST_CONTENT_TYPE

public static final PropertyDescriptor REQUEST_CONTENT_TYPE

REQUEST_DATE_HEADER_ENABLED

public static final PropertyDescriptor REQUEST_DATE_HEADER_ENABLED

REQUEST_HEADER_ATTRIBUTES_PATTERN

public static final PropertyDescriptor REQUEST_HEADER_ATTRIBUTES_PATTERN

REQUEST_USER_AGENT

public static final PropertyDescriptor REQUEST_USER_AGENT

RESPONSE_BODY_ATTRIBUTE_NAME

public static final PropertyDescriptor RESPONSE_BODY_ATTRIBUTE_NAME

RESPONSE_BODY_ATTRIBUTE_SIZE

public static final PropertyDescriptor RESPONSE_BODY_ATTRIBUTE_SIZE

RESPONSE_BODY_IGNORED

public static final PropertyDescriptor RESPONSE_BODY_IGNORED

RESPONSE_CACHE_ENABLED

public static final PropertyDescriptor RESPONSE_CACHE_ENABLED

RESPONSE_CACHE_SIZE

public static final PropertyDescriptor RESPONSE_CACHE_SIZE

RESPONSE_COOKIE_STRATEGY

public static final PropertyDescriptor RESPONSE_COOKIE_STRATEGY

RESPONSE_GENERATION_REQUIRED

public static final PropertyDescriptor RESPONSE_GENERATION_REQUIRED

RESPONSE_FLOW_FILE_NAMING_STRATEGY

public static final PropertyDescriptor RESPONSE_FLOW_FILE_NAMING_STRATEGY

RESPONSE_HEADER_REQUEST_ATTRIBUTES_ENABLED

public static final PropertyDescriptor RESPONSE_HEADER_REQUEST_ATTRIBUTES_ENABLED

RESPONSE_REDIRECTS_ENABLED

public static final PropertyDescriptor RESPONSE_REDIRECTS_ENABLED

PROXY_SPECS

private static final ProxySpec[] PROXY_SPECS

PROXY_CONFIGURATION_SERVICE

private static final PropertyDescriptor PROXY_CONFIGURATION_SERVICE

PROPERTIES

public static final List<PropertyDescriptor> PROPERTIES

ORIGINAL

public static final Relationship ORIGINAL

RESPONSE

public static final Relationship RESPONSE

RETRY

public static final Relationship RETRY

NO_RETRY

public static final Relationship NO_RETRY

FAILURE

public static final Relationship FAILURE

RELATIONSHIPS

public static final Set<Relationship> RELATIONSHIPS

RFC_2616_DATE_TIME

private static final DateTimeFormatter RFC_2616_DATE_TIME

MULTIPLE_HEADER_DELIMITER

private static final String MULTIPLE_HEADER_DELIMITER

See Also:

Constant Field Values

deprecationLogger

private static final DeprecationLogger deprecationLogger

dynamicPropertyNames

private volatile Set<String> dynamicPropertyNames

requestHeaderAttributesPattern

private volatile Pattern requestHeaderAttributesPattern

chunkedTransferEncoding

private volatile boolean chunkedTransferEncoding

oauth2AccessTokenProviderOptional

private volatile Optional<OAuth2AccessTokenProvider> oauth2AccessTokenProviderOptional

okHttpClientAtomicReference

private final AtomicReference<okhttp3.OkHttpClient> okHttpClientAtomicReference

Constructor Detail

InvokeHTTP

public InvokeHTTP()

Method Detail

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

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

setUpClient

@OnScheduled
public void setUpClient(ProcessContext context)
                              throws TlsException,
                                     IOException

Throws:

TlsException

IOException

initOauth2AccessTokenProvider

@OnScheduled
public void initOauth2AccessTokenProvider(ProcessContext context)

setAuthenticator

private void setAuthenticator(okhttp3.OkHttpClient.Builder okHttpClientBuilder,
                              ProcessContext context)

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

configureRequest

private okhttp3.Request configureRequest(ProcessContext context,
                                         ProcessSession session,
                                         FlowFile requestFlowFile,
                                         URL url)

getRequestBodyToSend

private okhttp3.RequestBody getRequestBodyToSend(ProcessSession session,
                                                 ProcessContext context,
                                                 FlowFile requestFlowFile,
                                                 ContentEncodingStrategy contentEncodingStrategy)

setHeaderProperties

private void setHeaderProperties(ProcessContext context,
                                 okhttp3.Request.Builder requestBuilder,
                                 FlowFile requestFlowFile)

route

private void route(FlowFile request,
                   FlowFile response,
                   ProcessSession session,
                   ProcessContext context,
                   int statusCode)

isSuccess

private boolean isSuccess(int statusCode)

logRequest

private void logRequest(ComponentLog logger,
                        okhttp3.Request request)

logResponse

private void logResponse(ComponentLog logger,
                         URL url,
                         okhttp3.Response response)

getLogString

private String getLogString(Map<String,List<String>> map)

convertAttributesFromHeaders

private Map<String,String> convertAttributesFromHeaders(okhttp3.Response responseHttp)

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

getCharsetFromMediaType

private Charset getCharsetFromMediaType(okhttp3.MediaType contentType)

getResponseCacheDirectory

private static File getResponseCacheDirectory()
                                       throws IOException

Throws:

IOException

getFlowFileNamingStrategy

private FlowFileNamingStrategy getFlowFileNamingStrategy(ProcessContext context)

getFileNameFromUrl

private String getFileNameFromUrl(URL url)

findRequestMethod

private Optional<HttpMethod> findRequestMethod(String method)

getRequestMethod

private String getRequestMethod(PropertyContext context,
                                FlowFile flowFile)