org.infinispan.client.hotrod.counter.impl

Class RemoteCounterManager

java.lang.Object

org.infinispan.client.hotrod.counter.impl.RemoteCounterManager

All Implemented Interfaces:

CounterManager

public class RemoteCounterManager
extends Object
implements CounterManager

A CounterManager implementation for Hot Rod clients.

Since:

9.2

Author:

Pedro Ruivo

Constructor Summary

Constructors

Constructor and Description
RemoteCounterManager()

Method Summary

Modifier and Type	Method and Description
boolean	defineCounter(String name, CounterConfiguration configuration) Defines a counter with the specific name and CounterConfiguration.
CounterConfiguration	getConfiguration(String counterName)
Collection<String>	getCounterNames() Returns a Collection of defined counter names.
StrongCounter	getStrongCounter(String name) Returns the StrongCounter with that specific name.
WeakCounter	getWeakCounter(String name) Returns the WeakCounter with that specific name.
boolean	isDefined(String name)
void	remove(String counterName) It removes the counter from the cluster.
void	start(ChannelFactory channelFactory, Codec codec, Configuration configuration, ClientListenerNotifier listenerNotifier)
void	stop()
void	undefineCounter(String name) It removes the counter and its configuration from the cluster.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteCounterManager

public RemoteCounterManager()

Method Detail

start

public void start(ChannelFactory channelFactory,
                  Codec codec,
                  Configuration configuration,
                  ClientListenerNotifier listenerNotifier)

getStrongCounter

public StrongCounter getStrongCounter(String name)

Description copied from interface: CounterManager

Returns the StrongCounter with that specific name.

If the StrongCounter does not exists, it is created based on the CounterConfiguration.

Note that the counter must be defined prior to this method invocation using CounterManager.defineCounter(String, CounterConfiguration) or via global configuration. This method only supports CounterType.BOUNDED_STRONG and CounterType.UNBOUNDED_STRONG counters.

Specified by:

getStrongCounter in interface CounterManager

Parameters:

name - the counter name.

Returns:

the StrongCounter instance.

getWeakCounter

public WeakCounter getWeakCounter(String name)

Description copied from interface: CounterManager

Returns the WeakCounter with that specific name.

If the WeakCounter does not exists, it is created based on the CounterConfiguration.

Note that the counter must be defined prior to this method invocation using CounterManager.defineCounter(String, CounterConfiguration) or via global configuration. This method only supports CounterType.WEAK counters.

Specified by:

getWeakCounter in interface CounterManager

Parameters:

name - the counter name.

Returns:

the WeakCounter instance.

defineCounter

public boolean defineCounter(String name,
                             CounterConfiguration configuration)

Description copied from interface: CounterManager

Defines a counter with the specific name and CounterConfiguration.

It does not overwrite existing configurations.

Specified by:

defineCounter in interface CounterManager

Parameters:

name - the counter name.

configuration - the counter configuration

Returns:

true if successfully defined or false if the counter exists or fails to defined.

undefineCounter

public void undefineCounter(String name)

Description copied from interface: CounterManager

It removes the counter and its configuration from the cluster.

Specified by:

undefineCounter in interface CounterManager

Parameters:

name - The counter's name to remove

isDefined

public boolean isDefined(String name)

Specified by:

isDefined in interface CounterManager

Parameters:

name - the counter name.

Returns:

true if the counter is defined or false if the counter is not defined or fails to check.

getConfiguration

public CounterConfiguration getConfiguration(String counterName)

Specified by:

getConfiguration in interface CounterManager

Parameters:

counterName - the counter name.

Returns:

the counter's CounterConfiguration or null if the counter is not defined.

remove

public void remove(String counterName)

Description copied from interface: CounterManager

It removes the counter from the cluster.

All instances returned by CounterManager.getWeakCounter(String) or CounterManager.getStrongCounter(String) are destroyed and they shouldn't be used anymore. Also, the registered CounterListeners are removed and they aren't invoked anymore.

Specified by:

remove in interface CounterManager

Parameters:

counterName - The counter's name to remove.

getCounterNames

public Collection<String> getCounterNames()

Description copied from interface: CounterManager

Returns a Collection of defined counter names.

Specified by:

getCounterNames in interface CounterManager

Returns:

a Collection of defined counter names.

stop

public void stop()