org.apache.nifi.distributed.cache.client

Class DistributedSetCacheClientService

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.distributed.cache.client.DistributedSetCacheClientService

All Implemented Interfaces:

ConfigurableComponent, ControllerService, DistributedSetCacheClient

@Tags(value={"distributed","cache","state","set","cluster"})
 @SeeAlso(classNames={"org.apache.nifi.distributed.cache.server.DistributedSetCacheServer","org.apache.nifi.ssl.StandardSSLContextService"})
 @CapabilityDescription(value="Provides the ability to communicate with a DistributedSetCacheServer. This can be used in order to share a Set between nodes in a NiFi cluster")
public class DistributedSetCacheClientService
extends AbstractControllerService
implements DistributedSetCacheClient

Field Summary

Fields

Modifier and Type	Field and Description
private NettyDistributedSetCacheClient	cacheClient The implementation of the business logic for DistributedSetCacheClientService.
static PropertyDescriptor	COMMUNICATIONS_TIMEOUT
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
DistributedSetCacheClientService()

Method Summary

Modifier and Type	Method and Description
<T> boolean	addIfAbsent(T value, Serializer<T> serializer)
void	close()
<T> boolean	contains(T value, Serializer<T> serializer)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onDisabled()
void	onEnabled(ConfigurationContext context)
void	onStopped()
<T> boolean	remove(T value, Serializer<T> serializer)

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.controller.ControllerService

initialize, isStateful

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

cacheClient

private volatile NettyDistributedSetCacheClient cacheClient

The implementation of the business logic for DistributedSetCacheClientService.

versionNegotiatorFactory

private volatile VersionNegotiatorFactory versionNegotiatorFactory

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

Constructor Detail

DistributedSetCacheClientService

public DistributedSetCacheClientService()

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

addIfAbsent

public <T> boolean addIfAbsent(T value,
                               Serializer<T> serializer)
                        throws IOException

Specified by:

addIfAbsent in interface DistributedSetCacheClient

Throws:

IOException

contains

public <T> boolean contains(T value,
                            Serializer<T> serializer)
                     throws IOException

Specified by:

contains in interface DistributedSetCacheClient

Throws:

IOException

remove

public <T> boolean remove(T value,
                          Serializer<T> serializer)
                   throws IOException

Specified by:

remove in interface DistributedSetCacheClient

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface DistributedSetCacheClient

Throws:

IOException