se.entra.phantom.server.event

Class DefaultEventExit

java.lang.Object

se.entra.phantom.server.event.DefaultEventExit

All Implemented Interfaces:

EventInterface, EventInterface2

public class DefaultEventExit
extends Object
implements EventInterface2

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 Server Event User Exit. This exit is dynamically loaded from a definition in SERVER.INI.

Constructor Summary

Constructors

Constructor and Description
DefaultEventExit() The constructor reads the file name for event logging from "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	initialize(IniFile ini, int startEventID, int startEventClass, String startEvent, int stopEventID, int stopEventClass, String stopEvent, int rotateEventID, int rotateEventClass, String rotateEvent, int errorEventID, int errorEventClass, String errorEvent) Initializes the event user exit.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultEventExit

public DefaultEventExit()

The constructor reads the file name for event logging from "server.ini". If this entry is not found, "PgmName.log" in the current directory will be used.

Method Detail

initialize

public void initialize(IniFile ini,
                       int startEventID,
                       int startEventClass,
                       String startEvent,
                       int stopEventID,
                       int stopEventClass,
                       String stopEvent,
                       int rotateEventID,
                       int rotateEventClass,
                       String rotateEvent,
                       int errorEventID,
                       int errorEventClass,
                       String errorEvent)
                throws IOException

Initializes the event user exit. The parameters for the event IDs and the event classes are used to create log entries when appropriate.

This function reads the file name for event logging from "server.ini". If this entry is not found, "PgmName.log" in the current directory will be used.

Specified by:

initialize in interface EventInterface2

Throws:

IOException - if the file cannot be created.

dispose

public 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.

Specified by:

dispose in interface EventInterface

logEvent

public 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.

Specified by:

logEvent in interface EventInterface

Throws:

IOException - if e.g. the file cannot be created.

getEventFileName

public String getEventFileName()

Gets the current event file name.

Specified by:

getEventFileName in interface EventInterface

Returns:

String always a file name, never null.

getEventFileLength

public long getEventFileLength()

Gets the current event file length.

Specified by:

getEventFileLength in interface EventInterface

Returns:

-1 if no file is used.

rotateInformation

public 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.

Specified by:

rotateInformation in interface EventInterface

Returns:

true for success or false for failure.

setMaximumFileSize

public boolean setMaximumFileSize(long maxSize)

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

Specified by:

setMaximumFileSize in interface EventInterface

Returns:

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

getMaximumFileSize

public long getMaximumFileSize()

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

Specified by:

getMaximumFileSize in interface EventInterface

Returns:

-1 if no file is used.