de.janrufmonitor.framework.configuration
Interface IConfigurableNotifier

public interface IConfigurableNotifier

This interface must be implemented by a configurable notifier object. This component has to inform all registered configurable obejcts due to changes in their configuration. Therefor this implementation must interact with a configuration manager.

Author:

Thilo Brandt

Method Summary

String[]	getAllConfigurableIDs() Get all configurable IDs which are registered.
String[]	getAllConfigurableNamespaces() Get all namespaces which are registered.
int	getConfigurableCount() Get the number of configurables which are registered.
String	getConfigurableNamespace(String id) Get the namespace of the specified configurable.
boolean	isRegistered(String id) Checks wether a configurable with the specified ID is registered or not.
void	notifyAllConfigurables() Notifies all configurables with their current configuration.
void	notifyByNamespace(String namespace) Notifies all configurables which have been registered for the given namespace.
void	notifyConfigurable(String configurableId) Notifies the configurable object identified by the given configurableId.
void	register(IConfigurable c) Registers a new configurable object.
void	shutdown() This method is called on shutdown time by the runtime object.
void	startup() This method is called on startup time by the runtime object.
void	unregister(IConfigurable c) Unregisters a new configurable object.

Method Detail

register

void register(IConfigurable c)

Registers a new configurable object.

Parameters:

c - the object to be registered

unregister

void unregister(IConfigurable c)

Unregisters a new configurable object.

Parameters:

c - the object to be unregistered

notifyConfigurable

void notifyConfigurable(String configurableId)

Notifies the configurable object identified by the given configurableId.

Parameters:

configurableId - the configurable ID to be notified.

notifyByNamespace

void notifyByNamespace(String namespace)

Notifies all configurables which have been registered for the given namespace.

Parameters:

namespace - the namespace to be notified.

notifyAllConfigurables

void notifyAllConfigurables()

Notifies all configurables with their current configuration.

getAllConfigurableIDs

String[] getAllConfigurableIDs()

Get all configurable IDs which are registered.

Returns:

Array of configurable IDs

getAllConfigurableNamespaces

String[] getAllConfigurableNamespaces()

Get all namespaces which are registered.

Returns:

Array of namespaces

getConfigurableCount

int getConfigurableCount()

Get the number of configurables which are registered.

Returns:

number of configurables

getConfigurableNamespace

String getConfigurableNamespace(String id)

Get the namespace of the specified configurable.

Returns:

namespace of configurable

startup

void startup()

This method is called on startup time by the runtime object.

shutdown

void shutdown()

This method is called on shutdown time by the runtime object.

isRegistered

boolean isRegistered(String id)

Checks wether a configurable with the specified ID is registered or not.

Parameters:

id - ID to check

Returns:

true is it is registered, false if not.