EventFilter (NetPhantom® 7.7 Java API Specification)

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

```
public class EventFilter
extends Object
```
The event filter class holds a global array of event IDs that are logged or not. Then, for each client session, there is a local array of event IDs that can be turned on/off explicitly, or to use the default global setting. All event IDs are specified in the EventID class. Every event is queued on to the EventManager for later processing using the EventExit.

See Also:

EventID

Constructor Summary

Constructors
Constructor and Description
`EventFilter()` The constructor creates a buffer with all possible events set to default (i.e.
`EventFilter(boolean enableAll)` The constructor creates a buffer with all possible events set to default (i.e.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`createGlobalEventFilter()` This method is called when the event manager is created.
`int`	`getLoggedEventIndex(int id)` Gets the event logging for a event index.
`static int`	`getLoggingEvent(EventFilter filter, int eventIndex)` Checks if an event is logged for a particular event index.
`boolean`	`isEventLogged(int eventID)` Checks if an event is logged or not for the current client connection.
`static boolean`	`isGlobalEventIndexLogged(int id)` Checks if a global event index is to be logged.
`static boolean`	`isGlobalEventLogged(int eventID)` Checks if a global event is to be logged.
`static int`	`performEventCommand(String command, EventFilter globalFilter)` 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, EventFilter globalFilter)` Processes a single eventID specification.
`static boolean`	`setupClientEvent(EventFilter filter, int eventIndex, int include)` Sets up the client event for the event filter data.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EventFilter
```
public EventFilter()
```
    The constructor creates a buffer with all possible events set to default (i.e. the global event filter).
  - EventFilter
```
public EventFilter(boolean enableAll)
```
    The constructor creates a buffer with all possible events set to default (i.e. the global event filter).
- Method Detail
  - createGlobalEventFilter
```
public static void createGlobalEventFilter()
```
    This method is called when the event manager is created. The global event array is created and appropriate events are set.
  - isGlobalEventLogged
```
public static boolean isGlobalEventLogged(int eventID)
```
    Checks if a global event is to be logged.
  - isGlobalEventIndexLogged
```
public static boolean isGlobalEventIndexLogged(int id)
```
    Checks if a global event index is to be logged.
  - isEventLogged
```
public boolean isEventLogged(int eventID)
```
    Checks if an event is logged or not for the current client connection.
  - getLoggedEventIndex
```
public int getLoggedEventIndex(int id)
```
    Gets the event logging for a event index.
    
    Returns:
    
    0 - not logged
    1 - logged
    2 - uses global logging, not logged
    3 - uses global logging, logged
  - performEventCommand
```
public static int performEventCommand(String command,
                                      EventFilter globalFilter)
                               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,
                                      EventFilter globalFilter)
```
    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 preceeding 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.
  - setupClientEvent
```
public static boolean setupClientEvent(EventFilter filter,
                                       int eventIndex,
                                       int include)
```
    Sets up the client event for the event filter data. If this filter is null, the global setting will be used.
    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:
    
    true for success, false=no change or failure.
  - getLoggingEvent
```
public static int getLoggingEvent(EventFilter filter,
                                  int eventIndex)
```
    Checks if an event is logged for a particular event index.
    If filter is null, the global setting will be returned.
    
    Returns:
    
    include - zero = not included, one = included, two = default global setting is used (only when filter!=null).
    The return value will be -1 if the eventID is not found or for invalid parameters.

Class EventFilter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EventFilter

EventFilter

Method Detail

createGlobalEventFilter

isGlobalEventLogged

isGlobalEventIndexLogged

isEventLogged

getLoggedEventIndex

performEventCommand

performEventCommand

setupClientEvent

getLoggingEvent