EventManager (NetPhantom® 7.7 Java API Specification)

java.lang.Object
- se.entra.phantom.server.EventManager

All Implemented Interfaces:

Runnable
```
public class EventManager
extends Object
implements Runnable
```
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.

See Also:

DefaultEventExit

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addHistoryListener(EventHistoryListener listener)` Adds a listener for history events.
`void`	`dispose()` Requests and waits for termination of the event manager.
`long`	`getEventFileLength()` Gets the current event file length.
`String`	`getEventFileName()` Gets the current event file name.
`static EventManager`	`getEventManager()` Gets the single instance of the event manager.
`EventMessengerInterface`	`getEventMessenger(String messengerName)` Get an eventMessenger.
`ServerEvent[]`	`getHistory()` Gets the history of events.
`ServerEvent[]`	`getHistory(EventHistoryListener listener)` Gets the history of events and adds a listener for history events.
`static int`	`getMaxHistoryCount()` Get the event queue max history count for backlog of events.
`long`	`getMaximumFileSize()` Gets the maximum file size of a trace file.
`boolean`	`loadMessenger(String newEvm, String oldEvm)` Loads a single event messenger.
`void`	`loadMessengers()` Load eventMessengers specified in the configuration file (default SERVER.INI).
`static void`	`logEvent(ClientConnectionData clientConnectionData, int eventID)` Queues this event for processing by the event manager read thread.
`static void`	`logEvent(ClientConnectionData clientConnectionData, int eventID, int appendedTextID)` Queues this event for processing by the event manager read thread.
`static void`	`logEvent(ClientConnectionData clientConnectionData, int eventID, String appendedText)` Queues this event for processing by the event manager read thread.
`static void`	`logEvent(ClientConnectionData clientConnectionData, String event, int eventClass)` Queues this event for processing by the event manager read thread.
`static void`	`logEvent(int eventID)` Queues this event for processing by the event manager read thread.
`static void`	`logEvent(int eventID, int appendedTextID)` Queues this event for processing by the event manager read thread.
`static void`	`logEvent(int eventID, String appendedText)` Queues this event for processing by the event manager read thread.
`static void`	`logEvent(String event, int eventClass)` Queues this event for processing by the event manager read thread.
`static int`	`performEventCommand(String command)` Processes a command either from a command line, (remote) console or event filter commands in SERVER.INI.
`static int`	`performEventCommand(String eventID, int include, long[] clientIDs)` Processes a single eventID specification.
`void`	`removeHistoryListener(EventHistoryListener listener)` Removes a listener for history events.
`boolean`	`rotateInformation()` Rotates the event information if stored in e.g.
`void`	`run()` The thread that reads the event queue.
`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

- Method Detail
  - getMaxHistoryCount
```
public static int getMaxHistoryCount()
```
    Get the event queue max history count for backlog of events.
  - getEventManager
```
public static EventManager getEventManager()
```
    Gets the single instance of the event manager.
    
    Returns:
    
    null if the event manager is not started.
  - loadMessengers
```
public void loadMessengers()
```
    Load eventMessengers specified in the configuration file (default SERVER.INI).
  - getEventMessenger
```
public EventMessengerInterface getEventMessenger(String messengerName)
```
    Get an eventMessenger.
    
    Parameters:
    
    messengerName - the messenger ID name.
  - loadMessenger
```
public boolean loadMessenger(String newEvm,
                             String oldEvm)
```
    Loads a single event messenger. If the event messenger is already loaded, this instance will be able to dispose itself first. before it is reloded.
    
    Parameters:
    
    newEvm - The name of the event messenger.
    
    oldEvm - The name of an old event messenger to replace with the new one. Set this parameter to null if nold event messenger.
    
    Returns:
    
    true if the event messenger was loaded successfully, false otherwise.
  - 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.
    
    Returns:
    
    true for success or false for failure.
  - getEventFileName
```
public String getEventFileName()
```
    Gets the current event file name.
    
    Returns:
    
    null for no file name.
  - getEventFileLength
```
public long getEventFileLength()
```
    Gets the current event file length.
    
    Returns:
    
    -1 if no file is used.
  - setMaximumFileSize
```
public 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
```
public 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.
  - performEventCommand
```
public static int performEventCommand(String command)
                               throws ParseException,
                                      NumberFormatException
```
    Processes a command either from a command line, (remote) console or event filter commands in SERVER.INI. The form of these commands must be:
```
 . EventFilter --+--+-- ALL        --+-- [INCLUDE:event_id] -- [EXCLUDE:event_id] -- [DEFAULT:event_id]
 .               |  |                |
 .               |  +-- client_id  --+
 .               |                   |
 .               +----- , -----------+
 
```
    where client_id can be a comma-separated (no spaces in between) list of several client_ids,
    and event_id is a comma-separated list (no spaces in between) of eventIDs as defined in SERVER.PHM and/or a range of eventIDs and/or using the '*' wildcard to accept any eventID starting with the text preceeding the '*'.
    To specify all events, use the event range string "*-*".
    Note that the command "EventFilter ALL DEFAULT:nnn" will never return other values than zero, because the "ALL" indicates the default setting for all clients.
    Returns:
    
    count the count of commands performed.
    
    Throws:
    
    ParseException - When the command in SERVER.INI are invalid.
    
    NumberFormatException - When a clientID is wrong.
  - performEventCommand
```
public static int performEventCommand(String eventID,
                                      int include,
                                      long[] clientIDs)
```
    Processes a single eventID specification. The clientIDs is an array of longs that are either zero indicating all clients or a specific value.
    The eventID is an eventID as defined in SERVER.PHM or a range of eventIDs and/or using the '*' wildcard to accept any eventID starting with the text preceding the '*'. The range separator is '-'.
    The value "include" must be zero or one for a global filter and can be zero=exclude, one=include, 2=default (use global filter).
    
    Returns:
    
    count the count of commands performed.
  - dispose
```
public void dispose()
```
    Requests and waits for termination of the event manager.
  - logEvent
```
public static void logEvent(int eventID)
```
    Queues this event for processing by the event manager read thread.
    Skips logging the event if this is not required. Uses the system default setting if no ClientConnectionData is not specified or cannot be found from the ServerThread (derived of Thread) instance.
    Note: Don't use this method if there is a client connection, only use it for the server daemon.
  - logEvent
```
public static void logEvent(int eventID,
                            int appendedTextID)
```
    Queues this event for processing by the event manager read thread.
    Skips logging the event if this is not required. Uses the system default setting if no ClientConnectionData is not specified or cannot be found from the ServerThread (derived of Thread) instance.
    Note: Don't use this method if there is a client connection, only use it for the server daemon.
  - logEvent
```
public static void logEvent(int eventID,
                            String appendedText)
```
    Queues this event for processing by the event manager read thread. The appendedText parameter may be null if no additional text is required.
    Skips logging the event if this is not required. Uses the system default setting if no ClientConnectionData is not specified or cannot be found from the ServerThread (derived of Thread) instance.
    Note: Avoid using this method if there is a client connection, only use it for the server daemon. The clientConnectionData is retrieved from the thread it is derived from ServerThread.
  - logEvent
```
public static void logEvent(String event,
                            int eventClass)
```
    Queues this event for processing by the event manager read thread.
    The event class is 1-4 (see EventID.EVENTCLASS_*).
    Note: Don't use this method if there is a client connection, only use it for the server daemon.
  - logEvent
```
public static void logEvent(ClientConnectionData clientConnectionData,
                            int eventID)
```
    Queues this event for processing by the event manager read thread.
    Skips logging the event if this is not required. Uses the system default setting if no ClientConnectionData is not specified or cannot be found from the ServerThread (derived of Thread) instance.
  - logEvent
```
public static void logEvent(ClientConnectionData clientConnectionData,
                            int eventID,
                            int appendedTextID)
```
    Queues this event for processing by the event manager read thread.
    Skips logging the event if this is not required. Uses the system default setting if no ClientConnectionData is not specified or cannot be found from the ServerThread (derived of Thread) instance.
  - logEvent
```
public static void logEvent(ClientConnectionData clientConnectionData,
                            int eventID,
                            String appendedText)
```
    Queues this event for processing by the event manager read thread. The appendedText parameter may be null if no additional text is required.
    Skips logging the event if this is not required. Uses the system default setting if no ClientConnectionData is not specified or cannot be found from the ServerThread (derived of Thread) instance.
  - logEvent
```
public static void logEvent(ClientConnectionData clientConnectionData,
                            String event,
                            int eventClass)
```
    Queues this event for processing by the event manager read thread. The event class is 1-4 (see EventID.EVENTCLASS_*).
  - addHistoryListener
```
public void addHistoryListener(EventHistoryListener listener)
```
    Adds a listener for history events.
    
    Parameters:
    
    listener - A history listener to register. This listener must implement the EventHistoryListener interface.
  - removeHistoryListener
```
public void removeHistoryListener(EventHistoryListener listener)
```
    Removes a listener for history events.
    
    Parameters:
    
    listener - The history listener that should be unregistered. The listener must implement the EventHistoryListener interface.
  - getHistory
```
public final ServerEvent[] getHistory()
```
    Gets the history of events. The earliest event is in the beginning of the ServerEvent array.
  - getHistory
```
public final ServerEvent[] getHistory(EventHistoryListener listener)
```
    Gets the history of events and adds a listener for history events.
    This method can be used when a new history listener should be registered, and at the same time should retrieve all server events in the history list. This is done by the server-admin's event viewer, that will display everything in the history list, and at the same time it should get every new event that occurs.
    
    Parameters:
    
    listener - A history listener to register. This listener must implement the EventHistoryListener interface.
    
    Returns:
    
    An array of all the ServerEvents in the history list. The earliest event is in the beginning of the array.
  - run
```
public void run()
```
    The thread that reads the event queue. The thread is stopped when the isDisposed flag is true and the queue empty.
    When the thread is activated, and there are items in the queue, the first event on the queue will be removed, and passed on to the server event user exit.
    After that the event will be placed in the history list. If the history list has reached the max count, the oldest item will first be removed.
    If there are any registered Event Messengers, the event will be passed on to them.
    Finally, if there are no more events in the queue, and the isDisposed flag still is not set, then the thread will wait for the next event.
    
    Specified by:
    
    run in interface Runnable

Class EventManager

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getMaxHistoryCount

getEventManager

loadMessengers

getEventMessenger

loadMessenger

rotateInformation

getEventFileName

getEventFileLength

setMaximumFileSize

getMaximumFileSize

performEventCommand

performEventCommand

dispose

logEvent

logEvent

logEvent

logEvent

logEvent

logEvent

logEvent

logEvent

addHistoryListener

removeHistoryListener

getHistory

getHistory

run