se.entra.phantom.server

Class MailEventMessenger

java.lang.Object

se.entra.phantom.server.MailEventMessenger

All Implemented Interfaces:

EventHistoryListener, EventMessengerInterface

public class MailEventMessenger
extends Object
implements EventMessengerInterface, EventHistoryListener

Field Summary

Fields inherited from interface se.entra.phantom.server.EventMessengerInterface

DISABLED, EVENT_FILTER

Constructor Summary

Constructors

Constructor and Description
MailEventMessenger() Creates a new MailEventMessenger.

Method Summary

Modifier and Type	Method and Description
void	dispose() The EventMessenger should do cleaning up it needs before it dies.
String[]	getItems() Gets the name of the items that should be in the ini-file for this event messenger.
String	getLastError(boolean reset) Method to access the latest error.
String	getName() Gets corresponding name of this class in the ini-file
int	getSendState() Return our send state 0=started, 1=stopped, 2=disabled, 3=error
void	loadIniParams(IniFile ini) Reads the MailEventMessengers section in the server.ini.
void	processEvent(ServerEvent event) A new server event has been processed by the event exit.
boolean	setSendState(int flag) 0 = start, 1 = stopp, 2 = disable General: If our internal state equals the flag, do nothing.

Methods inherited from class java.lang.Object

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

Constructor Detail

MailEventMessenger

public MailEventMessenger()

Creates a new MailEventMessenger.

It creates a new SendMail instance, that will be kept alive until somebody calls it's dispose method (hopefully it will be the EventManager that does it).

Method Detail

loadIniParams

public void loadIniParams(IniFile ini)

Reads the MailEventMessengers section in the server.ini.

Specified by:

loadIniParams in interface EventMessengerInterface

Parameters:

ini - The ini file.

processEvent

public void processEvent(ServerEvent event)

A new server event has been processed by the event exit.

Specified by:

processEvent in interface EventHistoryListener

dispose

public void dispose()

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

Specified by:

dispose in interface EventMessengerInterface

getItems

public String[] getItems()

Gets the name of the items that should be in the ini-file for this event messenger.

Specified by:

getItems in interface EventMessengerInterface

Returns:

An array of strings with the item names.

getName

public String getName()

Gets corresponding name of this class in the ini-file

Specified by:

getName in interface EventMessengerInterface

getSendState

public int getSendState()

Return our send state 0=started, 1=stopped, 2=disabled, 3=error

Specified by:

getSendState in interface EventMessengerInterface

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

public boolean setSendState(int flag)

0 = start, 1 = stopp, 2 = disable General: If our internal state equals the flag, do nothing.

Specified by:

setSendState in interface EventMessengerInterface

getLastError

public String getLastError(boolean reset)

Description copied from interface: EventMessengerInterface

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

Specified by:

getLastError in interface EventMessengerInterface

Returns:

Latest error