net.sf.ehcache.management
Interface ManagementServer

public interface ManagementServer

Interface implemented by management servers.

Author:

Ludovic Orban, brandony

Method Summary

void	addClientUUID(String clientUUID) add a reference to the clientUUID to the EhCache Mbean That allows the TSA to keep track of all the toolkit clients available through an agent
boolean	hasRegistered() Returns true if this ManagementServer has any resources registered.
void	initialize(ManagementRESTServiceConfiguration configuration) Initialize method to call just after instantiating the class
void	register(CacheManager managedResource) Puts the submitted resource under the purview of this ManagementServer.
void	registerClusterRemoteEndpoint(String clientUUID) Register the cluster endpoint of a specific client to enable clustered monitoring.
void	removeClientUUID(String clientUUID) remove the reference to the clientUUID from the EhCache Mbean
void	start() Start the management server
void	stop() Stop the management server
void	unregister(CacheManager managedResource) Removes the submitted resource under the purview of this ManagementServer.
void	unregisterClusterRemoteEndpoint() Unregister the previously registered cluster endpoint.

Method Detail

start

void start()

Start the management server

stop

void stop()

Stop the management server

register

void register(CacheManager managedResource)

Puts the submitted resource under the purview of this ManagementServer.

Parameters:

managedResource - the resource to be managed

unregister

void unregister(CacheManager managedResource)

Removes the submitted resource under the purview of this ManagementServer.

Parameters:

managedResource - the resource to be managed

hasRegistered

boolean hasRegistered()

Returns true if this ManagementServer has any resources registered.

Returns:

true if actively managing resources, false if not.

initialize

void initialize(ManagementRESTServiceConfiguration configuration)

Initialize method to call just after instantiating the class

Parameters:

configuration - the configuration of the rest agent

registerClusterRemoteEndpoint

void registerClusterRemoteEndpoint(String clientUUID)

Register the cluster endpoint of a specific client to enable clustered monitoring.

Parameters:

clientUUID - the client UUID

addClientUUID

void addClientUUID(String clientUUID)

add a reference to the clientUUID to the EhCache Mbean That allows the TSA to keep track of all the toolkit clients available through an agent

Parameters:

clientUUID - the client UUID

removeClientUUID

void removeClientUUID(String clientUUID)

remove the reference to the clientUUID from the EhCache Mbean

Parameters:

clientUUID - the client UUID

unregisterClusterRemoteEndpoint

void unregisterClusterRemoteEndpoint()

Unregister the previously registered cluster endpoint.