Package org.infinispan.counter.impl.manager

Class EmbeddedCounterManager

java.lang.Object

org.infinispan.counter.impl.manager.EmbeddedCounterManager

All Implemented Interfaces:

CounterManager

@MBean(objectName="CounterManager",
       description="Component to manage counters")
public class EmbeddedCounterManager
extends Object
implements CounterManager

A CounterManager implementation for embedded cache manager.

Since:

9.0

Author:

Pedro Ruivo

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OBJECT_NAME

Constructor Summary

Constructors

Constructor	Description
EmbeddedCounterManager()

Method Summary

Modifier and Type	Method	Description
boolean	defineCounter(String name, CounterConfiguration configuration)	Defines a counter with the specific name and CounterConfiguration.
CompletableFuture<Boolean>	defineCounterAsync(String name, CounterConfiguration configuration)
CounterConfiguration	getConfiguration(String counterName)
CompletableFuture<CounterConfiguration>	getConfigurationAsync(String name)
Properties	getCounterConfiguration(String counterName)
Collection<String>	getCounterNames()	Returns a Collection of defined counter names.
CompletionStage<InternalCounterAdmin>	getOrCreateAsync(String counterName)
StrongCounter	getStrongCounter(String name)	Returns the StrongCounter with that specific name.
CompletionStage<StrongCounter>	getStrongCounterAsync(String counterName)
long	getValue(String counterName)
WeakCounter	getWeakCounter(String name)	Returns the WeakCounter with that specific name.
CompletionStage<WeakCounter>	getWeakCounterAsync(String counterName)
boolean	isDefined(String name)
CompletableFuture<Boolean>	isDefinedAsync(String name)
void	remove(String counterName)	It removes the counter from the cluster.
CompletionStage<Void>	removeAsync(String counterName, boolean keepConfig)
void	reset(String counterName)
void	start()
void	stop()
void	undefineCounter(String counterName)	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

Field Details

OBJECT_NAME

public static final String OBJECT_NAME

See Also:

• Constant Field Values

Constructor Details

EmbeddedCounterManager

public EmbeddedCounterManager()

Method Details

start

public void start()

stop

public void stop()

remove

@ManagedOperation(description="Removes the counter\'s value from the cluster. The counter will be re-created when access next time.",
                  displayName="Remove Counter",
                  name="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.

removeAsync

public CompletionStage<Void> removeAsync(String counterName,
 boolean keepConfig)

undefineCounter

public void undefineCounter(String counterName)

Description copied from interface: CounterManager

It removes the counter and its configuration from the cluster.

Specified by:

undefineCounter in interface CounterManager

Parameters:

counterName - The counter's name to remove

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.

getStrongCounterAsync

public CompletionStage<StrongCounter> getStrongCounterAsync(String counterName)

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.

getWeakCounterAsync

public CompletionStage<WeakCounter> getWeakCounterAsync(String counterName)

getOrCreateAsync

public CompletionStage<InternalCounterAdmin> getOrCreateAsync(String counterName)

getCounterNames

@ManagedOperation(description="Returns a collection of defined counter\'s name.",
                  displayName="Get Defined Counters",
                  name="counters")
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.

defineCounterAsync

public CompletableFuture<Boolean> defineCounterAsync(String name,
 CounterConfiguration configuration)

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.

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.

getConfigurationAsync

public CompletableFuture<CounterConfiguration> getConfigurationAsync(String name)

getValue

@ManagedOperation(description="Returns the current counter\'s value",
                  displayName="Get Counter\' Value",
                  name="value")
public long getValue(String counterName)

reset

@ManagedOperation(description="Resets the counter\'s value",
                  displayName="Reset Counter",
                  name="reset")
public void reset(String counterName)

getCounterConfiguration

@ManagedOperation(description="Returns the counter\'s configuration",
                  displayName="Counter Configuration",
                  name="configuration")
public Properties getCounterConfiguration(String counterName)

isDefinedAsync

public CompletableFuture<Boolean> isDefinedAsync(String name)