org.apache.nifi.distributed.cache.client

Class NettyDistributedSetCacheClient

java.lang.Object

org.apache.nifi.distributed.cache.client.DistributedCacheClient

org.apache.nifi.distributed.cache.client.NettyDistributedSetCacheClient

public class NettyDistributedSetCacheClient
extends DistributedCacheClient

The implementation of the DistributedCacheClient using the netty library to provide the remote communication services.

Constructor Summary

Constructors

Constructor and Description
NettyDistributedSetCacheClient(String hostname, int port, int timeoutMillis, SSLContextService sslContextService, VersionNegotiatorFactory factory) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	addIfAbsent(byte[] value) Adds the specified value to the cache.
void	close() Perform a clean shutdown of the cache client.
boolean	contains(byte[] value) Check for the existence of the specified value in the cache.
boolean	remove(byte[] value) Removes the given value from the cache, if it is present.

Methods inherited from class org.apache.nifi.distributed.cache.client.DistributedCacheClient

closeChannelPool, invoke

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NettyDistributedSetCacheClient

public NettyDistributedSetCacheClient(String hostname,
                                      int port,
                                      int timeoutMillis,
                                      SSLContextService sslContextService,
                                      VersionNegotiatorFactory factory)

Constructor.

Parameters:

hostname - the network name / IP address of the server running the distributed cache service

port - the port on which the distributed cache service is running

timeoutMillis - the network timeout associated with requests to the service

sslContextService - the SSL context (if any) associated with requests to the service; if not specified, communications will not be encrypted

factory - creator of object used to broker the version of the distributed cache protocol with the service

Method Detail

addIfAbsent

public boolean addIfAbsent(byte[] value)
                    throws IOException

Adds the specified value to the cache.

Parameters:

value - the value to be added

Returns:

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

Throws:

IOException - if unable to communicate with the remote instance

contains

public boolean contains(byte[] value)
                 throws IOException

Check for the existence of the specified value in the cache.

Parameters:

value - the value to be checked

Returns:

true iff the value exists in the cache

Throws:

IOException - if unable to communicate with the remote instance

remove

public boolean remove(byte[] value)
               throws IOException

Removes the given value from the cache, if it is present.

Parameters:

value - the value to be removed

Returns:

true iff the value existed in the cache

Throws:

IOException - if unable to communicate with the remote instance

close

public void close()
           throws IOException

Perform a clean shutdown of the cache client.

Throws:

IOException - if unable to communicate with the remote instance