org.apache.nifi.processors.standard

Class HandleHttpResponse

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.HandleHttpResponse

All Implemented Interfaces:

ConfigurableComponent, Processor

@InputRequirement(value=INPUT_REQUIRED)
 @Tags(value={"http","https","response","egress","web service"})
 @CapabilityDescription(value="Sends an HTTP Response to the Requestor that generated a FlowFile. This Processor is designed to be used in conjunction with the HandleHttpRequest in order to create a web service.")
 @DynamicProperty(name="An HTTP header name",
                 value="An HTTP header value",
                 description="These HTTPHeaders are set in the HTTP Response",
                 expressionLanguageScope=FLOWFILE_ATTRIBUTES)
 @ReadsAttribute(attribute="http.context.identifier",description="The value of this attribute is used to lookup the HTTP Response so that the proper message can be sent back to the requestor. If this attribute is missing, the FlowFile will be routed to \'failure.\'") @ReadsAttribute(attribute="http.request.uri",description="Value of the URI requested by the client. Used for provenance event.") @ReadsAttribute(attribute="http.remote.host",description="IP address of the client. Used for provenance event.") @ReadsAttribute(attribute="http.local.name",description="IP address/hostname of the server. Used for provenance event.") @ReadsAttribute(attribute="http.server.port",description="Listening port of the server. Used for provenance event.") @ReadsAttribute(attribute="http.subject.dn",description="SSL distinguished name (if any). Used for provenance event.")
 @SeeAlso(value=HandleHttpRequest.class,
         classNames="org.apache.nifi.http.StandardHttpContextMap")
public class HandleHttpResponse
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	ATTRIBUTES_AS_HEADERS_REGEX
static PropertyDescriptor	HTTP_CONTEXT_MAP
static Relationship	REL_FAILURE
static Relationship	REL_SUCCESS
static PropertyDescriptor	STATUS_CODE

Constructor Summary

Constructors

Constructor and Description
HandleHttpResponse()

Method Summary

Modifier and Type	Method and Description
Set<Relationship>	getRelationships()
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
List<PropertyDescriptor>	getSupportedPropertyDescriptors()
private static boolean	isNumber(String value)
void	onTrigger(ProcessContext context, ProcessSession session)

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

customValidate, equals, getPropertyDescriptor, getPropertyDescriptors, 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.processor.Processor

isStateful

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

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

STATUS_CODE

public static final PropertyDescriptor STATUS_CODE

HTTP_CONTEXT_MAP

public static final PropertyDescriptor HTTP_CONTEXT_MAP

ATTRIBUTES_AS_HEADERS_REGEX

public static final PropertyDescriptor ATTRIBUTES_AS_HEADERS_REGEX

REL_SUCCESS

public static final Relationship REL_SUCCESS

REL_FAILURE

public static final Relationship REL_FAILURE

Constructor Detail

HandleHttpResponse

public HandleHttpResponse()

Method Detail

getSupportedPropertyDescriptors

public final List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

isNumber

private static boolean isNumber(String value)