DefaultRemoteApplication (NetPhantom® 7.7 Java API Specification)

java.lang.Object
- se.entra.phantom.server.rapp.DefaultRemoteApplication

All Implemented Interfaces:: ClientCommunicationListener

public class DefaultRemoteApplication
extends Object
implements ClientCommunicationListener

Nothing yet...

Constructor Summary

Constructors
Constructor and Description

DefaultRemoteApplication()
Creates the instance of the DefaultRemoteApplication.

Constructors
Constructor and Description
`DefaultRemoteApplication()` Creates the instance of the DefaultRemoteApplication.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`dispose()` This method disposes immediately of any current remote application.
`AdminConfigRemoteApplication`	`getAdminConfigRemoteApplication()` Gets the configured remote application.
`String`	`getApplicationName()` Gets the application to in use (runtime file IDs).
`ClientCommunicationInterface`	`getClientCommunicationInterface()` Gets the Client Communication Interface.
`ClientConnectionData`	`getClientConnectionData()` Gets the Client Connection Data for the session (or null if no client session has yet been started).
`ClientSession`	`getClientSession()` Gets the Client Session running the application or null if not yet initialized.
`ClientSessionManager`	`getClientSessionManager()` Gets the Client Session Manager.
`static RAPPLine`	`getLine(VirtualInterface vi, int line)` Creates a RAPPLine from a list-type control.
`RemoteApplicationManager`	`getRemoteApplicationManager()` Gets the manager of this application.
`String`	`getSessionID()` Gets the session ID.
`static String`	`getStringFromLine(RAPPLine line)` Creates a String from a RAPPLine (tab delimited).
`String`	`getUserID()` Gets the User ID (or empty string for none).
`protected VirtualInterface`	`getVirtualComponentFromID(String compID)` Get control, menu item or special information.
`boolean`	`initiate()` This method is called by the NetPhantom Server when a Remote Application (RAPP) client call initially connects to a port in the server and has been accepted.
`boolean`	`isClientTerminalDisplayed(ClientSession clientSession)` Checks if the client is displaying the terminal window.
`boolean`	`isDisposed()` Checks if the session has been disposed of.
`void`	`logError(String msg)` Logs an error event.
`void`	`logInformational(String msg)` Logs an informational event.
`void`	`logWarning(String msg)` Logs a warning event.
`void`	`onClientChange(ClientSession clientSession)` Notifies of a client change.
`void`	`onClientDispose(ClientSession clientSession)` Notifies of a client session disposal.
`void`	`onClientInactivity(ClientSession clientSession)` Called when the session has been inactive for a period of time.
`void`	`onConnect(ClientSessionManager csm, RemoteApplicationManager manager, AdminConfigRemoteApplication acra, ClientCommunicationInterface cci, DefaultCrypto crypto, String sessionID, String applicationName, String userID)` Calls when a session is created the first time.
`void`	`onDisplayTerminal(ClientSession clientSession)` Displays the terminal window.
`boolean`	`onExitApplication(ClientSession clientSession)` Called when local code (e.g.
`void`	`onHostChange(ClientSession clientSession)` Notifies of a host change.
`void`	`onHostSessionFailure(ClientSession clientSession, String description)` Notifies of a failure in a host session.
`void`	`onReconnect(ClientCommunicationInterface cci, DefaultCrypto crypto, String applicationName, String userID)` Called when a session is reconnected.
`void`	`onRemoveTerminal(ClientSession clientSession)` Removes the terminal window.
`void`	`onRequestCompleted(RequestThread requestThread)` Called when the request thread has completed execution.
`void`	`onSoundAlarm(ClientSession clientSession)` Sound alarm on the client.
`boolean`	`postInitiate()` This method is called just at the end of the initialize operation and allows an extending class to override the initialize to perform specialized post-initialize operations.
`boolean`	`runCallClass(RequestThread requestThread, RAPPCallClass action)` Runs the CallClass action.
`boolean`	`runCallHost(RequestThread requestThread, RAPPCallHost action)` Runs the CallHost action.
`boolean`	`runCallHostGetField(RequestThread requestThread, RAPPCallHost action)` Runs the CallHost getField action.
`boolean`	`runCallHostGetScreen(RequestThread requestThread, RAPPCallHost action)` Runs the CallHost getScreen action.
`boolean`	`runCallObject(RequestThread requestThread, RAPPCallObject action)` Runs the CallObject action.
`boolean`	`runCallPanel(RequestThread requestThread, RAPPCallPanel action)` Runs the CallPanel action.
`boolean`	`runGlobVar(RequestThread requestThread, RAPPGlobVar action)` Runs the GlobVar action.
`void`	`runRequest(RequestThread requestThread, Document document)` Runs the request in the document.
`boolean`	`runRequest(RequestThread requestThread, RAPPTransaction transaction)` Runs the request from a RAPPTransaction.
`void`	`traceInfo(String msg)` If Client Verbose Trace is on a trace output will be done.

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

- Constructor Detail
  - DefaultRemoteApplication
```
public DefaultRemoteApplication()
```
    Creates the instance of the DefaultRemoteApplication. After this the NetPhantom Server calls the onClientConnect method.
- Method Detail
  - getClientCommunicationInterface
```
public final ClientCommunicationInterface getClientCommunicationInterface()
```
    Gets the Client Communication Interface.
  - getClientSessionManager
```
public final ClientSessionManager getClientSessionManager()
```
    Gets the Client Session Manager.
  - getClientSession
```
public final ClientSession getClientSession()
```
    Gets the Client Session running the application or null if not yet initialized.
  - getAdminConfigRemoteApplication
```
public final AdminConfigRemoteApplication getAdminConfigRemoteApplication()
```
    Gets the configured remote application.
  - getSessionID
```
public final String getSessionID()
```
    Gets the session ID.
  - getApplicationName
```
public final String getApplicationName()
```
    Gets the application to in use (runtime file IDs).
  - getUserID
```
public final String getUserID()
```
    Gets the User ID (or empty string for none).
  - getClientConnectionData
```
public final ClientConnectionData getClientConnectionData()
```
    Gets the Client Connection Data for the session (or null if no client session has yet been started).
  - getRemoteApplicationManager
```
public final RemoteApplicationManager getRemoteApplicationManager()
```
    Gets the manager of this application.
  - isDisposed
```
public final boolean isDisposed()
```
    Checks if the session has been disposed of.
  - traceInfo
```
public void traceInfo(String msg)
```
    If Client Verbose Trace is on a trace output will be done.
  - logInformational
```
public void logInformational(String msg)
```
    Logs an informational event. If Client Verbose Trace is on, a trace output will also be done.
  - logWarning
```
public void logWarning(String msg)
```
    Logs a warning event. If Client Verbose Trace is on, a trace output will also be done.
  - logError
```
public void logError(String msg)
```
    Logs an error event. If Client Verbose Trace is on, a trace output will also be done.
  - onConnect
```
public final void onConnect(ClientSessionManager csm,
                            RemoteApplicationManager manager,
                            AdminConfigRemoteApplication acra,
                            ClientCommunicationInterface cci,
                            DefaultCrypto crypto,
                            String sessionID,
                            String applicationName,
                            String userID)
                     throws IOException
```
    Calls when a session is created the first time.
    
    Throws:
    
    IOException - if the client is rejected or a communication error occurs.
  - onReconnect
```
public final void onReconnect(ClientCommunicationInterface cci,
                              DefaultCrypto crypto,
                              String applicationName,
                              String userID)
                       throws IOException
```
    Called when a session is reconnected.
    
    Throws:
    
    IOException - if the client is rejected or a communication error occurs.
  - initiate
```
public final boolean initiate()
```
    This method is called by the NetPhantom Server when a Remote Application (RAPP) client call initially connects to a port in the server and has been accepted.
    If an error is returned, it should be logged in this function.
    This method cannot be overridden. However, specific initialization can be performed by overriding the postInitiate method.
    
    Returns:
    
    boolean true for success and false for failure.
  - postInitiate
```
public boolean postInitiate()
```
    This method is called just at the end of the initialize operation and allows an extending class to override the initialize to perform specialized post-initialize operations.
    
    Returns:
    
    boolean true for success and false for failure, if not overridden, this method always returns true.
  - dispose
```
public void dispose()
```
    This method disposes immediately of any current remote application.
  - onClientChange
```
public void onClientChange(ClientSession clientSession)
```
    Notifies of a client change.
    
    Specified by:
    
    onClientChange in interface ClientCommunicationListener
  - onHostChange
```
public void onHostChange(ClientSession clientSession)
```
    Notifies of a host change.
    
    Specified by:
    
    onHostChange in interface ClientCommunicationListener
  - onHostSessionFailure
```
public void onHostSessionFailure(ClientSession clientSession,
                                 String description)
```
    Notifies of a failure in a host session.
    
    Specified by:
    
    onHostSessionFailure in interface ClientCommunicationListener
  - onDisplayTerminal
```
public void onDisplayTerminal(ClientSession clientSession)
```
    Displays the terminal window.
    
    Specified by:
    
    onDisplayTerminal in interface ClientCommunicationListener
  - onRemoveTerminal
```
public void onRemoveTerminal(ClientSession clientSession)
```
    Removes the terminal window.
    
    Specified by:
    
    onRemoveTerminal in interface ClientCommunicationListener
  - isClientTerminalDisplayed
```
public boolean isClientTerminalDisplayed(ClientSession clientSession)
```
    Checks if the client is displaying the terminal window.
    
    Specified by:
    
    isClientTerminalDisplayed in interface ClientCommunicationListener
  - onSoundAlarm
```
public void onSoundAlarm(ClientSession clientSession)
```
    Sound alarm on the client.
    
    Specified by:
    
    onSoundAlarm in interface ClientCommunicationListener
  - onExitApplication
```
public boolean onExitApplication(ClientSession clientSession)
```
    Called when local code (e.g. REXX) calls PanelExit, SessionExit or in some other way wants to exit this client session.
    
    Specified by:
    
    onExitApplication in interface ClientCommunicationListener
  - onClientInactivity
```
public void onClientInactivity(ClientSession clientSession)
```
    Called when the session has been inactive for a period of time.
    
    Specified by:
    
    onClientInactivity in interface ClientCommunicationListener
  - onClientDispose
```
public void onClientDispose(ClientSession clientSession)
```
    Notifies of a client session disposal. This dispose may be induced by the system, an administrator or the implementor of this interface.
    
    Specified by:
    
    onClientDispose in interface ClientCommunicationListener
  - runRequest
```
public void runRequest(RequestThread requestThread,
                       Document document)
```
    Runs the request in the document. This processing is done in a separate thread and a reply or error must be set in the RequestThread instance.
    The method converts the document into a RAPPTransaction and then calls the method runRequest(requestThread,transaction).
    Once this runRequest(requestThread,transaction) has completed, the contents (in XML) is read back from the RAPPTransaction and set as a reply string to the request.
    This method can be overridden in order to perform initial actions, etc.
    
    See Also:
    
    RAPPTransaction, RequestThread
  - runRequest
```
public boolean runRequest(RequestThread requestThread,
                          RAPPTransaction transaction)
```
    Runs the request from a RAPPTransaction. This processing is done in a separate thread and a reply or error must be set in the RequestThread instance.
    If this method returns false, no XML document reply will be set for the RAPP client. This method must store the appropriate error in the request thread using requestThread.setError.
    This method can be overridden in order to perform initial actions, etc.
    
    See Also:
    
    RAPPTransaction, RequestThread
  - runCallObject
```
public boolean runCallObject(RequestThread requestThread,
                             RAPPCallObject action)
```
    Runs the CallObject action.
    The return value is a success flag. A failure indicates that the script must be halted after this action.
    The action has to set it's own error code in the class and eventually also log the error/warning in the server log.
    
    Returns:
    
    true for success, false for failure.
  - getVirtualComponentFromID
```
protected VirtualInterface getVirtualComponentFromID(String compID)
```
    Get control, menu item or special information. Returns VirtualInterface.
  - getLine
```
public static RAPPLine getLine(VirtualInterface vi,
                               int line)
```
    Creates a RAPPLine from a list-type control.
    
    Returns:
    
    null if the line is invalid.
  - getStringFromLine
```
public static String getStringFromLine(RAPPLine line)
```
    Creates a String from a RAPPLine (tab delimited).
    
    Returns:
    
    null if the line parameter is null.
  - runCallPanel
```
public boolean runCallPanel(RequestThread requestThread,
                            RAPPCallPanel action)
```
    Runs the CallPanel action.
    The return value is a success flag. A failure indicates that the script must be halted after this action.
    The action has to set it's own error code in the class and eventually also log the error/warning in the server log.
    
    Returns:
    
    true for success, false for failure.
  - runCallHost
```
public boolean runCallHost(RequestThread requestThread,
                           RAPPCallHost action)
```
    Runs the CallHost action.
    The return value is a success flag. A failure indicates that the script must be halted after this action.
    The action has to set it's own error code in the class and eventually also log the error/warning in the server log.
    
    Returns:
    
    true for success, false for failure.
  - runCallHostGetField
```
public boolean runCallHostGetField(RequestThread requestThread,
                                   RAPPCallHost action)
```
    Runs the CallHost getField action.
    The return value is a success flag. A failure indicates that the script must be halted after this action.
    
    Returns:
    
    true for success, false for failure.
  - runCallHostGetScreen
```
public boolean runCallHostGetScreen(RequestThread requestThread,
                                    RAPPCallHost action)
```
    Runs the CallHost getScreen action.
    The return value is a success flag. A failure indicates that the script must be halted after this action.
    
    Returns:
    
    true for success, false for failure.
  - runCallClass
```
public boolean runCallClass(RequestThread requestThread,
                            RAPPCallClass action)
```
    Runs the CallClass action.
    The return value is a success flag. A failure indicates that the script must be halted after this action.
    The action has to set it's own error code in the class and eventually also log the error/warning in the server log.
    
    Returns:
    
    true for success, false for failure.
  - runGlobVar
```
public boolean runGlobVar(RequestThread requestThread,
                          RAPPGlobVar action)
```
    Runs the GlobVar action.
    The return value is a success flag. A failure indicates that the script must be halted after this action.
    The action has to set it's own error code in the class and eventually also log the error/warning in the server log.
    
    Returns:
    
    true for success, false for failure.
  - onRequestCompleted
```
public final void onRequestCompleted(RequestThread requestThread)
```
    Called when the request thread has completed execution.
    This method cannot be overridden.

Class DefaultRemoteApplication

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultRemoteApplication

Method Detail

getClientCommunicationInterface

getClientSessionManager

getClientSession

getAdminConfigRemoteApplication

getSessionID

getApplicationName

getUserID

getClientConnectionData

getRemoteApplicationManager

isDisposed

traceInfo

logInformational

logWarning

logError

onConnect

onReconnect

initiate

postInitiate

dispose

onClientChange

onHostChange

onHostSessionFailure

onDisplayTerminal

onRemoveTerminal

isClientTerminalDisplayed

onSoundAlarm

onExitApplication

onClientInactivity

onClientDispose

runRequest

runRequest

runCallObject

getVirtualComponentFromID

getLine

getStringFromLine

runCallPanel

runCallHost

runCallHostGetField

runCallHostGetScreen

runCallClass

runGlobVar

onRequestCompleted