org.apache.nifi.processors.standard

Class GetHTTP

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processors.standard.GetHTTP

All Implemented Interfaces:

ConfigurableComponent, Processor

@Tags(value={"get","fetch","poll","http","https","ingest","source","input"})
 @InputRequirement(value=INPUT_FORBIDDEN)
 @CapabilityDescription(value="Fetches data from an HTTP or HTTPS URL and writes the data to the content of a FlowFile. Once the content has been fetched, the ETag and Last Modified dates are remembered (if the web server supports these concepts). This allows the Processor to fetch new data only if the remote data has changed or until the state is cleared. That is, once the content has been fetched from the given URL, it will not be fetched again until the content on the remote server changes. Note that due to limitations on state management, stored \"last modified\" and etag fields never expire. If the URL in GetHttp uses Expression Language that is unbounded, there is the potential for Out of Memory Errors to occur.")
 @WritesAttribute(attribute="filename",description="The filename is set to the name of the file on the remote server") @WritesAttribute(attribute="mime.type",description="The MIME Type of the FlowFile, as reported by the HTTP Content-Type header")
 @Stateful(scopes=LOCAL,
          description="Stores Last Modified Time and ETag headers returned by server so that the same data will not be fetched multiple times.")
public class GetHTTP
extends AbstractSessionFactoryProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	ACCEPT_CONTENT_TYPE
private AtomicBoolean	clearState
static PropertyDescriptor	CONNECTION_TIMEOUT
static PropertyDescriptor	DATA_TIMEOUT
(package private) static String	ETAG
static PropertyDescriptor	FILENAME
static PropertyDescriptor	FOLLOW_REDIRECTS
static String	HEADER_ACCEPT
static String	HEADER_ETAG
static String	HEADER_IF_MODIFIED_SINCE
static String	HEADER_IF_NONE_MATCH
static String	HEADER_LAST_MODIFIED
(package private) static String	LAST_MODIFIED
static String	LAST_MODIFIED_DATE_PATTERN_RFC1123
static int	NOT_MODIFIED
static PropertyDescriptor	PASSWORD
(package private) static int	PERSISTENCE_INTERVAL_MSEC
private List<PropertyDescriptor>	properties
static PropertyDescriptor	PROXY_HOST
static PropertyDescriptor	PROXY_PORT
static Relationship	REL_SUCCESS
private Set<Relationship>	relationships
static PropertyDescriptor	SSL_CONTEXT_SERVICE
static PropertyDescriptor	URL
static PropertyDescriptor	USER_AGENT
static PropertyDescriptor	USERNAME

Constructor Summary

Constructors

Constructor and Description
GetHTTP()

Method Summary

Modifier and Type	Method and Description
private SSLContext	createSSLContext(SSLContextService service)
protected Collection<ValidationResult>	customValidate(ValidationContext context)
Set<Relationship>	getRelationships()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ProcessorInitializationContext context)
void	onPropertyModified(PropertyDescriptor descriptor, String oldValue, String newValue)
void	onScheduled(ProcessContext context)
void	onTrigger(ProcessContext context, ProcessSessionFactory sessionFactory)
protected static Tuple<String,String>	parseStateValue(String mapValue)
private void	updateStateMap(ProcessContext context, org.apache.http.HttpResponse response, StateMap beforeStateMap, String url)

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

getControllerServiceLookup, getIdentifier, getLogger, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, 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

Field Detail

PERSISTENCE_INTERVAL_MSEC

static final int PERSISTENCE_INTERVAL_MSEC

See Also:

Constant Field Values

HEADER_IF_NONE_MATCH

public static final String HEADER_IF_NONE_MATCH

See Also:

Constant Field Values

HEADER_IF_MODIFIED_SINCE

public static final String HEADER_IF_MODIFIED_SINCE

See Also:

Constant Field Values

HEADER_ACCEPT

public static final String HEADER_ACCEPT

See Also:

Constant Field Values

HEADER_LAST_MODIFIED

public static final String HEADER_LAST_MODIFIED

See Also:

Constant Field Values

HEADER_ETAG

public static final String HEADER_ETAG

See Also:

Constant Field Values

NOT_MODIFIED

public static final int NOT_MODIFIED

See Also:

Constant Field Values

URL

public static final PropertyDescriptor URL

FOLLOW_REDIRECTS

public static final PropertyDescriptor FOLLOW_REDIRECTS

CONNECTION_TIMEOUT

public static final PropertyDescriptor CONNECTION_TIMEOUT

ACCEPT_CONTENT_TYPE

public static final PropertyDescriptor ACCEPT_CONTENT_TYPE

DATA_TIMEOUT

public static final PropertyDescriptor DATA_TIMEOUT

FILENAME

public static final PropertyDescriptor FILENAME

USERNAME

public static final PropertyDescriptor USERNAME

PASSWORD

public static final PropertyDescriptor PASSWORD

USER_AGENT

public static final PropertyDescriptor USER_AGENT

SSL_CONTEXT_SERVICE

public static final PropertyDescriptor SSL_CONTEXT_SERVICE

PROXY_HOST

public static final PropertyDescriptor PROXY_HOST

PROXY_PORT

public static final PropertyDescriptor PROXY_PORT

REL_SUCCESS

public static final Relationship REL_SUCCESS

LAST_MODIFIED_DATE_PATTERN_RFC1123

public static final String LAST_MODIFIED_DATE_PATTERN_RFC1123

See Also:

Constant Field Values

ETAG

static final String ETAG

See Also:

Constant Field Values

LAST_MODIFIED

static final String LAST_MODIFIED

See Also:

Constant Field Values

relationships

private Set<Relationship> relationships

properties

private List<PropertyDescriptor> properties

clearState

private final AtomicBoolean clearState

Constructor Detail

GetHTTP

public GetHTTP()

Method Detail

init

protected void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

onPropertyModified

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

Specified by:

onPropertyModified in interface ConfigurableComponent

Overrides:

onPropertyModified in class AbstractConfigurableComponent

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)
                              throws IOException

Throws:

IOException

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext context)

Overrides:

customValidate in class AbstractConfigurableComponent

createSSLContext

private SSLContext createSSLContext(SSLContextService service)
                             throws KeyStoreException,
                                    IOException,
                                    NoSuchAlgorithmException,
                                    CertificateException,
                                    KeyManagementException,
                                    UnrecoverableKeyException

Throws:

KeyStoreException

IOException

NoSuchAlgorithmException

CertificateException

KeyManagementException

UnrecoverableKeyException

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSessionFactory sessionFactory)
               throws ProcessException

Throws:

ProcessException

updateStateMap

private void updateStateMap(ProcessContext context,
                            org.apache.http.HttpResponse response,
                            StateMap beforeStateMap,
                            String url)

parseStateValue

protected static Tuple<String,String> parseStateValue(String mapValue)