org.apache.nifi.processors.couchbase

Class GetCouchbaseKey

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.couchbase.AbstractCouchbaseProcessor

org.apache.nifi.processors.couchbase.GetCouchbaseKey

All Implemented Interfaces:

ConfigurableComponent, Processor

@Tags(value={"nosql","couchbase","database","get"})
 @InputRequirement(value=INPUT_REQUIRED)
 @CapabilityDescription(value="Get a document from Couchbase Server via Key/Value access. The ID of the document to fetch may be supplied by setting the <Document Id> property. NOTE: if the Document Id property is not set, the contents of the FlowFile will be read to determine the Document Id, which means that the contents of the entire FlowFile will be buffered in memory.")
 @WritesAttribute(attribute="couchbase.cluster",description="Cluster where the document was retrieved from.") @WritesAttribute(attribute="couchbase.bucket",description="Bucket where the document was retrieved from.") @WritesAttribute(attribute="couchbase.doc.id",description="Id of the document.") @WritesAttribute(attribute="couchbase.doc.cas",description="CAS of the document.") @WritesAttribute(attribute="couchbase.doc.expiry",description="Expiration of the document.") @WritesAttribute(attribute="couchbase.exception",description="If Couchbase related error occurs the CouchbaseException class name will be captured here.")
 @SystemResourceConsideration(resource=MEMORY)
public class GetCouchbaseKey
extends AbstractCouchbaseProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	PUT_VALUE_TO_ATTRIBUTE
private boolean	putToAttribute

Fields inherited from class org.apache.nifi.processors.couchbase.AbstractCouchbaseProcessor

DOC_ID, REL_FAILURE, REL_ORIGINAL, REL_RETRY, REL_SUCCESS

Constructor Summary

Constructors

Constructor and Description
GetCouchbaseKey()

Method Summary

Modifier and Type	Method and Description
protected void	addSupportedProperties(List<PropertyDescriptor> descriptors) Add processor specific properties.
protected void	addSupportedRelationships(Set<Relationship> relationships) Add processor specific relationships.
protected Set<Relationship>	filterRelationships(Set<Relationship> rels)
void	onPropertyModified(PropertyDescriptor descriptor, String oldValue, String newValue)
void	onTrigger(ProcessContext context, ProcessSession session)

Methods inherited from class org.apache.nifi.processors.couchbase.AbstractCouchbaseProcessor

getRelationships, getSupportedPropertyDescriptors, getTransitUrl, handleCouchbaseException, init, openBucket

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

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

isStateful

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

getPropertyDescriptor, getPropertyDescriptors, validate

Field Detail

PUT_VALUE_TO_ATTRIBUTE

public static final PropertyDescriptor PUT_VALUE_TO_ATTRIBUTE

putToAttribute

private volatile boolean putToAttribute

Constructor Detail

GetCouchbaseKey

public GetCouchbaseKey()

Method Detail

addSupportedProperties

protected void addSupportedProperties(List<PropertyDescriptor> descriptors)

Description copied from class: AbstractCouchbaseProcessor

Add processor specific properties.

Overrides:

addSupportedProperties in class AbstractCouchbaseProcessor

Parameters:

descriptors - add properties to this list

addSupportedRelationships

protected void addSupportedRelationships(Set<Relationship> relationships)

Description copied from class: AbstractCouchbaseProcessor

Add processor specific relationships.

Overrides:

addSupportedRelationships in class AbstractCouchbaseProcessor

Parameters:

relationships - add relationships to this list

filterRelationships

protected Set<Relationship> filterRelationships(Set<Relationship> rels)

Overrides:

filterRelationships in class AbstractCouchbaseProcessor

onPropertyModified

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

Specified by:

onPropertyModified in interface ConfigurableComponent

Overrides:

onPropertyModified in class AbstractConfigurableComponent

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException