com.sun.slamd.server
Interface ConfigSubscriber

All Known Implementing Classes:

AdminServlet, ClientListener, ClientManagerListener, Logger, LoggerThread, ResourceMonitorClientListener, Scheduler, SLAMDServer, SMTPMailer, StatListener

public interface ConfigSubscriber

This interface specifies a method that can be used to dynamically cause SLAMD components to refresh their configuration. It should be implemented by any SLAMD component that obtains configuration information through the SLAMDConfigHandler so that there is a way to make configuration changes on the fly. It is up to each component implementing this interface to decide how best to handle any configuration changes. Any component that is a SLAMDConfigSubscriber also needs to register with the SLAMDConfigHandler using the registerAsSubscriber method.

Method Summary

java.lang.String	getSubscriberName() Retrieves the name that this configuration subscriber uses to identify itself to the configuration handler.
ParameterList	getSubscriberParameters() Retrieves the set of configuration parameters associated with this configuration subscriber.
void	refreshSubscriberConfiguration() Indicates that the implementer should re-read all of its configuration information from the configuration handler and make any necessary changes to its behavior.
void	refreshSubscriberConfiguration(java.lang.String parameterName) Indicates that the implementer should re-read the specified configuration parameter from the configuration handler and make any necessary changes to its behavior.

Method Detail

getSubscriberName

public java.lang.String getSubscriberName()

Retrieves the name that this configuration subscriber uses to identify itself to the configuration handler.

Returns:

The name that this configuration subscriber uses to identify itself to the configuration handler.

getSubscriberParameters

public ParameterList getSubscriberParameters()

Retrieves the set of configuration parameters associated with this configuration subscriber.

Returns:

The set of configuration parameters associated with this configuration subscriber.

refreshSubscriberConfiguration

public void refreshSubscriberConfiguration()
                                    throws SLAMDServerException

Indicates that the implementer should re-read all of its configuration information from the configuration handler and make any necessary changes to its behavior.

Throws:

SLAMDServerException - If there is a problem while making a configuration change.

refreshSubscriberConfiguration

public void refreshSubscriberConfiguration(java.lang.String parameterName)
                                    throws SLAMDServerException

Indicates that the implementer should re-read the specified configuration parameter from the configuration handler and make any necessary changes to its behavior.

Parameters:

parameterName - The name of the configuration parameter for which the configuration should be re-read.

Throws:

SLAMDServerException - If any of the configuration parameters do not have acceptable values, or if a problem occurs while making a configuration change.