Package org.apache.nifi.processors.couchbase

Class AbstractCouchbaseProcessor

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.couchbase.AbstractCouchbaseProcessor

All Implemented Interfaces:

ConfigurableComponent, Processor

Direct Known Subclasses:

GetCouchbaseKey, PutCouchbaseKey

public abstract class AbstractCouchbaseProcessor
extends AbstractProcessor

Provides common functionality for Couchbase processors.

Field Summary

Fields

Modifier and Type	Field	Description
private CouchbaseClusterControllerService	clusterService
private List<PropertyDescriptor>	descriptors
(package private) static final PropertyDescriptor	DOC_ID
(package private) static final Relationship	REL_FAILURE
(package private) static final Relationship	REL_ORIGINAL
(package private) static final Relationship	REL_RETRY
(package private) static final Relationship	REL_SUCCESS
private Set<Relationship>	relationships

Constructor Summary

Constructors

Constructor	Description
AbstractCouchbaseProcessor()

Method Summary

Modifier and Type	Method	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)
private CouchbaseClusterControllerService	getClusterService(ProcessContext context)
final Set<Relationship>	getRelationships()
final List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected String	getTransitUrl(com.couchbase.client.java.Bucket bucket, String docId)	Generate a transit url.
protected void	handleCouchbaseException(ProcessContext context, ProcessSession session, ComponentLog logger, FlowFile inFile, com.couchbase.client.core.CouchbaseException e, String errMsg)	Handles the thrown CouchbaseException accordingly.
protected final void	init(ProcessorInitializationContext context)
protected final com.couchbase.client.java.Bucket	openBucket(ProcessContext context)	Open a bucket connection using a CouchbaseClusterControllerService.

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

onTrigger, 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, onPropertyModified, 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, onPropertyModified, validate

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

isStateful, migrateProperties, migrateRelationships

Field Details

DOC_ID

static final PropertyDescriptor DOC_ID

REL_ORIGINAL

static final Relationship REL_ORIGINAL

REL_SUCCESS

static final Relationship REL_SUCCESS

REL_RETRY

static final Relationship REL_RETRY

REL_FAILURE

static final Relationship REL_FAILURE

descriptors

private List<PropertyDescriptor> descriptors

relationships

private Set<Relationship> relationships

clusterService

private CouchbaseClusterControllerService clusterService

Constructor Details

AbstractCouchbaseProcessor

public AbstractCouchbaseProcessor()

Method Details

init

protected final void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

addSupportedProperties

protected void addSupportedProperties(List<PropertyDescriptor> descriptors)

Add processor specific properties.

Parameters:

descriptors - add properties to this list

addSupportedRelationships

protected void addSupportedRelationships(Set<Relationship> relationships)

Add processor specific relationships.

Parameters:

relationships - add relationships to this list

getRelationships

public final Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

filterRelationships

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

getSupportedPropertyDescriptors

public final List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getClusterService

private CouchbaseClusterControllerService getClusterService(ProcessContext context)

openBucket

protected final com.couchbase.client.java.Bucket openBucket(ProcessContext context)

Open a bucket connection using a CouchbaseClusterControllerService.

Parameters:

context - a process context

Returns:

a bucket instance

getTransitUrl

protected String getTransitUrl(com.couchbase.client.java.Bucket bucket,
 String docId)

Generate a transit url.

Parameters:

bucket - the target bucket

Returns:

a transit url based on the bucket name and the CouchbaseClusterControllerService name

handleCouchbaseException

protected void handleCouchbaseException(ProcessContext context,
 ProcessSession session,
 ComponentLog logger,
 FlowFile inFile,
 com.couchbase.client.core.CouchbaseException e,
 String errMsg)

Handles the thrown CouchbaseException accordingly.

Parameters:

context - a process context

session - a process session

logger - a logger

inFile - an input FlowFile

e - the thrown CouchbaseException

errMsg - a message to be logged