se.entra.phantom.server

Interface EventMessengerInterface

All Known Implementing Classes:

MailEventMessenger, SMSEventMessenger

public interface EventMessengerInterface

This is an interface that must be implemented by all EventMessengers.

Classes implementing this interface must have a default constructor without any parameters, because it will instanciated by the Class.newInstance method.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DISABLED Name of the compulsory ini-file item EventFilter
static String	EVENT_FILTER Name of the compulsory ini-file item EventFilter

Method Summary

Modifier and Type	Method and Description
void	dispose() The EventMessenger should do all the cleaning up it needs before it dies.
String[]	getItems() The EventMessenger must supply a get method to return all its items
String	getLastError(boolean reset) Method to access the latest error.
String	getName() The EventMessenger must supply a get method to return its ini-file section name
int	getSendState() Get the current state of a eventMessenger
void	loadIniParams(IniFile ini) All EventMessengers should read their own section from the server.
boolean	setSendState(int flag) Set the send state of the messenger.

Field Detail

EVENT_FILTER

static final String EVENT_FILTER

Name of the compulsory ini-file item EventFilter

See Also:

Constant Field Values

DISABLED

static final String DISABLED

Name of the compulsory ini-file item EventFilter

See Also:

Constant Field Values

Method Detail

loadIniParams

void loadIniParams(IniFile ini)

All EventMessengers should read their own section from the server.

This should be done in the loadIniParams method.

The section name should be the same as the EventMessengers name. It is then up to the implementation of this method to read all the items it needs, and to set default values if any of the items it needs is missing, or if no default value can be set, the class has to take care of all the error handling for this case.

dispose

void dispose()

The EventMessenger should do all the cleaning up it needs before it dies. This should be done in it's dispose method.

getItems

String[] getItems()

The EventMessenger must supply a get method to return all its items

getName

String getName()

The EventMessenger must supply a get method to return its ini-file section name

getSendState

int getSendState()

Get the current state of a eventMessenger

Returns:

-1 the messenger name is not found.
0 the messenger is started.
1 the messenger is stopped.
2 the messenger is disabled
3 the messenger is in an error state

setSendState

boolean setSendState(int flag)

Set the send state of the messenger. 0 for start, 1 for stop, 2 for disabled

getLastError

String getLastError(boolean reset)

Method to access the latest error. If reset is true the latest error is set to empty string.