se.entra.phantom.server

Interface EventInterface

All Known Subinterfaces:

EventInterface2

All Known Implementing Classes:

DefaultEventExit

public interface EventInterface

The server has a global event manager running in a thread. A static method queueEvent is used to create and queue an event. The thread will then empty the event queue and passing it on to the ServerInterface. This user exit is dynamically loaded from a definition in SERVER.INI.

Method Summary

Modifier and Type	Method and Description
void	dispose() Disposes of the class instance.
long	getEventFileLength() Gets the current event file length.
String	getEventFileName() Gets the current event file name.
long	getMaximumFileSize() Gets the maximum file size of a trace file.
void	logEvent(ServerEvent e) Processes a single queued event, e.g.
boolean	rotateInformation() Rotates the event information if stored in e.g.
boolean	setMaximumFileSize(long maxSize) Sets the maximum file size of a trace file.

Method Detail

logEvent

void logEvent(ServerEvent e)
       throws IOException

Processes a single queued event, e.g. writes it to a file.

Note that the methods in this interface can be called from different threads, so the implementing code may have to be e.g. synchronized.

Throws:

IOException - for file errors.

getEventFileName

String getEventFileName()

Gets the current event file name.

Returns:

null for no file name.

getEventFileLength

long getEventFileLength()

Gets the current event file length.

Returns:

-1 if no file is used.

setMaximumFileSize

boolean setMaximumFileSize(long maxSize)

Sets the maximum file size of a trace file. If set to zero, no limit is used.

Returns:

true successful, false for invalid size (100 KB minimum [102400]).

getMaximumFileSize

long getMaximumFileSize()

Gets the maximum file size of a trace file. If set to zero, no limit is used.

Returns:

-1 if no file is used.

rotateInformation

boolean rotateInformation()

Rotates the event information if stored in e.g. a file.

Note that the methods in this interface can be called from different threads, so the implementing code may have to be e.g. synchronized.

Returns:

true for success or false for failure.

dispose

void dispose()

Disposes of the class instance.

Note that the methods in this interface can be called from different threads, so the implementing code may have to be e.g. synchronized.