PhantomWorker (NetPhantom® 7.7 Java API Specification)

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

```
public class PhantomWorker
extends Object
```
The class to handle calls to/from the REXXMigration and NetRexxMigration classes.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`REXXFILE_NOP` The operation for a REXX file: no operation.
`static int`	`REXXFILE_READ` The operation for a REXX file: open file for read.
`static int`	`REXXFILE_READWRITE` The operation for a REXX file: open file in read+write mode.
`static int`	`REXXFILE_WRITE` The operation for a REXX file: open file for write.

Constructor Summary

Constructors
Constructor and Description

PhantomWorker(VirtualSessionManager vSM)
The constructor is called when the virtual session manager is created.

Constructors
Constructor and Description
`PhantomWorker(VirtualSessionManager vSM)` The constructor is called when the virtual session manager is created.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`checkDisposed()` Check if worker has been disposed.
`REXXFile`	`deleteRexxFile(String name)` Deletes an entry in the REXX file table.
`void`	`dispose()` Dispose Phantom worker, set all references to null and releases any waiting threads.
`void`	`disposeReportGenerator()` Disposes of the report generator.
`void`	`doDisposeRepGen()` Sets the flag indicating that the PhantomWorker should dispose of the ReportGenerator.
`void`	`dump(String text)` Dumps a text string when the API is traced.
`ClientConnectionData`	`getClientConnectionData()` Gets the client connection data.
`ClientSessionInterface`	`getClientSession()` Gets the client session.
`CodepageConverter`	`getCodepageConverter()` Gets the CodepageConverter that is appropriate for writing files with this runtime.
`Object`	`getComponentLockObject()` Gets the lock object for synchronization for Control Components.
`PhantomHostScreen`	`getCurrentHostScreen()` Gets the currently matching host screen.
`HostSession`	`getCurrentHostSession()` Gets the current host session.
`VirtualRuntime`	`getCurrentRuntime()` Gets the current runtime application.
`HostScreen`	`getHostScreen()` Gets the single instance of the host screen.
`PhantomHostData`	`getPhantomHostData()` Gets the host data of the current runtime application.
`REXXFile`	`getRexxFile(String name, int operation)` Gets a REXX file instance for a name, using a specific file operation.
`VirtualPanelSession`	`getVirtualPanelSession()` Gets the current panel session.
`VirtualSessionManager`	`getVirtualSessionManager()` Gets the virtual session manager.
`void`	`initialize()` Initializes the worker after creation of the host session manager.
`boolean`	`isDisposed()` Checks if it is disposed.
`boolean`	`isMainThread()` Checks if the current thread is the worker thread.
`boolean`	`isTrace()` Checks if the API is being traced or not.
`boolean`	`processNotify(String message)` Notify a waiting thread that is waiting with the processWait method.
`String`	`processWait()` This thread will wait for a notification from another thread.
`String`	`reportHandler(String com, String p1, String p2, String p3, String p4, String p5)` Handles the report generator.
`String`	`sendMailHandler(String com, String p1)` Handle send mail event.

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

- Field Detail
  - REXXFILE_NOP
```
public static final int REXXFILE_NOP
```
    The operation for a REXX file: no operation.
    
    See Also:
    
    Constant Field Values
  - REXXFILE_READ
```
public static final int REXXFILE_READ
```
    The operation for a REXX file: open file for read.
    
    See Also:
    
    Constant Field Values
  - REXXFILE_WRITE
```
public static final int REXXFILE_WRITE
```
    The operation for a REXX file: open file for write.
    
    See Also:
    
    Constant Field Values
  - REXXFILE_READWRITE
```
public static final int REXXFILE_READWRITE
```
    The operation for a REXX file: open file in read+write mode.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PhantomWorker
```
public PhantomWorker(VirtualSessionManager vSM)
```
    The constructor is called when the virtual session manager is created.
- Method Detail
  - getComponentLockObject
```
public Object getComponentLockObject()
```
    Gets the lock object for synchronization for Control Components.
  - initialize
```
public void initialize()
```
    Initializes the worker after creation of the host session manager.
  - dispose
```
public void dispose()
```
    Dispose Phantom worker, set all references to null and releases any waiting threads.
  - isDisposed
```
public boolean isDisposed()
```
    Checks if it is disposed.
  - checkDisposed
```
public void checkDisposed()
```
    Check if worker has been disposed. If so, the error ClientSessionDispose is thrown.
  - getVirtualSessionManager
```
public VirtualSessionManager getVirtualSessionManager()
```
    Gets the virtual session manager.
  - getVirtualPanelSession
```
public VirtualPanelSession getVirtualPanelSession()
```
    Gets the current panel session.
  - getClientConnectionData
```
public ClientConnectionData getClientConnectionData()
```
    Gets the client connection data.
  - getCurrentHostSession
```
public HostSession getCurrentHostSession()
```
    Gets the current host session.
  - getHostScreen
```
public HostScreen getHostScreen()
```
    Gets the single instance of the host screen.
  - getClientSession
```
public ClientSessionInterface getClientSession()
```
    Gets the client session.
  - getCurrentRuntime
```
public VirtualRuntime getCurrentRuntime()
```
    Gets the current runtime application.
  - getCurrentHostScreen
```
public PhantomHostScreen getCurrentHostScreen()
```
    Gets the currently matching host screen.
  - getPhantomHostData
```
public PhantomHostData getPhantomHostData()
```
    Gets the host data of the current runtime application.
  - getRexxFile
```
public REXXFile getRexxFile(String name,
                            int operation)
```
    Gets a REXX file instance for a name, using a specific file operation.
    The operations are:
    - REXXFILE_NOP
    - REXXFILE_READ
    - REXXFILE_WRITE
    - REXXFILE_READWRITE
    
    Returns:
    
    null if the requested operation cannot be performed.
    
    See Also:
    
    deleteRexxFile(java.lang.String)
  - deleteRexxFile
```
public REXXFile deleteRexxFile(String name)
```
    Deletes an entry in the REXX file table.
    
    Returns:
    
    null if the file is not found.
    
    See Also:
    
    getRexxFile(java.lang.String, int)
  - isMainThread
```
public boolean isMainThread()
```
    Checks if the current thread is the worker thread.
  - isTrace
```
public boolean isTrace()
```
    Checks if the API is being traced or not. This is the same as ClientConnectionData.doAPIVerboseTrace().
  - dump
```
public void dump(String text)
```
    Dumps a text string when the API is traced.
  - processWait
```
public String processWait()
```
    This thread will wait for a notification from another thread. The notification is send by the processNotify method. Only one thread can wait for a notification.
    
    Returns:
    
    a string result from processNotify
    
    See Also:
    
    processNotify(java.lang.String)
  - processNotify
```
public boolean processNotify(String message)
```
    Notify a waiting thread that is waiting with the processWait method. A message string is sent to the waiting thread.
    
    Returns:
    
    true for success and false for error.
    
    See Also:
    
    processWait()
  - reportHandler
```
public String reportHandler(String com,
                            String p1,
                            String p2,
                            String p3,
                            String p4,
                            String p5)
```
    Handles the report generator. If the report generator has not been instanciated, this will be done. Then the command with its parameters will be passed on to ReportGenerator.
    
    Parameters:
    
    com - The report command.
    
    p1 - The first parameter for the command, might be an empty String.
    
    p2 - The first parameter for the command, might be an empty String.
    
    p3 - The first parameter for the command, might be an empty String.
    
    p4 - The first parameter for the command, might be an empty String.
    
    p5 - The first parameter for the command, might be an empty String.
    
    Returns:
    
    A return value from the ReportGenerator, that will be passed back to the caller.
  - disposeReportGenerator
```
public void disposeReportGenerator()
```
    Disposes of the report generator.
  - doDisposeRepGen
```
public void doDisposeRepGen()
```
    Sets the flag indicating that the PhantomWorker should dispose of the ReportGenerator.
  - sendMailHandler
```
public String sendMailHandler(String com,
                              String p1)
```
    Handle send mail event.
  - getCodepageConverter
```
public CodepageConverter getCodepageConverter()
```
    Gets the CodepageConverter that is appropriate for writing files with this runtime. For NetPhantom 6 is is ANSI-type, and for NP5(-) it's OEM.

Class PhantomWorker

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

REXXFILE_NOP

REXXFILE_READ

REXXFILE_WRITE

REXXFILE_READWRITE

Constructor Detail

PhantomWorker

Method Detail

getComponentLockObject

initialize

dispose

isDisposed

checkDisposed

getVirtualSessionManager

getVirtualPanelSession

getClientConnectionData

getCurrentHostSession

getHostScreen

getClientSession

getCurrentRuntime

getCurrentHostScreen

getPhantomHostData

getRexxFile

deleteRexxFile

isMainThread

isTrace

dump

processWait

processNotify

reportHandler

disposeReportGenerator

doDisposeRepGen

sendMailHandler

getCodepageConverter