org.apache.nifi.processors.twitter

Class GetTwitter

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.twitter.GetTwitter

All Implemented Interfaces:

ConfigurableComponent, Processor

@SupportsBatching
 @InputRequirement(value=INPUT_FORBIDDEN)
 @Tags(value={"twitter","tweets","social media","status","json"})
 @CapabilityDescription(value="Pulls status changes from Twitter\'s streaming API")
 @WritesAttribute(attribute="mime.type",
                 description="Sets mime type to application/json")
public class GetTwitter
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	ACCESS_TOKEN
static PropertyDescriptor	ACCESS_TOKEN_SECRET
static PropertyDescriptor	CONSUMER_KEY
static PropertyDescriptor	CONSUMER_SECRET
static PropertyDescriptor	ENDPOINT
static PropertyDescriptor	FOLLOWING
static PropertyDescriptor	LANGUAGES
static PropertyDescriptor	LOCATIONS
static Relationship	REL_SUCCESS
static PropertyDescriptor	TERMS

Constructor Summary

Constructors

Constructor and Description
GetTwitter()

Method Summary

Modifier and Type	Method and Description
protected java.util.Collection<ValidationResult>	customValidate(ValidationContext validationContext) Allows subclasses to perform their own validation on the already set properties.
java.util.Set<Relationship>	getRelationships()
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(java.lang.String propertyDescriptorName) Used to allow subclasses to determine what PropertyDescriptor if any to use when a property is requested for which a descriptor is not already registered.
java.util.List<PropertyDescriptor>	getSupportedPropertyDescriptors() Allows subclasses to register which property descriptor objects are supported.
protected void	init(ProcessorInitializationContext context) Provides subclasses the ability to perform initialization logic
void	onPropertyModified(PropertyDescriptor descriptor, java.lang.String oldValue, java.lang.String newValue) Hook method allowing subclasses to eagerly react to a configuration change for the given property descriptor.
void	onScheduled(ProcessContext context)
void	onTrigger(ProcessContext context, ProcessSession session)
void	shutdownClient()

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

onTrigger

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

getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, 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.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, validate

Field Detail

ENDPOINT

public static final PropertyDescriptor ENDPOINT

CONSUMER_KEY

public static final PropertyDescriptor CONSUMER_KEY

CONSUMER_SECRET

public static final PropertyDescriptor CONSUMER_SECRET

ACCESS_TOKEN

public static final PropertyDescriptor ACCESS_TOKEN

ACCESS_TOKEN_SECRET

public static final PropertyDescriptor ACCESS_TOKEN_SECRET

LANGUAGES

public static final PropertyDescriptor LANGUAGES

FOLLOWING

public static final PropertyDescriptor FOLLOWING

LOCATIONS

public static final PropertyDescriptor LOCATIONS

TERMS

public static final PropertyDescriptor TERMS

REL_SUCCESS

public static final Relationship REL_SUCCESS

Constructor Detail

GetTwitter

public GetTwitter()

Method Detail

init

protected void init(ProcessorInitializationContext context)

Description copied from class: AbstractSessionFactoryProcessor

Provides subclasses the ability to perform initialization logic

Overrides:

init in class AbstractSessionFactoryProcessor

Parameters:

context - in which to perform initialization

getRelationships

public java.util.Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

Returns:

Set of all relationships this processor expects to transfer a flow file to. An empty set indicates this processor does not have any destination relationships. Guaranteed non null.

getSupportedPropertyDescriptors

public final java.util.List<PropertyDescriptor> getSupportedPropertyDescriptors()

Description copied from class: AbstractConfigurableComponent

Allows subclasses to register which property descriptor objects are supported. Default return is an empty set.

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

Returns:

PropertyDescriptor objects this processor currently supports

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(java.lang.String propertyDescriptorName)

Description copied from class: AbstractConfigurableComponent

Used to allow subclasses to determine what PropertyDescriptor if any to use when a property is requested for which a descriptor is not already registered. By default this method simply returns a null descriptor. By overriding this method processor implementations can support dynamic properties since this allows them to register properties on demand. It is acceptable for a dynamically generated property to indicate it is required so long as it is understood it is only required once set. Dynamic properties by definition cannot be required until used.

This method should be side effect free in the subclasses in terms of how often it is called for a given property name because there is guarantees how often it will be called for a given property name.

Default is null.

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

Parameters:

propertyDescriptorName - used to lookup if any property descriptors exist for that name

Returns:

new property descriptor if supported

customValidate

protected java.util.Collection<ValidationResult> customValidate(ValidationContext validationContext)

Description copied from class: AbstractConfigurableComponent

Allows subclasses to perform their own validation on the already set properties. Since each property is validated as it is set this allows validation of groups of properties together. Default return is an empty set. This method will be called only when it has been determined that all property values are valid according to their corresponding PropertyDescriptor's validators.

Overrides:

customValidate in class AbstractConfigurableComponent

Parameters:

validationContext - provides a mechanism for obtaining externally managed values, such as property values and supplies convenience methods for operating on those values

Returns:

Collection of ValidationResult objects that will be added to any other validation findings - may be null

onPropertyModified

public void onPropertyModified(PropertyDescriptor descriptor,
                               java.lang.String oldValue,
                               java.lang.String newValue)

Description copied from class: AbstractConfigurableComponent

Hook method allowing subclasses to eagerly react to a configuration change for the given property descriptor. As an alternative to using this method a processor may simply get the latest value whenever it needs it and if necessary lazily evaluate it.

Specified by:

onPropertyModified in interface ConfigurableComponent

Overrides:

onPropertyModified in class AbstractConfigurableComponent

Parameters:

descriptor - of the modified property

oldValue - non-null property value (previous)

newValue - the new property value or if null indicates the property was removed

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)
                              throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

shutdownClient

@OnStopped
public void shutdownClient()

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException