org.ehcache.management
Interface ManagementRegistry

All Superinterfaces:
CapabilityManagementSupport, Service
All Known Implementing Classes:
DefaultManagementRegistry

public interface ManagementRegistry
extends CapabilityManagementSupport, Service

Repository of objects exposing capabilities via the management and monitoring facilities.

A ManagementRegistry manages one and only one cache manager. If you need to manage or monitor several cache managers at a time, you can use the SharedManagementService and register it into several cache managers.


Method Summary
 void addManagementProvider(ManagementProvider<?> provider)
          Adds to this registry a specific management provider for object types T
 java.util.Collection<org.terracotta.management.capabilities.Capability> getCapabilities()
          Get the management capabilities of the registered objects.
 ManagementRegistryConfiguration getConfiguration()
           
 org.terracotta.management.context.ContextContainer getContext()
          Get the management context required to make use of the registered objects' capabilities.
 void register(java.lang.Object managedObject)
          Register an object in the management registry.
 void removeManagementProvider(ManagementProvider<?> provider)
          Removes from this registry a specific management provider for object types T
 void unregister(java.lang.Object managedObject)
          Unregister an object from the management registry.
 
Methods inherited from interface org.ehcache.management.CapabilityManagementSupport
getManagementProvidersByCapability, withCapability
 
Methods inherited from interface org.ehcache.spi.service.Service
start, stop
 

Method Detail

getConfiguration

ManagementRegistryConfiguration getConfiguration()
Returns:
This registry configuration

addManagementProvider

void addManagementProvider(ManagementProvider<?> provider)
Adds to this registry a specific management provider for object types T

Parameters:
provider - The management provider instance

removeManagementProvider

void removeManagementProvider(ManagementProvider<?> provider)
Removes from this registry a specific management provider for object types T

Parameters:
provider - The management provider instance

register

void register(java.lang.Object managedObject)
Register an object in the management registry.

Parameters:
managedObject - the managed object.

unregister

void unregister(java.lang.Object managedObject)
Unregister an object from the management registry.

Parameters:
managedObject - the managed object.

getCapabilities

java.util.Collection<org.terracotta.management.capabilities.Capability> getCapabilities()
Get the management capabilities of the registered objects.

Returns:
a collection of capabilities.

getContext

org.terracotta.management.context.ContextContainer getContext()
Get the management context required to make use of the registered objects' capabilities.

Returns:
a this management registry context.