Package org.apache.nifi.couchbase

Class CouchbaseMapCacheClient

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.couchbase.CouchbaseMapCacheClient

All Implemented Interfaces:

ConfigurableComponent, ControllerService, AtomicDistributedMapCacheClient<Long>, DistributedMapCacheClient

@Tags({"distributed","cache","map","cluster","couchbase"})
@CapabilityDescription("Provides the ability to communicate with a Couchbase Server cluster as a DistributedMapCacheServer. This can be used in order to share a Map between nodes in a NiFi cluster. Couchbase Server cluster can provide a high available and persistent cache storage.")
public class CouchbaseMapCacheClient
extends AbstractControllerService
implements AtomicDistributedMapCacheClient<Long>

Field Summary

Fields

Modifier and Type	Field	Description
private com.couchbase.client.java.Bucket	bucket
private CouchbaseClusterControllerService	clusterService
private static final org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor	Description
CouchbaseMapCacheClient()

Method Summary

Modifier and Type	Method	Description
void	close()
void	configure(ConfigurationContext context)
<K> boolean	containsKey(K key, Serializer<K> keySerializer)
private <V> V	deserialize(com.couchbase.client.java.document.BinaryDocument doc, Deserializer<V> valueDeserializer)
<K, V> AtomicCacheEntry<K,V,Long>	fetch(K key, Serializer<K> keySerializer, Deserializer<V> valueDeserializer)
<K, V> V	get(K key, Serializer<K> keySerializer, Deserializer<V> valueDeserializer)
<K, V> V	getAndPutIfAbsent(K key, V value, Serializer<K> keySerializer, Serializer<V> valueSerializer, Deserializer<V> valueDeserializer)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
<K, V> void	put(K key, V value, Serializer<K> keySerializer, Serializer<V> valueSerializer)
<K, V> boolean	putIfAbsent(K key, V value, Serializer<K> keySerializer, Serializer<V> valueSerializer)
<K> boolean	remove(K key, Serializer<K> serializer)
long	removeByPattern(String regex)
<K, V> boolean	replace(AtomicCacheEntry<K,V,Long> entry, Serializer<K> keySerializer, Serializer<V> valueSerializer)
private <V> com.couchbase.client.java.document.Document	toDocument(String docId, V value, Serializer<V> valueSerializer)
private <V> com.couchbase.client.java.document.Document	toDocument(String docId, V value, Serializer<V> valueSerializer, long revision)
private <K> String	toDocumentId(K key, Serializer<K> keySerializer)

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

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

Methods inherited from interface org.apache.nifi.distributed.cache.client.DistributedMapCacheClient

keySet, putAll, removeAndGet, removeByPatternAndGet, subMap

Field Details

logger

private static final org.slf4j.Logger logger

clusterService

private CouchbaseClusterControllerService clusterService

bucket

private com.couchbase.client.java.Bucket bucket

Constructor Details

CouchbaseMapCacheClient

public CouchbaseMapCacheClient()

Method Details

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

configure

@OnEnabled
public void configure(ConfigurationContext context)

toDocument

private <V>
com.couchbase.client.java.document.Document toDocument(String docId,
 V value,
 Serializer<V> valueSerializer)
                                                throws IOException

Throws:

IOException

toDocument

private <V>
com.couchbase.client.java.document.Document toDocument(String docId,
 V value,
 Serializer<V> valueSerializer,
 long revision)
                                                throws IOException

Throws:

IOException

toDocumentId

private <K> String toDocumentId(K key,
 Serializer<K> keySerializer)
                         throws IOException

Throws:

IOException

putIfAbsent

public <K,
V> boolean putIfAbsent(K key,
 V value,
 Serializer<K> keySerializer,
 Serializer<V> valueSerializer)
                           throws IOException

Specified by:

putIfAbsent in interface DistributedMapCacheClient

Throws:

IOException

fetch

public <K,
V> AtomicCacheEntry<K,V,Long> fetch(K key,
 Serializer<K> keySerializer,
 Deserializer<V> valueDeserializer)
                                        throws IOException

Specified by:

fetch in interface AtomicDistributedMapCacheClient<Long>

Throws:

IOException

getAndPutIfAbsent

public <K,
V> V getAndPutIfAbsent(K key,
 V value,
 Serializer<K> keySerializer,
 Serializer<V> valueSerializer,
 Deserializer<V> valueDeserializer)
                           throws IOException

Specified by:

getAndPutIfAbsent in interface DistributedMapCacheClient

Throws:

IOException

replace

public <K,
V> boolean replace(AtomicCacheEntry<K,V,Long> entry,
 Serializer<K> keySerializer,
 Serializer<V> valueSerializer)
                       throws IOException

Specified by:

replace in interface AtomicDistributedMapCacheClient<Long>

Throws:

IOException

containsKey

public <K> boolean containsKey(K key,
 Serializer<K> keySerializer)
                        throws IOException

Specified by:

containsKey in interface DistributedMapCacheClient

Throws:

IOException

put

public <K,
V> void put(K key,
 V value,
 Serializer<K> keySerializer,
 Serializer<V> valueSerializer)
                throws IOException

Specified by:

put in interface DistributedMapCacheClient

Throws:

IOException

get

public <K,
V> V get(K key,
 Serializer<K> keySerializer,
 Deserializer<V> valueDeserializer)
             throws IOException

Specified by:

get in interface DistributedMapCacheClient

Throws:

IOException

deserialize

private <V> V deserialize(com.couchbase.client.java.document.BinaryDocument doc,
 Deserializer<V> valueDeserializer)
                   throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface DistributedMapCacheClient

Throws:

IOException

remove

public <K> boolean remove(K key,
 Serializer<K> serializer)
                   throws IOException

Specified by:

remove in interface DistributedMapCacheClient

Throws:

IOException

removeByPattern

public long removeByPattern(String regex)
                     throws IOException

Specified by:

removeByPattern in interface DistributedMapCacheClient

Throws:

IOException