org.apache.nifi.distributed.cache.client

Class DistributedMapCacheClientService

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService

All Implemented Interfaces:

ConfigurableComponent, ControllerService, AtomicDistributedMapCacheClient<Long>, DistributedMapCacheClient

@Tags(value={"distributed","cache","state","map","cluster"})
 @SeeAlso(classNames={"org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer","org.apache.nifi.ssl.StandardSSLContextService"})
 @CapabilityDescription(value="Provides the ability to communicate with a DistributedMapCacheServer. This can be used in order to share a Map between nodes in a NiFi cluster")
public class DistributedMapCacheClientService
extends AbstractControllerService
implements AtomicDistributedMapCacheClient<Long>

Field Summary

Fields

Modifier and Type	Field and Description
private NettyDistributedMapCacheClient	cacheClient The implementation of the business logic for DistributedMapCacheClientService.
static PropertyDescriptor	COMMUNICATIONS_TIMEOUT
private static long	DEFAULT_CACHE_REVISION
static PropertyDescriptor	HOSTNAME
static PropertyDescriptor	PORT
static PropertyDescriptor	SSL_CONTEXT_SERVICE
private VersionNegotiatorFactory	versionNegotiatorFactory Creator of object used to broker the version of the distributed cache protocol with the service.

Constructor Summary

Constructors

Constructor and Description
DistributedMapCacheClientService()

Method Summary

Modifier and Type	Method and Description
void	close()
<K> boolean	containsKey(K key, Serializer<K> keySerializer)
<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> Set<K>	keySet(Deserializer<K> keyDeserializer)
void	onDisabled()
void	onEnabled(ConfigurationContext context)
void	onStopped()
<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)
<K,V> V	removeAndGet(K key, Serializer<K> keySerializer, Deserializer<V> valueDeserializer)
long	removeByPattern(String regex)
<K,V> Map<K,V>	removeByPatternAndGet(String regex, Deserializer<K> keyDeserializer, Deserializer<V> valueDeserializer)
<K,V> boolean	replace(AtomicCacheEntry<K,V,Long> entry, Serializer<K> keySerializer, Serializer<V> valueSerializer)
<K,V> Map<K,V>	subMap(Set<K> keys, Serializer<K> keySerializer, Deserializer<V> valueDeserializer)

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.distributed.cache.client.DistributedMapCacheClient

putAll

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

initialize, isStateful

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

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

DEFAULT_CACHE_REVISION

private static final long DEFAULT_CACHE_REVISION

See Also:

Constant Field Values

HOSTNAME

public static final PropertyDescriptor HOSTNAME

PORT

public static final PropertyDescriptor PORT

SSL_CONTEXT_SERVICE

public static final PropertyDescriptor SSL_CONTEXT_SERVICE

COMMUNICATIONS_TIMEOUT

public static final PropertyDescriptor COMMUNICATIONS_TIMEOUT

cacheClient

private volatile NettyDistributedMapCacheClient cacheClient

The implementation of the business logic for DistributedMapCacheClientService.

versionNegotiatorFactory

private volatile VersionNegotiatorFactory versionNegotiatorFactory

Creator of object used to broker the version of the distributed cache protocol with the service.

Constructor Detail

DistributedMapCacheClientService

public DistributedMapCacheClientService()

Method Detail

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

onEnabled

@OnEnabled
public void onEnabled(ConfigurationContext context)

onDisabled

@OnDisabled
public void onDisabled()
                            throws IOException

Throws:

IOException

onStopped

@OnStopped
public void onStopped()
                          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

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

containsKey

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

Specified by:

containsKey in interface DistributedMapCacheClient

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

get

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

Specified by:

get in interface DistributedMapCacheClient

Throws:

IOException

subMap

public <K,V> Map<K,V> subMap(Set<K> keys,
                             Serializer<K> keySerializer,
                             Deserializer<V> valueDeserializer)
                      throws IOException

Specified by:

subMap 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

removeAndGet

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

Specified by:

removeAndGet in interface DistributedMapCacheClient

Throws:

IOException

removeByPattern

public long removeByPattern(String regex)
                     throws IOException

Specified by:

removeByPattern in interface DistributedMapCacheClient

Throws:

IOException

removeByPatternAndGet

public <K,V> Map<K,V> removeByPatternAndGet(String regex,
                                            Deserializer<K> keyDeserializer,
                                            Deserializer<V> valueDeserializer)
                                     throws IOException

Specified by:

removeByPatternAndGet 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

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

keySet

public <K> Set<K> keySet(Deserializer<K> keyDeserializer)
                  throws IOException

Specified by:

keySet in interface DistributedMapCacheClient

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface DistributedMapCacheClient

Throws:

IOException