Top Description Methods
net.sf.ehcache.management

public Interface ManagementServer

Imports
net.sf.ehcache.CacheManager, net.sf.ehcache.config.ManagementRESTServiceConfiguration

Interface implemented by management servers.
Authors
Ludovic Orban, brandony

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if actively managing resources, false if not.
hasRegistered
()

Returns true if this ManagementServer has any resources registered.

public void
initialize(ManagementRESTServiceConfiguration
the configuration of the rest agent
configuration
)

Initialize method to call just after instantiating the class

public void
register(CacheManager
the resource to be managed
managedResource
)

Puts the submitted resource under the purview of this ManagementServer.

public void
registerClusterRemoteEndpoint(String
the client UUID
clientUUID
)

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

public void
start()

Start the management server

public void
stop()

Stop the management server

public void
unregister(CacheManager
the resource to be managed
managedResource
)

Removes the submitted resource under the purview of this ManagementServer.

public void
unregisterClusterRemoteEndpoint(String
the client UUID
clientUUID
)

Unregister a previously registered cluster endpoint.

Method Detail

hasRegisteredback to summary
public boolean hasRegistered()

Returns true if this ManagementServer has any resources registered.

Returns:boolean

true if actively managing resources, false if not.

initializeback to summary
public void initialize(ManagementRESTServiceConfiguration configuration)

Initialize method to call just after instantiating the class

Parameters
configuration:ManagementRESTServiceConfiguration

the configuration of the rest agent

registerback to summary
public void register(CacheManager managedResource)

Puts the submitted resource under the purview of this ManagementServer.

Parameters
managedResource:CacheManager

the resource to be managed

registerClusterRemoteEndpointback to summary
public void registerClusterRemoteEndpoint(String clientUUID)

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

Parameters
clientUUID:String

the client UUID

startback to summary
public void start()

Start the management server

stopback to summary
public void stop()

Stop the management server

unregisterback to summary
public void unregister(CacheManager managedResource)

Removes the submitted resource under the purview of this ManagementServer.

Parameters
managedResource:CacheManager

the resource to be managed

unregisterClusterRemoteEndpointback to summary
public void unregisterClusterRemoteEndpoint(String clientUUID)

Unregister a previously registered cluster endpoint.

Parameters
clientUUID:String

the client UUID