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<java.lang.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<java.lang.Long>

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	COMMUNICATIONS_TIMEOUT
static PropertyDescriptor	HOSTNAME
static PropertyDescriptor	PORT
static PropertyDescriptor	SSL_CONTEXT_SERVICE

Constructor Summary

Constructors

Constructor and Description
DistributedMapCacheClientService()

Method Summary

Modifier and Type	Method and Description
void	cacheConfig(ConfigurationContext context)
void	close() Attempts to notify the server that we are finished communicating with it and cleans up resources
<K> boolean	containsKey(K key, Serializer<K> keySerializer) Determines if the given value is present in the cache and if so returns true, else returns false
CommsSession	createCommsSession(ConfigurationContext context)
<K,V> AtomicCacheEntry<K,V,java.lang.Long>	fetch(K key, Serializer<K> keySerializer, Deserializer<V> valueDeserializer) Fetch a CacheEntry with a key.
protected void	finalize()
<K,V> V	get(K key, Serializer<K> keySerializer, Deserializer<V> valueDeserializer) Returns the value in the cache for the given key, if one exists; otherwise returns null
<K,V> V	getAndPutIfAbsent(K key, V value, Serializer<K> keySerializer, Serializer<V> valueSerializer, Deserializer<V> valueDeserializer) Adds the specified key and value to the cache, if they are not already present, serializing the key and value with the given Serializers.
protected java.util.List<PropertyDescriptor>	getSupportedPropertyDescriptors() Allows subclasses to register which property descriptor objects are supported.
void	onStopped()
<K,V> void	put(K key, V value, Serializer<K> keySerializer, Serializer<V> valueSerializer) Adds the specified key and value to the cache, overwriting any value that is currently set.
<K,V> boolean	putIfAbsent(K key, V value, Serializer<K> keySerializer, Serializer<V> valueSerializer) Adds the specified key and value to the cache, if they are not already present, serializing the key and value with the given Serializers.
<K> boolean	remove(K key, Serializer<K> serializer) Removes the entry with the given key from the cache, if it is present.
long	removeByPattern(java.lang.String regex) Removes entries whose keys match the specified pattern
<K,V> boolean	replace(AtomicCacheEntry<K,V,java.lang.Long> entry, Serializer<K> keySerializer, Serializer<V> valueSerializer) Replace an existing key with new value.

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

abstractClearConfigContext, abstractStoreConfigContext, disabled, enabled, getConfigurationContext, getControllerServiceLookup, getIdentifier, getLogger, 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, getClass, notify, notifyAll, wait, wait, wait

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

initialize

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

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

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

Constructor Detail

DistributedMapCacheClientService

public DistributedMapCacheClientService()

Method Detail

getSupportedPropertyDescriptors

protected java.util.List<PropertyDescriptor> getSupportedPropertyDescriptors()

Description copied from class: AbstractConfigurableComponent

Allows subclasses to register which property descriptor objects are supported. Default return is an empty set.

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

Returns:

PropertyDescriptor objects this processor currently supports

cacheConfig

@OnEnabled
public void cacheConfig(ConfigurationContext context)

onStopped

@OnStopped
public void onStopped()
                          throws java.io.IOException

Throws:

java.io.IOException

putIfAbsent

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

Description copied from interface: DistributedMapCacheClient

Adds the specified key and value to the cache, if they are not already present, serializing the key and value with the given Serializers.

Specified by:

putIfAbsent in interface DistributedMapCacheClient

Type Parameters:

K - type of key

V - type of value

Parameters:

key - the key for into the map

value - the value to add to the map if and only if the key is absent

keySerializer - key serializer

valueSerializer - value serializer

Returns:

true if the value was added to the cache, false if the value already existed in the cache

Throws:

java.io.IOException - if unable to communicate with the remote instance

put

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

Description copied from interface: DistributedMapCacheClient

Adds the specified key and value to the cache, overwriting any value that is currently set.

Specified by:

put in interface DistributedMapCacheClient

Type Parameters:

K - the key type

V - the value type

Parameters:

key - The key to set

value - The value to associate with the given Key

keySerializer - the Serializer that will be used to serialize the key into bytes

valueSerializer - the Serializer that will be used to serialize the value into bytes

Throws:

java.io.IOException - if unable to communicate with the remote instance

containsKey

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

Description copied from interface: DistributedMapCacheClient

Determines if the given value is present in the cache and if so returns true, else returns false

Specified by:

containsKey in interface DistributedMapCacheClient

Type Parameters:

K - type of key

Parameters:

key - key

keySerializer - key serializer

Returns:

Determines if the given value is present in the cache and if so returns true, else returns false

Throws:

java.io.IOException - if unable to communicate with the remote instance

getAndPutIfAbsent

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

Description copied from interface: DistributedMapCacheClient

Adds the specified key and value to the cache, if they are not already present, serializing the key and value with the given Serializers. If a value already exists in the cache for the given key, the value associated with the key is returned, after being deserialized with the given valueDeserializer.

Specified by:

getAndPutIfAbsent in interface DistributedMapCacheClient

Type Parameters:

K - type of key

V - type of value

Parameters:

key - key

value - value

keySerializer - key serializer

valueSerializer - key serializer

valueDeserializer - value deserializer

Returns:

If a value already exists in the cache for the given key, the value associated with the key is returned, after being deserialized with the given valueDeserializer

Throws:

java.io.IOException - ex

get

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

Description copied from interface: DistributedMapCacheClient

Returns the value in the cache for the given key, if one exists; otherwise returns null

Specified by:

get in interface DistributedMapCacheClient

Type Parameters:

K - the key type

V - the value type

Parameters:

key - the key to lookup in the map

keySerializer - key serializer

valueDeserializer - value serializer

Returns:

the value in the cache for the given key, if one exists; otherwise returns null

Throws:

java.io.IOException - ex

remove

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

Description copied from interface: DistributedMapCacheClient

Removes the entry with the given key from the cache, if it is present.

Specified by:

remove in interface DistributedMapCacheClient

Type Parameters:

K - type of key

Parameters:

key - key

serializer - serializer

Returns:

true if the entry is removed, false if the key did not exist in the cache

Throws:

java.io.IOException - ex

removeByPattern

public long removeByPattern(java.lang.String regex)
                     throws java.io.IOException

Description copied from interface: DistributedMapCacheClient

Removes entries whose keys match the specified pattern

Specified by:

removeByPattern in interface DistributedMapCacheClient

Parameters:

regex - The regular expression / pattern on which to match the keys to be removed

Returns:

The number of entries that were removed

Throws:

java.io.IOException - if any error occurred while removing an entry

fetch

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

Description copied from interface: AtomicDistributedMapCacheClient

Fetch a CacheEntry with a key.

Specified by:

fetch in interface AtomicDistributedMapCacheClient<java.lang.Long>

Type Parameters:

K - the key type

V - the value type

Parameters:

key - the key to lookup in the map

keySerializer - key serializer

valueDeserializer - value deserializer

Returns:

A CacheEntry instance if one exists, otherwise null.

Throws:

java.io.IOException - if unable to communicate with the remote instance

replace

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

Description copied from interface: AtomicDistributedMapCacheClient

Replace an existing key with new value.

Specified by:

replace in interface AtomicDistributedMapCacheClient<java.lang.Long>

Type Parameters:

K - the key type

V - the value type

Parameters:

entry - should provide the new value for AtomicCacheEntry.getValue(), and the same revision in the cache storage for AtomicCacheEntry.getRevision(), if the revision does not match with the one in the cache storage, value will not be replaced.

keySerializer - key serializer

valueSerializer - value serializer

Returns:

true only if the key is replaced.

Throws:

java.io.IOException - if unable to communicate with the remote instance

createCommsSession

public CommsSession createCommsSession(ConfigurationContext context)
                                throws java.io.IOException

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Description copied from interface: DistributedMapCacheClient

Attempts to notify the server that we are finished communicating with it and cleans up resources

Specified by:

close in interface DistributedMapCacheClient

Throws:

java.io.IOException - ex

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable