Package org.apache.nifi.couchbase

Class CouchbaseClusterService

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.couchbase.CouchbaseClusterService

All Implemented Interfaces:

ConfigurableComponent, ControllerService, CouchbaseClusterControllerService

@CapabilityDescription("Provides a centralized Couchbase connection and bucket passwords management. Bucket passwords can be specified via dynamic properties.")
@Tags({"nosql","couchbase","database","connection"})
@DynamicProperty(name="Bucket Password for BUCKET_NAME",
                 value="bucket password",
                 description="Specify bucket password if necessary. Couchbase Server 5.0 or later should use \'User Name\' and \'User Password\' instead.")
public class CouchbaseClusterService
extends AbstractControllerService
implements CouchbaseClusterControllerService

Provides a centralized Couchbase connection and bucket passwords management.

Field Summary

Fields

Modifier and Type	Field	Description
private Map<String,String>	bucketPasswords
private com.couchbase.client.java.CouchbaseCluster	cluster
static final PropertyDescriptor	CONNECTION_STRING
private static final String	DYNAMIC_PROP_BUCKET_PASSWORD
private static final List<PropertyDescriptor>	properties
static final PropertyDescriptor	USER_NAME
static final PropertyDescriptor	USER_PASSWORD

Constructor Summary

Constructors

Constructor	Description
CouchbaseClusterService()

Method Summary

Modifier and Type	Method	Description
protected Collection<ValidationResult>	customValidate(ValidationContext context)
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onConfigured(ConfigurationContext context)	Establish a connection to a Couchbase cluster.
com.couchbase.client.java.Bucket	openBucket(String bucketName)
void	shutdown()	Disconnect from the Couchbase cluster.

Methods inherited from class org.apache.nifi.controller.AbstractControllerService

abstractClearConfigContext, abstractStoreConfigContext, disabled, enabled, getConfigurationContext, getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, getProperty, getStateManager, init, initialize, isEnabled

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

equals, getPropertyDescriptor, getPropertyDescriptors, hashCode, onPropertyModified, toString, 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

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Methods inherited from interface org.apache.nifi.controller.ControllerService

initialize, isStateful, migrateProperties

Field Details

CONNECTION_STRING

public static final PropertyDescriptor CONNECTION_STRING

USER_NAME

public static final PropertyDescriptor USER_NAME

USER_PASSWORD

public static final PropertyDescriptor USER_PASSWORD

properties

private static final List<PropertyDescriptor> properties

DYNAMIC_PROP_BUCKET_PASSWORD

private static final String DYNAMIC_PROP_BUCKET_PASSWORD

See Also:

• Constant Field Values

bucketPasswords

private Map<String,String> bucketPasswords

cluster

private volatile com.couchbase.client.java.CouchbaseCluster cluster

Constructor Details

CouchbaseClusterService

public CouchbaseClusterService()

Method Details

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext context)

Overrides:

customValidate in class AbstractConfigurableComponent

onConfigured

@OnEnabled
public void onConfigured(ConfigurationContext context)
                  throws InitializationException

Establish a connection to a Couchbase cluster.

Parameters:

context - the configuration context

Throws:

InitializationException - if unable to connect a Couchbase cluster

openBucket

public com.couchbase.client.java.Bucket openBucket(String bucketName)

Specified by:

openBucket in interface CouchbaseClusterControllerService

shutdown

@OnDisabled
public void shutdown()

Disconnect from the Couchbase cluster.