ServerAdminInterface (NetPhantom® 7.7 Java API Specification)

All Known Implementing Classes:

ClientSessionManager
```
public interface ServerAdminInterface
```
This interface defines all the server administration commands that are supported. The external user exit gets a reference to this interface.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`SUBSYS_API` The API subsystem.
`static int`	`SUBSYS_CLIENT` The client subsystem.
`static int`	`SUBSYS_HOST` The host subsystem.
`static int`	`SUBSYS_TELNET` The telnet subsystem.
`static int`	`TRACE_BINARY` The trace is binary.
`static int`	`TRACE_BINARYVERBOSE` The trace is binary and verbose.
`static int`	`TRACE_OFF` The trace is off.
`static int`	`TRACE_VERBOSE` The trace is verbose.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`changeEventFile()` Changes the event file.
`boolean`	`changeTraceFile()` Changes the trace file.
`int`	`getClientConnectionCount()` Gets the current client connection count.
`ClientConnectionData[]`	`getClientConnectionList()` Get the listing of client connections.
`String[]`	`getEventIDs()` Gets the list of available EventIDs for event logging.
`String[]`	`getEventIDsDescription()` Gets the list of available EventIDs description for event logging.
`int`	`getLoggingEvent(int eventIndex, long clientID)` Checks if an event is logged for a particular event index.
`int`	`getLoggingEvent(String eventID, long clientID)` Checks if an event is logged for a particular event ID.
`int`	`getMaximumClientConnectionCount()` Gets the current maximum count of client connections.
`String[]`	`getRuntimeFiles()` Lists the runtime files used.
`String[]`	`getRuntimeIndexes()` Lists the runtime applications (indexes) used.
`int`	`getTrace(long clientConnection, int subsystem)` Gets the trace state for all clients or for a particular client connection.
`boolean`	`hasClientConnectionChanged()` Checks for a change in the client connection list since the last call to this routine.
`boolean`	`isApplicationEnabled(String appID)` Gets the application enabled state for new client connections.
`boolean`	`isClientLogonAllowed()` Checks if client logon is allowed.
`int`	`performEventCommand(String command)` Processes an event command.
`int`	`performEventCommand(String eventID, int include, long[] clientIDs)` Processes a single eventID specification for the event filter.
`void`	`reloadMapFile()` Reloads the optional file used to map a client to a particular 3270 LU.
`boolean`	`reloadRuntimeFiles(String[] fileIDs)` Reloads one or several runtime files of the specified indexes.
`int`	`sendApplicationBroadcastMessage(String applicationID, String message)` Sends a broadcast message to all clients using the specified runtime application.
`int`	`sendBroadcastMessage(String message)` Sends a general broadcast message to all clients.
`boolean`	`sendClientMessage(long id, String message)` Sends a message to the specific client.
`boolean`	`setApplicationEnabled(String appID, boolean enabledFlag)` Sets the application enabled state for new client connections.
`boolean`	`setClientLogonAllowed(boolean isAllowed)` Sets the client logon allowed count.
`int`	`setMaximumClientConnectionCount(int maximum)` Sets the current maximum count of client connections.
`boolean`	`setTrace(long clientConnection, int subsystem, int traceLevel)` Sets the trace state.
`void`	`shutDown(boolean immed)` Requests the server shut-down.
`boolean`	`terminateClientConnection(long id)` Terminate the connection of a client connection with an optional text describing why this is done.
`boolean`	`traceClientConnection()` Prints a snap-shot list of current client connections to the current trace file.

- Field Detail
  - SUBSYS_TELNET
```
static final int SUBSYS_TELNET
```
    The telnet subsystem.
    
    See Also:
    
    Constant Field Values
  - SUBSYS_HOST
```
static final int SUBSYS_HOST
```
    The host subsystem.
    
    See Also:
    
    Constant Field Values
  - SUBSYS_CLIENT
```
static final int SUBSYS_CLIENT
```
    The client subsystem.
    
    See Also:
    
    Constant Field Values
  - SUBSYS_API
```
static final int SUBSYS_API
```
    The API subsystem.
    
    See Also:
    
    Constant Field Values
  - TRACE_OFF
```
static final int TRACE_OFF
```
    The trace is off.
    
    See Also:
    
    Constant Field Values
  - TRACE_BINARY
```
static final int TRACE_BINARY
```
    The trace is binary.
    
    See Also:
    
    Constant Field Values
  - TRACE_VERBOSE
```
static final int TRACE_VERBOSE
```
    The trace is verbose.
    
    See Also:
    
    Constant Field Values
  - TRACE_BINARYVERBOSE
```
static final int TRACE_BINARYVERBOSE
```
    The trace is binary and verbose.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - shutDown
```
void shutDown(boolean immed)
```
    Requests the server shut-down. Set immed=true if an immediate hard server shut-down is requested, or immed=false to stop the server whenever no more clients are connected.
  - reloadMapFile
```
void reloadMapFile()
            throws IOException
```
    Reloads the optional file used to map a client to a particular 3270 LU.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - getRuntimeIndexes
```
String[] getRuntimeIndexes()
```
    Lists the runtime applications (indexes) used.
  - getRuntimeFiles
```
String[] getRuntimeFiles()
```
    Lists the runtime files used.
  - reloadRuntimeFiles
```
boolean reloadRuntimeFiles(String[] fileIDs)
                    throws IOException
```
    Reloads one or several runtime files of the specified indexes. Use the method getRuntimeFiles() to get a list of them.
    
    Returns:
    
    false for runtime application name not found, true for success.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - setApplicationEnabled
```
boolean setApplicationEnabled(String appID,
                              boolean enabledFlag)
```
    Sets the application enabled state for new client connections.
    
    Returns:
    
    false for runtime application name not found, true for success.
  - isApplicationEnabled
```
boolean isApplicationEnabled(String appID)
```
    Gets the application enabled state for new client connections.
    
    Returns:
    
    true if runtime application is enabled, false if disabled or not found.
  - isClientLogonAllowed
```
boolean isClientLogonAllowed()
```
    Checks if client logon is allowed.
  - setClientLogonAllowed
```
boolean setClientLogonAllowed(boolean isAllowed)
```
    Sets the client logon allowed count. In case of failure, an event is written to the event log.
    
    Returns:
    
    true for success, false for failure.
  - hasClientConnectionChanged
```
boolean hasClientConnectionChanged()
```
    Checks for a change in the client connection list since the last call to this routine.
  - getClientConnectionCount
```
int getClientConnectionCount()
```
    Gets the current client connection count. Note that this value may change before calling getClientConnectionList.
  - getMaximumClientConnectionCount
```
int getMaximumClientConnectionCount()
```
    Gets the current maximum count of client connections.
  - setMaximumClientConnectionCount
```
int setMaximumClientConnectionCount(int maximum)
```
    Sets the current maximum count of client connections.
    
    Returns:
    
    int current client connection count.
  - getClientConnectionList
```
ClientConnectionData[] getClientConnectionList()
```
    Get the listing of client connections.
  - traceClientConnection
```
boolean traceClientConnection()
```
    Prints a snap-shot list of current client connections to the current trace file.
    
    Returns:
    
    false if the trace failed.
  - terminateClientConnection
```
boolean terminateClientConnection(long id)
```
    Terminate the connection of a client connection with an optional text describing why this is done. This text will be displayed at the client side in a message box before losing the server connection.
    
    Returns:
    
    false if the client connection does not exist, true otherwise.
  - sendClientMessage
```
boolean sendClientMessage(long id,
                          String message)
```
    Sends a message to the specific client.
    
    Returns:
    
    false if the message did not reach the client.
  - sendBroadcastMessage
```
int sendBroadcastMessage(String message)
```
    Sends a general broadcast message to all clients.
    
    Returns:
    
    the count of clients that received the message.
  - sendApplicationBroadcastMessage
```
int sendApplicationBroadcastMessage(String applicationID,
                                    String message)
```
    Sends a broadcast message to all clients using the specified runtime application.
    
    Returns:
    
    the count of clients that received the message.
  - changeEventFile
```
boolean changeEventFile()
```
    Changes the event file. The definition the file is stored in "server.ini".
    
    Returns:
    
    true for success or false for failure.
  - changeTraceFile
```
boolean changeTraceFile()
```
    Changes the trace file. The definition the file is stored in "server.ini".
    
    Returns:
    
    true for success or false for failure.
  - setTrace
```
boolean setTrace(long clientConnection,
                 int subsystem,
                 int traceLevel)
```
    Sets the trace state. The subsystem is defined by the SUBSYS_* variables and the trace level by TRACELEVEL_*. Set clientConnection to zero if all clients should be affected. To reset a client connection trace state, set the traceLevel=-1 along with the clientConnection value.
    
    Returns:
    
    false if the client did not exist or there is a parameter error.
  - getTrace
```
int getTrace(long clientConnection,
             int subsystem)
```
    Gets the trace state for all clients or for a particular client connection.
    
    Returns:
    
    the trace level 0-3, or -1 if the trace is not set for a particular client connection. The return value is also -1 if the parameters are wrong.
  - performEventCommand
```
int performEventCommand(String command)
                 throws ParseException,
                        NumberFormatException
```
    Processes an event command. 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
```
int performEventCommand(String eventID,
                        int include,
                        long[] clientIDs)
```
    Processes a single eventID specification for the event filter. 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.
  - getEventIDs
```
String[] getEventIDs()
```
    Gets the list of available EventIDs for event logging.
  - getEventIDsDescription
```
String[] getEventIDsDescription()
```
    Gets the list of available EventIDs description for event logging.
  - getLoggingEvent
```
int getLoggingEvent(String eventID,
                    long clientID)
```
    Checks if an event is logged for a particular event ID. This event ID may contain a wild-card, where the first match of the event ID setting is returned.
    If clientID is zero, the global setting will be returned.
    
    Returns:
    
    include - zero = not included, one = included, two = default global setting is used (only for a particular client connection).
    The return value will be -1 if the eventID is not found or the client does not exist.
  - getLoggingEvent
```
int getLoggingEvent(int eventIndex,
                    long clientID)
```
    Checks if an event is logged for a particular event index. The event index is the index in the string array returned by the method getEventIDs.
    If clientID is zero, the global setting will be returned.
    
    Returns:
    
    include - zero = not included, one = included, two = default global setting is used (only for a particular client connection).
    The return value will be -1 if the eventID is not found or the client does not exist.

Interface ServerAdminInterface

Field Summary

Method Summary

Field Detail

SUBSYS_TELNET

SUBSYS_HOST

SUBSYS_CLIENT

SUBSYS_API

TRACE_OFF

TRACE_BINARY

TRACE_VERBOSE

TRACE_BINARYVERBOSE

Method Detail

shutDown

reloadMapFile

getRuntimeIndexes

getRuntimeFiles

reloadRuntimeFiles

setApplicationEnabled

isApplicationEnabled

isClientLogonAllowed

setClientLogonAllowed

hasClientConnectionChanged

getClientConnectionCount

getMaximumClientConnectionCount

setMaximumClientConnectionCount

getClientConnectionList

traceClientConnection

terminateClientConnection

sendClientMessage

sendBroadcastMessage

sendApplicationBroadcastMessage

changeEventFile

changeTraceFile

setTrace

getTrace

performEventCommand

performEventCommand

getEventIDs

getEventIDsDescription

getLoggingEvent

getLoggingEvent