org.nhindirect.gateway.smtp

Class GatewayState

java.lang.Object

org.nhindirect.gateway.smtp.GatewayState

public class GatewayState
extends Object

Manages the settings state of the gateway provides read/write lock protectors for concurrent operations.
This class implements a singleton pattern and is accessed by the static method getInstance().

Since:

1.4

Author:

Greg Meyer

Method Summary

Modifier and Type	Method and Description
static GatewayState	getInstance() Gets the singleton instance of the GatewayState class.
long	getSettingsUpdateInterval() Gets the interval that the settings are update when the SettingsManager is started.
SmtpAgent	getSmtpAgent() Gets the agent whose state is being managed.
SmtpAgentFactory	getSmtpAgentFactory() Gets the factory object that is being used to obtain agent settings and configuration.
boolean	isAgentSettingManagerRunning() Determines if the settings manager is running.
void	lockForProcessing() Locks a services for processing operations.
void	lockForUpdating() Locks a service update operations.
void	setSettingsUpdateInterval(long intervalInSeconds) Sets the interval that the settings are updated when the SettingsManager is started.
void	setSmptAgentFactory(SmtpAgentFactory smtpAgentFactory) Sets the factory object used to obtain agent settings and configuration.
void	setSmtpAgent(SmtpAgent agent) Sets the agent whose state is managed.
void	startAgentSettingsManager() Starts the agent settings manager.
void	stopAgentSettingsManager() Stops the agent settings manager.
void	unlockFromProcessing() Unlocks a service from processing operations.
void	unlockFromUpdating() Unlocks a service from update operations.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static GatewayState getInstance()

Gets the singleton instance of the GatewayState class.

Returns:

The singleton instance of the GatewayState class.

lockForProcessing

public void lockForProcessing()

Locks a services for processing operations. Semantically is the same as a ReadWriteLock.readLock(). Operations using this lock should not attempt to change the state of the services they are consuming. Multiple threads can concurrently obtain the processing lock and execute, however this method will block is another thread holds the update lock.

unlockFromProcessing

public void unlockFromProcessing()

Unlocks a service from processing operations. This releases the thread's access to the lock and allows access to the update lock if no other threads hold the processing lock.

lockForUpdating

public void lockForUpdating()

Locks a service update operations. Semantically is the same as a ReadWriteLock.writeLock(). This lock is intended for updating the state of a service ensuring that the update does not have adverse affects on a processing operations. Only a single thread can have access to the update thread at any given time. This method will block if another thread hold the update lock or the processing lock.

unlockFromUpdating

public void unlockFromUpdating()

Unlocks a service from update operations. This release the thread's access to the lock.

setSettingsUpdateInterval

public void setSettingsUpdateInterval(long intervalInSeconds)

Sets the interval that the settings are updated when the SettingsManager is started. If this interval is changed, the settings manager must be restarted before the new interval takes effect.

Parameters:

intervalInSeconds - The interval in seconds that the settings are updated.

getSettingsUpdateInterval

public long getSettingsUpdateInterval()

Gets the interval that the settings are update when the SettingsManager is started.

Returns:

he interval in seconds that the settings are updated.

setSmtpAgent

public void setSmtpAgent(SmtpAgent agent)

Sets the agent whose state is managed.

Parameters:

agent - The agent whose state is managed.

getSmtpAgent

public SmtpAgent getSmtpAgent()

Gets the agent whose state is being managed.

Returns:

The agent whose state is being managed.

setSmptAgentFactory

public void setSmptAgentFactory(SmtpAgentFactory smtpAgentFactory)

Sets the factory object used to obtain agent settings and configuration.

Parameters:

config - The factory object used to obtain agent settings and configuration.

getSmtpAgentFactory

public SmtpAgentFactory getSmtpAgentFactory()

Gets the factory object that is being used to obtain agent settings and configuration.

Returns:

The factory object that is being used to obtain agent settings and configuration.

startAgentSettingsManager

public void startAgentSettingsManager()

Starts the agent settings manager. The manager updates the agent's setting as determined by the update interval (default is every five minutes). Changes to the settings manager requires a restart of the manager.

stopAgentSettingsManager

public void stopAgentSettingsManager()

Stops the agent settings manager.

isAgentSettingManagerRunning

public boolean isAgentSettingManagerRunning()

Determines if the settings manager is running.

Returns:

True if the settings manage is running. False otherwise.