com.aquenos.cassandra.pvarchiver.server.controlsystem

Interface ControlSystemSupportRegistry

All Known Implementing Classes:

ControlSystemSupportRegistryBean

public interface ControlSystemSupportRegistry

Registry providing access to ControlSystemSupports. The registry can be used by components that need to access a control system in order to get the support module for a specific control system (using getControlSystemSupport(String)) or to get a list of all supported control-systems (using getControlSystemSupports()).

Author:

Sebastian Marsching

Method Summary

Modifier and Type	Method and Description
ControlSystemSupport<?>	getControlSystemSupport(String id) Returns the control-system support with the specified identifier.
Collection<? extends ControlSystemSupport<?>>	getControlSystemSupports() Returns all control-system support modules registered with this registry.
boolean	isAvailable() Tells whether the registry is available (has been initialized and not destroyed yet).

Method Detail

isAvailable

boolean isAvailable()

Tells whether the registry is available (has been initialized and not destroyed yet). Even if the registry is not available, its method can be called safely. However, it typically will not be able to provide any control-system supports unless it is available.

Returns:

true if the registry is ready to provide control-system supports, false otherwise.

getControlSystemSupport

ControlSystemSupport<?> getControlSystemSupport(String id)

Returns the control-system support with the specified identifier. The identifier is the one returned by the ControlSystemSupport.getId() method.

Parameters:

id - identifier of the control-system support module.

Returns:

the requested control-system support module or null if the requested module has not been registered with this registry.

getControlSystemSupports

Collection<? extends ControlSystemSupport<?>> getControlSystemSupports()

Returns all control-system support modules registered with this registry. For example, this can be used to present a list of supported control systems to the user.

Returns:

list of control-system support modules that have been registered with this registry. Might be empty, but is never null.