se.entra.phantom.server

Class PhantomObject

java.lang.Object

se.entra.phantom.server.PhantomObject

All Implemented Interfaces:

Comparable<PhantomObject>, NetPhantomConstants, IReloadable, ObjectMessages

public class PhantomObject
extends Object
implements ObjectMessages, NetPhantomConstants, IReloadable, Comparable<PhantomObject>

This class contains the Phantom Object definitions. It loads its definitions from a ".PHA" file inside the runtime file.

Field Summary

Fields

Modifier and Type	Field and Description
String	description The description.
String	fileName File name for object code.
int	filter Object calling filter.
int	flags Object flags (OBJFLAG_ENTER_LOCK and OBJFLAG_EXIT_UNLOCK).
String	name Name of the object.
static int	OBJ_DLL DLL.
static int	OBJ_JAVA Java code.
static int	OBJ_MACRO Phantom Macro.
static int	OBJ_POPUPMENU Pop-up menu.
static int	OBJ_REXXAPPLICATION REXX macro.
static int	OBJ_REXXCMD REXX Command file.
static int	OBJ_REXXMACRO REXX macro.
static int	OBJFLAG_ENTER_LOCK Flag to lock panels & host at enter of object call.
static int	OBJFLAG_EXIT_UNLOCK Flag to unlock panels & host at exit of object call.
String	procedure Procedure/entry point name.
int	type Type of object.

Fields inherited from interface se.entra.phantom.server.ObjectMessages

OBJACT_CHAR, OBJACT_CHECK, OBJACT_CLICK, OBJACT_CLOSE, OBJACT_COMMAND, OBJACT_CREATE, OBJACT_DBLCLICK, OBJACT_DDECONNECTION, OBJACT_DDEDATA, OBJACT_DDEERROR, OBJACT_DDEEXECUTE, OBJACT_DDEPOKE, OBJACT_DDEREQUEST, OBJACT_DDEVALIDATE, OBJACT_DEFOCUS, OBJACT_DESTROY, OBJACT_FOCUS, OBJACT_HIDDEN, OBJACT_HOSTCHANGE, OBJACT_LAST_MESSAGE_HANDLED, OBJACT_QUERYMSG, OBJACT_RECREATE, OBJACT_SELECT, OBJACT_SHOW, OBJACT_START, OBJACT_TRANSLATE, OBJACT_USERCHANGE, PHA_ICO_INFO, PHA_ICO_NOICON, PHA_ICO_QUESTION, PHA_ICO_STOP, PHA_ICO_WARNING, PHA_MSG_CANCEL, PHA_MSG_ENTER, PHA_MSG_ENTERCANCEL, PHA_MSG_OK, PHA_MSG_OKCANCEL, PHA_MSG_RETIGNCANCEL, PHA_MSG_RETRYCANCEL, PHA_MSG_YESNO, PHA_MSG_YESNOCANCEL

Fields inherited from interface se.entra.phantom.common.NetPhantomConstants

ACTION_CLOSEWINDOW, ACTION_CONTROL, ACTION_HOSTKEY, ACTION_MENU, ACTION_NONE, ACTION_NOTEBOOKPAGE, ACTION_POPUPMENU, CC_BACKGROUND, CC_BOTH, CC_FOREGROUND, CC_NONE, CLIPBOARD_GET, CLIPBOARD_SET, DATEF_DMY, DATEF_MDY, DATEF_SYSTEM, DATEF_YMD, DDE_ADVISE, DDE_EXECUTE, DDE_INITIATE, DDE_POKE, DDE_REQUEST, DDE_TERMINATE, DDE_UNADVISE, DDE_UPDATE, DDEVAR_DISABLE, DDEVAR_ENABLE, DDEVAR_REQUEST, DDEVAR_SET, DDEVAR_VALIDATE, EFT_AMOUNT, EFT_DATE, EFT_DATEAMOUNT, EFT_NORMAL, EFT_PASSWORD, EVENT_CHAR, EVENT_CHECK, EVENT_CLICK, EVENT_COMMAND, EVENT_DBLCLICK, EVENT_DDECONNECTION, EVENT_DDEDATA, EVENT_DDEERROR, EVENT_DDEEXECUTE, EVENT_DDEINVALIDATE, EVENT_DDEPOKE, EVENT_DDEREQUEST, EVENT_DEFOCUS, EVENT_FOCUS, EVENT_PAGEDOWN, EVENT_PAGEUP, EVENT_SELECT, EVENT_UNKNOWN, EVENT_USERCHANGE, EXTENDEDINFO_IDS_TO_CLIENT, fillerByte, FOCUSTYPE_CLIENTTARGET, FOCUSTYPE_CONTROL, FOCUSTYPE_NONE, ICON_CRITICAL, ICON_INFORMATION, ICON_NOICON, ICON_QUERY, ICON_WARNING, J_AUTO, J_BOTTOM, J_BOTTOMLEFT, J_BOTTOMRIGHT, J_CENTER, J_LEFT, J_RIGHT, J_TOP, J_TOPLEFT, J_TOPRIGHT, MAX_PANELS_PER_SESSION, MAX_SESSIONS, MB_ABORTRETRYIGNORE, MB_CANCEL, MB_ENTER, MB_ENTERCANCEL, MB_OK, MB_OKCANCEL, MB_RETRYCANCEL, MB_YESNO, MB_YESNOCANCEL, MBID_CANCEL, MBID_DEFAULT, MBID_ENTER, MBID_IGNORE, MBID_NO, MBID_OK, MBID_RETRY, MBID_YES, MS_MOVE, MS_NONE, MS_SIZE, NETPHANTOM_VERSION, OBJEVENT_CHECK, OBJEVENT_CLICK, OBJEVENT_DBLCLICK, OBJEVENT_DEFOCUS, OBJEVENT_FOCUS, OBJEVENT_SELECT, OBJEVENT_USERCHANGE, PANELCREATE_APPPANEL, PANELCREATE_DANGLINGPANEL, PANELCREATE_DLGFRAME, PANELCREATE_EXTENDEDINFO, PANELCREATE_ICON, PANELCREATE_INDIVIDUALSIZE, PANELCREATE_POPUP, REPLYTYPE_CLIENTEXECUTE, REPLYTYPE_CLIPBOARD, REPLYTYPE_DDE, REPLYTYPE_FFONTLIST, REPLYTYPE_MESSAGEBOX, REPLYTYPE_REPORT, REPLYTYPE_SAVEPROPS, REPLYTYPE_TERMMARK, RPRT_CANCELPRINTJOB, RPRT_CLOSEPRINTJOB, RPRT_CONTPRINTJOB, RPRT_OPENPRINTJOB, RPRT_PRINTJOBCANCLD, RPRT_PRINTJOBCLOSED, RPRT_PRINTJOBCONT, RPRT_PRINTJOBOPENED, RPRT_PRINTJOBSTARTED, RPRT_STARTPRINTJOB, SEGMENT_SIZE, SELMODE_NORMAL, SELMODE_NOTALLOWED, SELMODE_REQUIRED, SELTYPE_MULTIPLE, SELTYPE_SINGLE, SEPARATOR, SEPARATORCHAR, TRANS_APPLICATIONCHANGE, TRANS_CALLOBJECT, TRANS_CANCELEXIT, TRANS_CLEARLOCK, TRANS_CLIENTEXECUTE, TRANS_CLIENTJARS, TRANS_CLIENTTEXTTABLE, TRANS_CLIENTUPDATED, TRANS_CLIENTUPDATEDNOLOCK, TRANS_CLIPBOARD, TRANS_CLIPBOARDCOMPONENT, TRANS_CLOSETERMINALWINDOW, TRANS_CONNECTIONREFUSED, TRANS_COUNTRYINFO, TRANS_CREATEPANEL, TRANS_CREATESESSION, TRANS_DDE, TRANS_DDEEVENT, TRANS_DDEEVENTREPLY, TRANS_DDEVAREVENT, TRANS_DISPLAYHELP, TRANS_DISPLAYTERMINAL, TRANS_DISPLAYTOOLTIPS, TRANS_ENDCONVERSATION, TRANS_EXIT, TRANS_FONTSUBSTITUTION, TRANS_HOSTCOLORTABLE, TRANS_HOSTPRINT, TRANS_INACTIVESESSION, TRANS_INITIATE, TRANS_KEEPALIVE, TRANS_LOCALE, TRANS_LOGEVENT, TRANS_MESSAGEBOX, TRANS_MESSAGEBOXWITHREPLY, TRANS_MODALREPLY, TRANS_MULTTERM, TRANS_PING, TRANS_PRINTCOMPONENT, TRANS_PRINTPANEL, TRANS_PRINTREPORT, TRANS_PRTWINKEY, TRANS_RECONNECT, TRANS_REDIRECTION, TRANS_REMOVEPANELATLEVEL, TRANS_REMOVETERMINAL, TRANS_RENEGOTIATESSL, TRANS_REQUESTHELP, TRANS_RESOURCEURL, TRANS_SELECTSESSION, TRANS_SESSIONACTIVE, TRANS_SESSIONSELECTED, TRANS_SETCOLORS, TRANS_SETFOCUS, TRANS_SETLOCK, TRANS_SETPANELNESTLEVEL, TRANS_SETUPPARAMS, TRANS_SHOWDOCUMENT, TRANS_SOCKET, TRANS_SOUNDALARM, TRANS_STARTUPINFO, TRANS_STOPSESSION, TRANS_TERMINALDATA, TRANS_TERMINALUPDATE, TRANS_TERMINALWINDOW, TRANS_TERMWINTEXT, TRANS_UPDATEAPPLICATION, TRANS_UPDATEPANEL, TRANS_USEREXITPRTKEY, TRANSACTION_VERSION, TS_CLOSE, TS_DATA, TS_ERROR, TS_OPEN, VSIGN_MINUS, VSIGN_NONE, VSIGN_PLUSMINUS, YEARF_6DIG, YEARF_8DIG, YEARF_EXP8

Fields inherited from interface se.entra.phantom.server.IReloadable

FAILURE, NOTHING_DONE, SUCCESS

Constructor Summary

Constructors

Constructor and Description
PhantomObject() Creates a non-initialized object that after initialization can be added to the application.
PhantomObject(PhantomFile file, PhantomRuntime runtime, boolean doLoadObjects, int index)

Method Summary

Methods

Modifier and Type	Method and Description
String	callObject(ObjectReply reply, PhantomWorker worker, VirtualInterface vi, String id, int action, String stringArg) Calls the object with the parameters id, action, string.
String	callObject(ObjectReply reply, PhantomWorker worker, VirtualInterface vi, String id, int action, String stringArg, boolean asyncExec) Calls the object with the parameters id, action, string.
String	callObject(PhantomWorker worker, VirtualInterface vi, String id, int action, String stringArg) Calls the object with the parameters id, action, string.
String	callObject(PhantomWorker worker, VirtualInterface vi, String id, int action, String stringArg, boolean asyncExec) Calls the object with the parameters id, action, string.
int	compareTo(PhantomObject o) Used for sorting of two PhantomObjects by the name with Arrays.sort.
int	getClientEventFlags() Return the events that should make the client to issue an action event transaction to the server.
String	getDescription() Gets the description.
String	getFileName() Gets the file name of the object.
int	getFilter() Gets the filter value.
PhantomMacro	getMacro() Gets the PhantomMacro of this object.
String	getName() Gets the name of this host field.
static long	getNext() Increase counter and return it.
PhantomPopupMenu	getPopupMenu() Gets the pop-up menu of the object.
String	getProcedure() Gets the procedure of the object.
PhantomRuntime	getRuntime() Gets the runtime file where the object or pop-up menu is loaded from.
int	getType() Gets the type of the object.
boolean	isEventUsed(int event) Check if this object uses a special event.
boolean	isPopupMenu() Checks if this object is a pop-up menu.
void	load(PhantomFile file, PhantomRuntime runtime, boolean doLoadObjects, int index) Loads the object definition from the application file.
void	loadObjectClass(PhantomRuntime runtime) Loads the class files for REXX/DLL objects.
void	maybeThrowIOException(String msg) Throws an IOException with the message specified if the runtime file is loaded normally and doesn't have the flag doIgnoreNonFatalErrors set.
boolean	needsReload() Check if this file needs to be reloaded.
void	postCreate(PhantomApplicationData applicationData, PhantomFile file2) The post creation routine loads the pop-up menus.
void	postCreate(PhantomRuntime runtime) The post creation routine loads the pop-up menus.
int	reload(boolean force) Reload internal state from external sources.
void	save(PhantomOutputFile file) Saves the object definition to file.
void	setRuntime(PhantomRuntime rt) Set the runtime reference.
String	toString() Converts this object to a string for debug purposes.
boolean	wasPhantomMacro(String macroName) Checks if the object used to be a Phantom Macro, now converted to a REXX macro.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

OBJ_REXXCMD

public static final int OBJ_REXXCMD

REXX Command file.

See Also:

Constant Field Values

OBJ_REXXMACRO

public static final int OBJ_REXXMACRO

REXX macro.

See Also:

Constant Field Values

OBJ_DLL

public static final int OBJ_DLL

DLL.

See Also:

Constant Field Values

OBJ_MACRO

public static final int OBJ_MACRO

Phantom Macro.

See Also:

Constant Field Values

OBJ_REXXAPPLICATION

public static final int OBJ_REXXAPPLICATION

REXX macro.

See Also:

Constant Field Values

OBJ_POPUPMENU

public static final int OBJ_POPUPMENU

Pop-up menu.

See Also:

Constant Field Values

OBJ_JAVA

public static final int OBJ_JAVA

Java code.

See Also:

Constant Field Values

OBJFLAG_ENTER_LOCK

public static final int OBJFLAG_ENTER_LOCK

Flag to lock panels & host at enter of object call.

See Also:

Constant Field Values

OBJFLAG_EXIT_UNLOCK

public static final int OBJFLAG_EXIT_UNLOCK

Flag to unlock panels & host at exit of object call.

See Also:

Constant Field Values

name

public String name

Name of the object.

type

public int type

Type of object.

flags

public int flags

Object flags (OBJFLAG_ENTER_LOCK and OBJFLAG_EXIT_UNLOCK).

filter

public int filter

Object calling filter.

fileName

public String fileName

File name for object code. For the Java object, this is the class name.

procedure

public String procedure

Procedure/entry point name. For Java object, this is null.

description

public String description

The description.

Constructor Detail

PhantomObject

public PhantomObject()

Creates a non-initialized object that after initialization can be added to the application.

PhantomObject

public PhantomObject(PhantomFile file,
             PhantomRuntime runtime,
             boolean doLoadObjects,
             int index)
              throws IOException

Throws:

IOException

Method Detail

getNext

public static long getNext()

Increase counter and return it.

getRuntime

public PhantomRuntime getRuntime()

Gets the runtime file where the object or pop-up menu is loaded from.

Returns:

null if it's not yet loaded.

load

public void load(PhantomFile file,
        PhantomRuntime runtime,
        boolean doLoadObjects,
        int index)
          throws IOException

Loads the object definition from the application file.

 Base:
  + Object name            BYTE [9]
  + Description            BYTE [32]
  + Type of object         BYTE
  + File name              BYTE [13]
  + Procedure name         BYTE [26]
  + Flags                  BYTE
  + Filter                 ULONG
  + Reserved (skipped)     BYTE [16]

 Skip all these members (total 18 bytes):
  + Calling count          USHORT
  + Pointer to file data   ULONG
  + Length of file data    ULONG
  + Pointer to REXX data   ULONG
  + Length of REXX data    ULONG
 

The reference to the Phantom Macro, DLL object or the REXX code are also resolved to a class reference. DLL objects use class names as "DLLOBJ_fileName_procedureName". REXX code uses the class name as "REXX_fileName". All names are in upper case without package names.

Throws:

IOException - if an I/O error occurs.

maybeThrowIOException

public void maybeThrowIOException(String msg)
                           throws IOException

Throws an IOException with the message specified if the runtime file is loaded normally and doesn't have the flag doIgnoreNonFatalErrors set. If it is not thrown, a message is logged in the event log.

Throws:

IOException

save

public void save(PhantomOutputFile file)
          throws IOException

Saves the object definition to file.

 Base:
  + Object name            BYTE [9]
  + Description            BYTE [32]
  + Type of object         BYTE
  + File name              BYTE [13]
  + Procedure name         BYTE [26]
  + Flags                  BYTE
  + Filter                 ULONG
  + Reserved (skipped)     BYTE [16]

 Skip all these members (total 18 bytes):
  + Calling count          USHORT
  + Pointer to file data   ULONG
  + Length of file data    ULONG
  + Pointer to REXX data   ULONG
  + Length of REXX data    ULONG
 

Parameters:

file -

Throws:

IOException - if an I/O error occurs.

getDescription

public String getDescription()

Gets the description.

getFilter

public int getFilter()

Gets the filter value.

postCreate

public void postCreate(PhantomRuntime runtime)
                throws IOException

The post creation routine loads the pop-up menus. This is required because the menu items may refer to objects that are not loaded during the constructor.

Throws:

IOException - if an I/O error occurs.

postCreate

public void postCreate(PhantomApplicationData applicationData,
              PhantomFile file2)
                throws IOException

The post creation routine loads the pop-up menus. This is required because the menu items may refer to objects that are not loaded during the constructor.

Throws:

IOException - if an I/O error occurs.

setRuntime

public void setRuntime(PhantomRuntime rt)

Set the runtime reference.

Parameters:

rt -

loadObjectClass

public void loadObjectClass(PhantomRuntime runtime)
                     throws IOException

Loads the class files for REXX/DLL objects. This is useful when the runtime has been loaded without loading the classes.

Throws:

IOException - if an I/O error occurs.

needsReload

public boolean needsReload()

Check if this file needs to be reloaded.

Specified by:

needsReload in interface IReloadable

Returns:

boolean

reload

public int reload(boolean force)
           throws IOException

Reload internal state from external sources.

Specified by:

reload in interface IReloadable

Parameters:

force - - force the reload.

Returns:

int

Throws:

IOException

getFileName

public final String getFileName()

Gets the file name of the object. Typically, this is done for REXX objects. For the Java object, this is the class name.

getName

public String getName()

Gets the name of this host field.

getMacro

public PhantomMacro getMacro()

Gets the PhantomMacro of this object.

isPopupMenu

public boolean isPopupMenu()

Checks if this object is a pop-up menu.

getType

public int getType()

Gets the type of the object.

getProcedure

public String getProcedure()

Gets the procedure of the object.

getPopupMenu

public PhantomPopupMenu getPopupMenu()

Gets the pop-up menu of the object.

callObject

public String callObject(PhantomWorker worker,
                VirtualInterface vi,
                String id,
                int action,
                String stringArg)

Calls the object with the parameters id, action, string.

Returns:

The string returned by the object or null if the object cannot be instantiated. For certain object actions, other default strings are returned when a filter is used. null is also returned for and invalid object action (or message).

callObject

public String callObject(ObjectReply reply,
                PhantomWorker worker,
                VirtualInterface vi,
                String id,
                int action,
                String stringArg)

Calls the object with the parameters id, action, string.

Returns:

The string returned by the object or null if the object cannot be instantiated. For certain object actions, other default strings are returned when a filter is used. null is also returned for and invalid object action (or message).

callObject

public String callObject(PhantomWorker worker,
                VirtualInterface vi,
                String id,
                int action,
                String stringArg,
                boolean asyncExec)

Calls the object with the parameters id, action, string.

This method should not be used by external classes. It's use is internal for the RemoteApplication in order to avoid asynchronous execution of REXX applications and Phantom Macros.

Returns:

The string returned by the object or null if the object cannot be instantiated. For certain object actions, other default strings are returned when a filter is used. null is also returned for and invalid object action (or message).

callObject

public String callObject(ObjectReply reply,
                PhantomWorker worker,
                VirtualInterface vi,
                String id,
                int action,
                String stringArg,
                boolean asyncExec)

Calls the object with the parameters id, action, string.

This method should not be used by external classes. It's use is internal for the RemoteApplication in order to avoid asynchronous execution of REXX applications and Phantom Macros.

Returns:

The string returned by the object or null if the object cannot be instantiated. For certain object actions, other default strings are returned when a filter is used. null is also returned for and invalid object action (or message).

isEventUsed

public boolean isEventUsed(int event)

Check if this object uses a special event.

getClientEventFlags

public int getClientEventFlags()

Return the events that should make the client to issue an action event transaction to the server.

wasPhantomMacro

public boolean wasPhantomMacro(String macroName)

Checks if the object used to be a Phantom Macro, now converted to a REXX macro.

Returns:

true if it is a REXX macro that has a procedure name like "macroName" (in upper case).

toString

public String toString()

Converts this object to a string for debug purposes.

Overrides:

toString in class Object

compareTo

public int compareTo(PhantomObject o)

Used for sorting of two PhantomObjects by the name with Arrays.sort.

Specified by:

compareTo in interface Comparable<PhantomObject>