Verastream© Bridge Integrator 4.1

com.attachmate.cicsbridge.ws
Class BridgeAPI

java.lang.Object
  extended by com.attachmate.cicsbridge.ws.BridgeAPI

public class BridgeAPI
extends java.lang.Object

Securing Host Communications

To enable a secure connection (encrypted communication to a Web service on the host using SSL over HTTPS), follow these simple steps:

  1. Using the Java keytool utility, create a trust store and import required certificates.
  2. Define at least one system property for configuring the Java SSL connection.
  3. Use one of three methods to configure the implementation used by the Bridge API to be secure (see below).

To configure the secure connection, you must customize JSSE (Java Secure Socket Extension) using at least one system property: javax.net.ssl.trustStore. This property should be set to the path to your trust store, created by the keytool utility. There are a large number of additional customizations you can make to JSSE that may pertain to you depending on how you have configured security on the host. Please see the Java Secure Socket Extension (JSSE) Reference Guide for Java Platform Standard Edition 6 for more information.

There are a number of ways to configure Bridge API for a secure connection to the host:

  1. Use a version of the BridgeAPI constructors that has a secureConnection argument. Pass in a value of true. This is the recommended approach.
  2. Use the new static BridgeAPIFactory methods to configure the Bridge API for a SOAP implementation that uses a secure connection.
  3. Set the com.attachmate.cicsbridge.defaultsecureconnection system property to "true".

There are two system properties you can use to configure the implementation:

com.attachmate.cicsbridge.defaultimpl - Set to either "binary" or "SOAP". By default, the internal Bridge API implementation is binary (non-secure). However, if you set this system property to "SOAP", it will use the SOAP implementation and connect to the Web service on the host.

com.attachmate.cicsbridge.defaultsecureconnection - Set to "true" to secure the connection with SSL. Currently, only the SOAP implementation can be secured, so this forces the SOAP implementation. This is the only system property you need to set. Using a non-secured SOAP connection is not recommended, but may be temporarily needed if security has not yet been configured on the host.

Of the three methods of configuration listed above, the first approach is simplest. The second provides fine-grained control over the implementation configuration, which can be useful during the development phase when the configuration with the host is not stable. Finally, system environment variables can be useful if you need to control the implementation used from outside of your application.

The following code will give you a working connection if you have the appropriate certificate imported into the Windows Certificate Manager:

     BridgeAPI bridgeAPI = new BridgeAPI(true);
You could also obtain a particular implementation of the Bridge API using BridgeAPIFactory:
     BridgeAPI bridgeAPI = BridgeAPIFactory.createBridgeAPI(BridgeAPIFactory.ImplTypeEnum.SOAP, true);
Or, you could rely on a system property to configure the connection:
     System.setProperty("javax.net.ssl.trustStore", "C:\\Path\\To\\.keystore"); \\ Or set this variable in the system environment itself
     BridgeAPI bridgeAPI = new BridgeAPI();

Configuring for Client Authentication

If you need a connection that authenticates the client, we recommend you secure the connection. When using a secure connection, credentials (username and password) are always sent to the host via the HTTP authorization header (using the basic authentication method).

By default, credentials are not sent to the host unless the connection is secure (since usernames and passwords are passed as plain text). If you must use client authentication with a non-secure connection, you will need to define the system property com.attachmate.cicsbridge.includecredentials (set to "true"). Note that this option only applies to the SOAP implementation of the Bridge API.

WARNING: Credentials included in a non-secure connection are not secure. Use with caution.

Configuring Bridge API Code Pages

The BridgeAPI class has twelve overloaded constructors. One of the common arguments, secureConnection, has already been discussed (in the previous section). The other arguments have to do with code page configuration and tracing. We will not discuss tracing here, but we will review the code page arguments.

The argument hostCodePage is probably the most important, as it is needed when connecting to a host that is configured to use a code page other than 037 (the default). Here is the list of supported host coded pages:

037 - US English, Portuguese
1140 - US English, Portuguese (Euro)
1141 - German, Austrian (Euro)
1142 - Danish, Norwegian (Euro)
1143 - Finnish, Swedish (Euro)
1144 - Italian (Euro)
1145 - Spanish (Euro)
1146 - UK English (Euro)
1147 - French (Euro)
1149 - Iceland (Euro)
273 - German, Austrian
277 - Danish, Norwegian
278 - Finnish, Swedish
280 - Italian
284 - Spanish
285 - UK English
297 - French
871 - Iceland

The clientCodepage argument defaults to the charset (encoding) used by this Java virtual machine—usually windows-1252 on a US Windows machine. The charset is determined by passing the value of clientCodepage into the java.nio.charset.Charset.forName static method. See JDK documentation on Supported Encoding for information on allowable values.

When using a secure connection (or a non-secure SOAP connection), the hostCodePage and clientCodepage arguments are ignored. The host code page value is determined from the terminal facility. The client code page is not used since characters are sent to the host in Unicode.


Field Summary
static java.lang.String DEFAULT_IMPL_TYPE_SYS_PROP_NAME
          This system property overrides the default BridgeAPI implementation type.
static java.lang.String DEFAULT_IMPL_TYPE_SYS_PROP_VALUE_BINARY
          This is the default BridgeAPI implementation type.
static java.lang.String DEFAULT_IMPL_TYPE_SYS_PROP_VALUE_SOAP
          Use this value to change the default BridgeAPI implementation type to SOAP.
static java.lang.String DEFAULT_SECURE_CONNECTION_SYS_PROP_NAME
          This system property can be used to default to a secure connection.
 
Constructor Summary
BridgeAPI()
          Default constructor - retains default host response timeout of 120 seconds, trace settings are no API tracing or logging to a trace file.
BridgeAPI(boolean secureConnection)
           
BridgeAPI(boolean traceWanted, int timeoutSeconds, java.lang.String traceFilePrefix)
          Constructor specifying if tracing is to be activated, host timeout seconds to use, and a prefix string for the tracefile if trace chosen - format ( "PREFIX-nnn.txt")
BridgeAPI(boolean traceWanted, int timeoutSeconds, java.lang.String traceFilePrefix, boolean secureConnection)
           
BridgeAPI(boolean traceWanted, int timeoutSeconds, java.lang.String traceFilePrefix, java.lang.String hostCodepage)
          Constructor specifying if tracing is to be activated, host timeout seconds to use, and a prefix string for the tracefile if trace chosen - format ( "PREFIX-nnn.txt")
BridgeAPI(boolean traceWanted, int timeoutSeconds, java.lang.String traceFilePrefix, java.lang.String hostCodepage, boolean secureConnection)
           
BridgeAPI(boolean traceWanted, int timeoutSeconds, java.lang.String traceFilePrefix, java.lang.String hostCodepage, java.lang.String clientCodepage)
          Constructor specifying if tracing is to be activated, host timeout seconds to use, and a prefix string for the tracefile if trace chosen - format ( "PREFIX-nnn.txt")
BridgeAPI(boolean traceWanted, int timeoutSeconds, java.lang.String traceFilePrefix, java.lang.String hostCodepage, java.lang.String clientCodepage, boolean secureConnection)
          Constructor specifying if tracing is to be activated, host timeout seconds to use, and a prefix string for the tracefile if trace chosen - format ( "PREFIX-nnn.txt")
BridgeAPI(java.lang.String hostCodepage)
          Host Codepage constructor - retains default host response timeout of 120 seconds, trace settings are no API tracing or logging to a trace file.
BridgeAPI(java.lang.String hostCodepage, boolean secureConnection)
           
BridgeAPI(java.lang.String hostCodepage, java.lang.String clientCodepage)
          Host Codepage constructor - retains default host response timeout of 120 seconds, trace settings are no API tracing or logging to a trace file.
BridgeAPI(java.lang.String hostCodepage, java.lang.String clientCodepage, boolean secureConnection)
           
 
Method Summary
 int changePassword(java.lang.String hostIP, int hostPort, java.lang.String userId, java.lang.String password, java.lang.String newPassword)
          Changes the password for a given userId.
 int connectBridge(java.lang.String hostIP, int hostPort, int terminalModel, java.lang.String userid, java.lang.String password)
          Obtains a session state context from the host data engine.
 int connectBridge(java.lang.String hostIP, int hostPort, int terminalModel, java.lang.String userid, java.lang.String password, java.lang.String terminalPoolName)
          Obtains a session state context from the host data engine.
 int connectBridge(java.lang.String hostIP, int hostPort, int terminalModel, java.lang.String userid, java.lang.String password, java.lang.String terminalPoolName, java.lang.String networkName)
          Obtains a session state context from the host data engine.
 int connectBridge(java.lang.String hostIP, int hostPort, int terminalModel, java.lang.String userid, java.lang.String password, java.lang.String terminalPoolName, java.lang.String networkName, java.lang.String terminalFacilityLike)
          Obtains a session state context from the host data engine.
 int disconnect()
          Disconnects the session, releasing the session state context from the host data engine.
 int findString(int inScreen, java.lang.String inString, int inStartRow, int inStartColumn, int inFlags, MutableInt outRow, MutableInt outColumn)
          Attempts to locate a given string on the current screen, beginning at a specified row and column position.
 int findString(java.lang.String inScreen, java.lang.String inString, int inStartRow, int inStartColumn, int inFlags, MutableInt outRow, MutableInt outColumn)
          Attempts to locate a given string on the current screen, beginning at a specified row and column position.
 int getAllFieldInformation(int inScreen, MutableInt outFieldCount, MutableObject outFieldNames, MutableObject outFieldValues, MutableObject outFieldAttributes, MutableObject outFieldRows, MutableObject outFieldCols, MutableObject outFieldLengths)
          Retrieves the information of all fields on the current screen.
 int getAllFieldInformation(int inScreen, MutableInt outFieldCount, MutableObject outFieldNames, MutableObject outFieldValues, MutableObject outFieldAttributes, MutableObject outFieldRows, MutableObject outFieldCols, MutableObject outFieldLengths, MutableObject outFieldColors, MutableObject outFieldHighlights)
          Retrieves the information of all fields on the current screen.
 int getAllFieldInformation(java.lang.String inScreen, MutableInt outFieldCount, MutableObject outFieldNames, MutableObject outFieldValues, MutableObject outFieldAttributes, MutableObject outFieldRows, MutableObject outFieldCols, MutableObject outFieldLengths)
          Retrieves the information of all fields on the current screen.
 int getAllFieldInformation(java.lang.String inScreen, MutableInt outFieldCount, MutableObject outFieldNames, MutableObject outFieldValues, MutableObject outFieldAttributes, MutableObject outFieldRows, MutableObject outFieldCols, MutableObject outFieldLengths, MutableObject outFieldColors, MutableObject outFieldHighlights)
          Retrieves the information of all fields on the current screen.
 int getConnectionStatus(MutableInt outStatus)
          Returns the status of the host connection.
 int getCurrentScreenName(int inTimeOut, MutableObject outScreenName)
          Returns the name of the current host screen.
 int getCursorPosition(MutableInt outRow, MutableInt outColumn)
          Retrieves the cursor position on the current host screen.
 int getFieldAttributes(int inScreen, int inField, MutableInt outAttributes)
          Retrieves the attributes of a specified field on the current screen.
 int getFieldAttributes(int inScreen, java.lang.String inField, MutableInt outAttributes)
          Retrieves the attributes of a specified field on the current screen.
 int getFieldAttributes(java.lang.String inScreen, int inField, MutableInt outAttributes)
          Retrieves the attributes of a specified field on the current screen.
 int getFieldAttributes(java.lang.String inScreen, java.lang.String inField, MutableInt outAttributes)
          Retrieves the attributes of a specified field on the current screen.
 int getFieldCoordinates(int inScreen, int inField, MutableInt outFieldRow, MutableInt outFieldColumn, MutableInt outFieldLength)
          Retrieves the coordinates (row, column, and length) of a specified field on the current screen.
 int getFieldCoordinates(int inScreen, java.lang.String inField, MutableInt outFieldRow, MutableInt outFieldColumn, MutableInt outFieldLength)
          Retrieves the coordinates (row, column, and length) of a specified field on the current screen.
 int getFieldCoordinates(java.lang.String inScreen, int inField, MutableInt outFieldRow, MutableInt outFieldColumn, MutableInt outFieldLength)
          Retrieves the coordinates (row, column, and length) of a specified field on the current screen.
 int getFieldCoordinates(java.lang.String inScreen, java.lang.String inField, MutableInt outFieldRow, MutableInt outFieldColumn, MutableInt outFieldLength)
          Retrieves the coordinates (row, column, and length) of a specified field on the current screen.
 int getFieldCount(int inScreen, MutableInt outFieldCount)
          Retrieves the coordinates (row, column, and length) of a specified field on the current screen.
 int getFieldCount(java.lang.String inScreen, MutableInt outFieldCount)
          Retrieves the coordinates (row, column, and length) of a specified field on the current screen.
 int getFieldNameFromIndex(int inScreen, int inFieldIndex, MutableObject outFieldName)
          Retrieves the field name based on its index on the current screen.
 int getFieldNameFromIndex(java.lang.String inScreen, int inFieldIndex, MutableObject outFieldName)
          Retrieves the field name based on its index on the current screen.
 int getFieldValue(int inScreen, int inField, MutableObject outValue)
          Retrieves the value of the specified field on the current screen.
 int getFieldValue(int inScreen, java.lang.String inField, MutableObject outValue)
          Retrieves the value of the specified field on the current screen.
 int getFieldValue(java.lang.String inScreen, int inField, MutableObject outValue)
          Retrieves the value of the specified field on the current screen.
 int getFieldValue(java.lang.String inScreen, java.lang.String inField, MutableObject outValue)
          Retrieves the value of the specified field on the current screen.
 java.lang.String getReturnCodeMessage(int returnCode)
          Returns a String explanation of a known error code.
 int getScreenInformation(MutableInt outCursorPosition, MutableObject outAidKey, MutableInt outFieldCount, MutableObject outScreenName, MutableObject outFieldNames, MutableObject outFieldValues, MutableObject out3270FieldAttributes, MutableObject outFieldRows, MutableObject outFieldCols, MutableObject outFieldLengths, MutableObject outFieldColors, MutableObject outFieldHighlights)
          Gets all relevant information for a given session.
 int getScreenSize(int inScreen, MutableInt outRow, MutableInt outColumn)
          Retrieves the size of the current screen.
 int getScreenSize(java.lang.String inScreen, MutableInt outRow, MutableInt outColumn)
          Retrieves the size of the current screen.
 int getString(int inScreen, int inStartRow, int inStartColumn, int inLength, MutableObject outText)
          Retrieves any text on the current screen at the specified row, column, and length.
 int getString(java.lang.String inScreen, int inStartRow, int inStartColumn, int inLength, MutableObject outText)
          Retrieves any text on the current screen at the specified row, column, and length.
 int getTerminalID(MutableObject outTerminalID)
          Retrieves the checked out terminal ID for this session.
 int getTransactionSystemId(java.lang.String inHostIP, int inHostPort, java.lang.String inTransactionId, MutableObject outSystemId)
          Get a text string containing the name of the CICS System Id (outSystemId) in which a given transaction Id (inTransactionId) executes.
 int interpretFieldAttribute(byte inFieldAttribute)
          Returns an HPS style integer for a given 3270 Field Attribute(FA) byte.
 int putString(java.lang.String inText, int inRow, int inColumn, MutableInt outNumChars)
          Writes text to the session presentation space beginning at the row and column specified.
 int queryLoadModuleInformation(java.lang.String hostIP, int hostPort, java.lang.String userId, java.lang.String password, java.lang.String inLoadModuleName, MutableObject outLoadLibraryName, MutableInt outLoadModuleSize)
          Returns the module size and the name of the Load Library that a given application program or BMS map resides in via the Verastream Bridge Integrator.
 int sendKeys(java.lang.String inKeys)
          Writes text to the session presentation space beginning at the current cursor position.
 int sendKeysEx(java.lang.String inKeys)
          This method is included for backward compatibility only.
 int sendKeysGetAllFieldInformation(java.lang.String inKeys, MutableInt outFieldCount, MutableObject outFieldNames, MutableObject outFieldValues, MutableObject outFieldAttributes, MutableObject outFieldRows, MutableObject outFieldCols, MutableObject outFieldLengths, MutableObject outFieldColors, MutableObject outFieldHighlights)
          Retrieves the information of all fields on the current screen.
 int sendKeysGetString(java.lang.String inKeys, int inStartRow, int inStartColumn, int inLength, MutableObject outText)
          Sends a sequence of keystrokes and aid keys to the host and retrieves any text on the current screen at the specified row, column, and length.
 int setCursorPosition(int inRow, int inColumn)
          Sets the cursor position on the current host screen.
 int setFieldValue(int inField, java.lang.String inValue)
          Sets the value of the specified unprotected field on the current screen.
 int setFieldValue(MutableObject inFields, MutableObject inValues)
          Sets the value of an array of specified unprotected fields on the current screen with a single call.
 int setFieldValue(java.lang.String inField, java.lang.String inValue)
          Sets the value of the specified unprotected field on the current screen.
 int setSettleTime(int inSettleTime)
          This method is included for backward compatibility only.
 int setTimeOut(int inTimeOut)
          This method is included for backward compatibility only.
 int setTraceActive(java.lang.String inTraceQueueName)
          Start CICS 3270 Bridge Vector trace and optionally pass in a trace Temporary Storage queue name.
 int setTraceInactive()
          Stop CICS 3270 Bridge Vector trace.
 int setTraceName(java.lang.String inTraceQueueName)
          Set name of CICS 3270 Bridge Vector trace for this session.
 int terminate()
          This method is included for backward compatibility only.
 int x3270Screen(java.lang.String inKeys, int inFieldIndex, java.lang.String inFieldValue, MutableInt outCursorPosition, MutableObject outAidKey, MutableInt outFieldCount, MutableObject outScreenName, MutableObject outFieldNames, MutableObject outFieldValues, MutableObject out3270FieldAttributes, MutableObject outFieldRows, MutableObject outFieldCols, MutableObject outFieldLengths, MutableObject outFieldColors, MutableObject outFieldHighlights)
          Place String value into the specified 3270 field of the current screen buffer, execute an AID key sequence, and get all relevant 3270 information from the reqested screen in a given session.
 int x3270Screen(java.lang.String inKeys, java.lang.String[] inFieldNames, java.lang.String[] inFieldValues, MutableInt outCursorPosition, MutableObject outAidKey, MutableInt outFieldCount, MutableObject outScreenName, MutableObject outFieldNames, MutableObject outFieldValues, MutableObject out3270FieldAttributes, MutableObject outFieldRows, MutableObject outFieldCols, MutableObject outFieldLengths, MutableObject outFieldColors, MutableObject outFieldHighlights)
          Place String value into the specified 3270 field of the current screen buffer, execute an AID key sequence, and get all relevant 3270 information from the reqested screen in a given session.
 int x3270Screen(java.lang.String inKeys, java.lang.String inFieldName, java.lang.String inFieldValue, MutableInt outCursorPosition, MutableObject outAidKey, MutableInt outFieldCount, MutableObject outScreenName, MutableObject outFieldNames, MutableObject outFieldValues, MutableObject out3270FieldAttributes, MutableObject outFieldRows, MutableObject outFieldCols, MutableObject outFieldLengths, MutableObject outFieldColors, MutableObject outFieldHighlights)
          Place String value into the specified 3270 field of the current screen buffer, execute an AID key sequence, and get all relevant 3270 information from the reqested screen in a given session.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_IMPL_TYPE_SYS_PROP_NAME

public static final java.lang.String DEFAULT_IMPL_TYPE_SYS_PROP_NAME
This system property overrides the default BridgeAPI implementation type.

See Also:
Constant Field Values

DEFAULT_IMPL_TYPE_SYS_PROP_VALUE_BINARY

public static final java.lang.String DEFAULT_IMPL_TYPE_SYS_PROP_VALUE_BINARY
This is the default BridgeAPI implementation type.

See Also:
Constant Field Values

DEFAULT_IMPL_TYPE_SYS_PROP_VALUE_SOAP

public static final java.lang.String DEFAULT_IMPL_TYPE_SYS_PROP_VALUE_SOAP
Use this value to change the default BridgeAPI implementation type to SOAP.

See Also:
Constant Field Values

DEFAULT_SECURE_CONNECTION_SYS_PROP_NAME

public static final java.lang.String DEFAULT_SECURE_CONNECTION_SYS_PROP_NAME
This system property can be used to default to a secure connection. Set to true to enable secure connection.

See Also:
Constant Field Values
Constructor Detail

BridgeAPI

public BridgeAPI()
Default constructor - retains default host response timeout of 120 seconds, trace settings are no API tracing or logging to a trace file.


BridgeAPI

public BridgeAPI(boolean secureConnection)

BridgeAPI

public BridgeAPI(java.lang.String hostCodepage)
Host Codepage constructor - retains default host response timeout of 120 seconds, trace settings are no API tracing or logging to a trace file.


BridgeAPI

public BridgeAPI(java.lang.String hostCodepage,
                 boolean secureConnection)

BridgeAPI

public BridgeAPI(java.lang.String hostCodepage,
                 java.lang.String clientCodepage)
Host Codepage constructor - retains default host response timeout of 120 seconds, trace settings are no API tracing or logging to a trace file.


BridgeAPI

public BridgeAPI(java.lang.String hostCodepage,
                 java.lang.String clientCodepage,
                 boolean secureConnection)

BridgeAPI

public BridgeAPI(boolean traceWanted,
                 int timeoutSeconds,
                 java.lang.String traceFilePrefix)
          throws java.lang.Exception
Constructor specifying if tracing is to be activated, host timeout seconds to use, and a prefix string for the tracefile if trace chosen - format ( "PREFIX-nnn.txt")

Throws:
java.lang.Exception

BridgeAPI

public BridgeAPI(boolean traceWanted,
                 int timeoutSeconds,
                 java.lang.String traceFilePrefix,
                 boolean secureConnection)
          throws java.lang.Exception
Throws:
java.lang.Exception

BridgeAPI

public BridgeAPI(boolean traceWanted,
                 int timeoutSeconds,
                 java.lang.String traceFilePrefix,
                 java.lang.String hostCodepage)
          throws java.lang.Exception
Constructor specifying if tracing is to be activated, host timeout seconds to use, and a prefix string for the tracefile if trace chosen - format ( "PREFIX-nnn.txt")

Throws:
java.lang.Exception

BridgeAPI

public BridgeAPI(boolean traceWanted,
                 int timeoutSeconds,
                 java.lang.String traceFilePrefix,
                 java.lang.String hostCodepage,
                 boolean secureConnection)
          throws java.lang.Exception
Throws:
java.lang.Exception

BridgeAPI

public BridgeAPI(boolean traceWanted,
                 int timeoutSeconds,
                 java.lang.String traceFilePrefix,
                 java.lang.String hostCodepage,
                 java.lang.String clientCodepage)
          throws java.lang.Exception
Constructor specifying if tracing is to be activated, host timeout seconds to use, and a prefix string for the tracefile if trace chosen - format ( "PREFIX-nnn.txt")

Throws:
java.lang.Exception

BridgeAPI

public BridgeAPI(boolean traceWanted,
                 int timeoutSeconds,
                 java.lang.String traceFilePrefix,
                 java.lang.String hostCodepage,
                 java.lang.String clientCodepage,
                 boolean secureConnection)
          throws java.lang.Exception
Constructor specifying if tracing is to be activated, host timeout seconds to use, and a prefix string for the tracefile if trace chosen - format ( "PREFIX-nnn.txt")

Throws:
java.lang.Exception
Method Detail

getReturnCodeMessage

public java.lang.String getReturnCodeMessage(int returnCode)
Returns a String explanation of a known error code.

Parameters:
returnCode - int value of return code obtained from a BridgeAPI method call.
Returns:
String with brief explanation of the error encountered. Possible values, meanings:
   Return Code     Meaning
      
     (Successful completion with no error)
     0             Successful execution no errors encountered.
                  
     (Errors that occurred on the client side)
     -5            Invalid parameter supplied to method
     -6            Error in sending message to Host CICS
     -7            Connection refused.
     -8            Missing parameter object.
     -9            Invalid terminal model.
    -15            No Content-Length token in mainframe response.
    -30            No "HTTP/1.0 200 OK" token found in mainframe response.
    -31            Authentication error.
    -35            API function requesting other than the current screen. 
    -37            No field name supplied.
    -39            Invalid field index value.
    -40            Screen name greater than 255 characters.
    -70            No SetField field data supplied.   
    -85            Unsuccessful TERMID check out from pool.
   
     (Errors that occurred on the CICS side)
    200            CICS COMMAREA HAD A LENGTH OF ZERO AT THE START
    201            UNRECOGNIZED REQUEST FUNCTION CODE IN COMMAREA
    202            UNRECOGNIZED EYECATCHER IN REQUEST COMMAREA
    210            INQUIRE TERMINAL FOR CASE FAILED FOR CONNECT
    212            INQUIRE TERMINAL FOR CONVERSE FAILED
    214            INQUIRE TERMINAL FAILED
    215            TERMINAL ID IN USE
    320            TERMINAL MODEL NUMBER IN CONNECT REQUEST WAS INVALID
    330            BUFFER SIZE FROM SESSION STATE IS NOT A VALID BUFFSIZE
    340            USER ID/PASSWORD COMBINATION INVALID
    401            CICS GETMAIN FOR MSG Q STAGING AREA FAILED
    410            CICS GETMAIN FOR REPLY VECTOR FAILED
    460            CICS GETMAIN FOR CREATION OF SESSION STATE DATA FAILED
    461            CICS GETMAIN FOR CREATION OF MSG AND REPLY ECBS FAILED
    470            CICS GETMAIN TO HOLD SESSION STATE DATA FAILED
    600            CICS WRITE TO THE BRIDGE MSG TSQ RESOURCE FAILED
    610            CICS WRITE TO THE SESSION STATE Q RESOURCE FAILED
    620            CICS READ OF THE BRIDGE REPLY TSQ RESOURCE FAILED
    650            CICS READ OF THE STATE TSQ RESOURCE FAILED
    651            REQUESTED SESSION IS NOT ACTIVE OR VALID
    700            CICS START APPLICATION TRAN(xxxx) WITH BRIDGE FAILED
    710            TIMEOUT ON A READ OF THE BRIDGE REPLYQ
    715            BRIDGE EXIT DETECTED FAILURE WHILE PROCESSING TRANSACTION
    718            TRANSACTION INQUIRY FAILED
    755            TRACE REQUEST QNAME IS INVALID
    760            HOST APPLICATION ISSUED AN EXPLICIT ROLLBACK
    800            UNRECOG BRIDGE REQUEST VECTOR RETURNED IN REPLY Q DATA
    801            UNHANDLED BRIDGE VECTOR:  VECTOR = xxxx
    810            UNRECOG METHOD CODE FOR GET SECURITY INFO IN CONNECT
    999            UNEXPECTED OR UNKNOWN ERROR CONDITION
   1001            CICS START OF CLEANUP TRAN(xxxx) FAILED
   1002            CICS CANCEL OF STARTED ICE FAILED
   1003            CICS RETRIEVE OF DATA ASSOC WITH ICE START, FAILED
   1010            INVALID FINDSTRING SCREEN,ROW,COL,STRING COMBINATION
   1100            CICS SEND MAP WITH MAPPINGDEV AND FRSET FAILED
   1110            CICS SEND MAP WITH MAPPINGDEV NO FRSET FAILED
   1120            CICS SEND MAP FOR CESN WITH MAPPINGDEV NO FRSET FAILED
   1200            CICS LOAD PROGRAM WITH MAPSET FAILED
   1210            CICS RELEASE PROGRAM WITH MAPSET FAILED
   1300            SENDKEYS STRING LENGTH = ZERO.
   1301            INVALID SCREEN INDEX OR SCREEN NAME VALUE
   1302            PUTSTRING -> PUTSTRINGEX TO VCUT DISPLAY BUFFER FAILED
   1303            PUTSTRINGEX TO VCUT DISPLAY BUFFER FAILED
   1304            SENDKEYS PUTSTRING TO VCUT DISPLAY BUFFER FAILED
   1305            SENDKEYS STRING INVALID, ENDED WITH A SINGLE ESC CHAR
   1306            UNEXPECTED OR UNKNOWN REQUEST FUNCTION
   1307            INVALID GETSTRING ROW,COL,LEN COMBINATION FOR MODEL
   1308            RENDER OF AID KEY IN VCUT DISPLAY BUFFER FAILED
   1309            PUTSTRING REQUEST ROW IS INVALID FOR MODEL
   1310            PUTSTRING REQUEST COL IS INVALID FOR MODEL
   1311            PUTSTRING TEXT LENGTH INVALID FOR MODEL BUFFER SIZE
   1312            GET FIELD INFORMATION FAILED
   1313            SET FIELD VALUE FAILED
   1314            GET ALL FIELD INFORMATION FAILED
   1320            FIELDCOUNT FAILED
   1321            FINDFIELD FAILED
   1322            FINDSTRING FAILED
   1323            INVALID ROW, COL, POSITION COMBINATION FOR REQUEST
   1326            GETATTRIBUTES FAILED
   1327            GETSTRINGEX FAILED FOR PASSWORD
   1328            GETSTRINGEX FAILED FOR USERID
   1400            CICS verification failure message from the External Security Manager, in this format:
        (See the execution tracelog, System.out, or console for more details)
        CICS VERIFY: INVALID USERID            ESMREASON=numberESMRESP=number
        CICS VERIFY: INVALID PASSWORD          ESMREASON=numberESMRESP=number
        CICS VERIFY: UNKNOWN RET FROM THE ESM: ESMREASON=numberESMRESP=number
        CICS VERIFY: ESM INTERFACE IS NOT INIT ESMREASON=numberESMRESP=number
        CICS VERIFY: ESM NOT RESPONDING:       ESMREASON=numberESMRESP=number
        CICS VERIFY: NEW PASSWORD IS REQUIRED: ESMREASON=numberESMRESP=number
        CICS VERIFY: THE USERID IS REVOKED:    ESMREASON=numberESMRESP=number
        CICS VERIFY: UNKNOWN RESP CODE:        ESMREASON=numberESMRESP=number
        CICS VERIFY: UNKNOWN RESP2 CODE:       ESMREASON=numberESMRESP=number
   1402            CICS Verification failed with External Security Manager: INVALID_PASSWORD
   1403            CICS Verification failed with External Security Manager: NEW_PASSWORD_REQUIRED
   1404            CICS Verification failed with External Security Manager: NEW_PASSWORD_NOT_ACCEPTABLE
   1408            CICS Verification failed with External Security Manager: UNKNOWN_USERID
   1419            CICS Verification failed with External Security Manager: USERID_REVOKED
   1432            CICS Verification failed with External Security Manager: USERID_CONTAINS_BLANK
   1497            CICS Verification failed with External Security Manager: USERID_MISSING
   1498            CICS Verification failed with External Security Manager: PASSWORD_MISSING
   1499            CICS Verification failed with External Security Manager: NEW_PASSWORD_MISSING
        
     (Errors that occurred calling the Linkable Bridge)
 
   91020         CREATE  TERMID FROM AUTOINSTALL IS INVALID 
   91021         CREATE  NETNAME FROM AUTOINSTALL IS INVALID 
   91022         CREATE  AUTOINSTALL URM REJECTED BRIDGE INSTALL REQUEST 
   91023         CREATE  LINK TO AUTOINSTALL URM FAILED 
   91024         CREATE  SUPPLIED NETNAME INVALID 
   91025         CREATE  SUPPLIED TERMID INVALID 
   91026         CREATE  SUPPLIED FACILITYLIKE INVALID
   91040         CREATE  LINK TO THE DYNAMIC ROUTING URM 
   91041         CREATE  BRIDGE ROUTING REQUEST REJECTED BY THE DYNAMIC ROUTING URM 
   91042         CREATE  THE TRANSACTION DEFINITION DOES NOT ALLOW IT TO BE ROUTED TO THE REQUESTED REGION. 
   91043         CREATE  TRANSACTION REQUEST COULD NOT BE ROUTED TO THE REMOTE REGION DUE TO A CONNECTION ERROR.
   91044         CREATE  LINK TO AOR FAILED WITH TERMERR 
   91045         CREATE  REQUEST WAS ROUTED TO A BACK LEVEL CICS THAT DOES NOT SUPPORT LINKABLE BRIDGE
   91061         CREATE  INVALID FACILITYTOKEN SUPPLIED IN BRIDGE HEADER INFORMATION
   91062         CREATE  ALL BRIDGE FACILITIES ARE ALLOCATED
   91063         CREATE  THIS FACILITYTOKEN IS IN USE
   91064         CREATE  NOT ENOUGH STORAGE TO RUN REQUEST IN ROUTER REGION OR APPLICATION OWNING REGION
   91065         CREATE  FILE DFHBRNSF IS UNAVAILABLE OR HAS NOT BEEN DEFINED
   91066         CREATE  THE CICS REGION IS TERMINATING, PROCESSING REQUEST REJECTED
   91080         CREATE  TRANSACTION NOT ENABLED TO RUN AT SHUTDOWN
   91082         CREATE  TRANSACTION CAN ONLY BE SYSTEM ATTACHED, NOT VALID UNDER THE BRIDGE
   91084         CREATE  TRANSACTION IS DISABLED
   91085         CREATE  TRANSACTION IS NOT FOUND
   91086         CREATE  TRANSACTION IS NOT RUNNING ON BRIDGE FACILITY
   91087         CREATE  TRANSACTION PROFILE IS NOT FOUND
   91100         CREATE  USERID IN SESSION REQUEST DIFFERENT THAN USERID SUPPLIED TO ALLOCATE THE BRIDGE FACILITY
   91120         CREATE  THE GET MORE DATA REQUEST FAILED BECAUSE THERE WAS NO MORE DATA
   91121         CREATE  RETRIEVE VECTORS NOT SUPPORTED AFTER INITIAL REQUEST
   91140         CREATE  INVALID DATA LENGTH SPECIFIED IN BRIDGE HEADER          
   91141         CREATE  VECTOR IS INVALID          
   91142         CREATE  ALLOCATE FACILITY REQUEST CONTAINED AN INVALID KEEPTIME OF ZERO    
   91143         CREATE  MESSAGE CONTAINS NO VECTORS: CONTINUE REQUEST IS INVALID
   91160         CREATE  TARGET CICS 3270 APPLICATION ABEND
   92020         LINK    TERMID FROM AUTOINSTALL IS INVALID 
   92021         LINK    NETNAME FROM AUTOINSTALL IS INVALID 
   92022         LINK    AUTOINSTALL URM REJECTED BRIDGE INSTALL REQUEST 
   92023         LINK    LINK TO AUTOINSTALL URM FAILED 
   92024         LINK    SUPPLIED NETNAME INVALID 
   92025         LINK    SUPPLIED TERMID INVALID 
   92026         LINK    SUPPLIED FACILITYLIKE INVALID
   92040         LINK    LINK TO THE DYNAMIC ROUTING URM 
   92041         LINK    BRIDGE ROUTING REQUEST REJECTED BY THE DYNAMIC ROUTING URM 
   92042         LINK    THE TRANSACTION DEFINITION DOES NOT ALLOW IT TO BE ROUTED TO THE REQUESTED REGION. 
   92043         LINK    TRANSACTION REQUEST COULD NOT BE ROUTED TO THE REMOTE REGION DUE TO A CONNECTION ERROR.
   92044         LINK    LINK TO AOR FAILED WITH TERMERR 
   92045         LINK    REQUEST WAS ROUTED TO A BACK LEVEL CICS THAT DOES NOT SUPPORT LINKABLE BRIDGE
   92061         LINK    INVALID FACILITYTOKEN SUPPLIED IN BRIDGE HEADER INFORMATION
   92062         LINK    ALL BRIDGE FACILITIES ARE ALLOCATED
   92063         LINK    THIS FACILITYTOKEN IS IN USE
   92064         LINK    NOT ENOUGH STORAGE TO RUN REQUEST IN ROUTER REGION OR APPLICATION OWNING REGION
   92065         LINK    FILE DFHBRNSF IS UNAVAILABLE OR HAS NOT BEEN DEFINED
   92066         LINK    THE CICS REGION IS TERMINATING, PROCESSING REQUEST REJECTED
   92080         LINK    TRANSACTION NOT ENABLED TO RUN AT SHUTDOWN
   92082         LINK    TRANSACTION CAN ONLY BE SYSTEM ATTACHED, NOT VALID UNDER THE BRIDGE
   92084         LINK    TRANSACTION IS DISABLED
   92085         LINK    TRANSACTION IS NOT FOUND
   92086         LINK    TRANSACTION IS NOT RUNNING ON BRIDGE FACILITY
   92087         LINK    TRANSACTION PROFILE IS NOT FOUND
   92100         LINK    USERID IN SESSION REQUEST DIFFERENT THAN USERID SUPPLIED TO ALLOCATE THE BRIDGE FACILITY
   92120         LINK    THE GET MORE DATA REQUEST FAILED BECAUSE THERE WAS NO MORE DATA
   92121         LINK    RETRIEVE VECTORS NOT SUPPORTED AFTER INITIAL REQUEST
   92140         LINK    INVALID DATA LENGTH SPECIFIED IN BRIDGE HEADER          
   92141         LINK    VECTOR IS INVALID          
   92142         LINK    ALLOCATE FACILITY REQUEST CONTAINED AN INVALID KEEPTIME OF ZERO    
   92143         LINK    MESSAGE CONTAINS NO VECTORS: CONTINUE REQUEST IS INVALID
   92160         LINK    TARGET CICS 3270 APPLICATION ABEND
   93020         DELETE  TERMID FROM AUTOINSTALL IS INVALID 
   93021         DELETE  NETNAME FROM AUTOINSTALL IS INVALID 
   93022         DELETE  AUTOINSTALL URM REJECTED BRIDGE INSTALL REQUEST 
   93023         DELETE  LINK TO AUTOINSTALL URM FAILED 
   93024         DELETE  SUPPLIED NETNAME INVALID 
   93025         DELETE  SUPPLIED TERMID INVALID 
   93026         DELETE  SUPPLIED FACILITYLIKE INVALID
   93040         DELETE  LINK TO THE DYNAMIC ROUTING URM 
   93041         DELETE  BRIDGE ROUTING REQUEST REJECTED BY THE DYNAMIC ROUTING URM 
   93042         DELETE  THE TRANSACTION DEFINITION DOES NOT ALLOW IT TO BE ROUTED TO THE REQUESTED REGION. 
   93043         DELETE  TRANSACTION REQUEST COULD NOT BE ROUTED TO THE REMOTE REGION DUE TO A CONNECTION ERROR.
   93044         DELETE  LINK TO AOR FAILED WITH TERMERR 
   93045         DELETE  REQUEST WAS ROUTED TO A BACK LEVEL CICS THAT DOES NOT SUPPORT LINKABLE BRIDGE
   93061         DELETE  INVALID FACILITYTOKEN SUPPLIED IN BRIDGE HEADER INFORMATION
   93062         DELETE  ALL BRIDGE FACILITIES ARE ALLOCATED
   93063         DELETE  THIS FACILITYTOKEN IS IN USE
   93064         DELETE  NOT ENOUGH STORAGE TO RUN REQUEST IN ROUTER REGION OR APPLICATION OWNING REGION
   93065         DELETE  FILE DFHBRNSF IS UNAVAILABLE OR HAS NOT BEEN DEFINED
   93066         DELETE  THE CICS REGION IS TERMINATING, PROCESSING REQUEST REJECTED
   93080         DELETE  TRANSACTION NOT ENABLED TO RUN AT SHUTDOWN
   93082         DELETE  TRANSACTION CAN ONLY BE SYSTEM ATTACHED, NOT VALID UNDER THE BRIDGE
   93084         DELETE  TRANSACTION IS DISABLED
   93085         DELETE  TRANSACTION IS NOT FOUND
   93086         DELETE  TRANSACTION IS NOT RUNNING ON BRIDGE FACILITY
   93087         DELETE  TRANSACTION PROFILE IS NOT FOUND
   93100         DELETE  USERID IN SESSION REQUEST DIFFERENT THAN USERID SUPPLIED TO ALLOCATE THE BRIDGE FACILITY
   93120         DELETE  THE GET MORE DATA REQUEST FAILED BECAUSE THERE WAS NO MORE DATA
   93121         DELETE  RETRIEVE VECTORS NOT SUPPORTED AFTER INITIAL REQUEST
   93140         DELETE  INVALID DATA LENGTH SPECIFIED IN BRIDGE HEADER          
   93141         DELETE  VECTOR IS INVALID          
   93142         DELETE  ALLOCATE FACILITY REQUEST CONTAINED AN INVALID KEEPTIME OF ZERO    
   93143         DELETE  MESSAGE CONTAINS NO VECTORS: CONTINUE REQUEST IS INVALID
   93160         DELETE  TARGET CICS 3270 APPLICATION ABEND
 

changePassword

public int changePassword(java.lang.String hostIP,
                          int hostPort,
                          java.lang.String userId,
                          java.lang.String password,
                          java.lang.String newPassword)
                   throws java.lang.Exception
Changes the password for a given userId. The userId, encrypted password, and encrypted newPassword are sent to the host. If the password is correct for the userId then the new password is set as the valid password for this userId.

Parameters:
hostIP - String with IP address or hostname of target CICS region.
hostPort - integer TCP port address of target CICS region.
userId - String containing user identification one to eight bytes in length.
password - String existing password one to eight bytes in length for the given userId.
newPassword - String proposed new password one to eight bytes in length to use for the given userId.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

connectBridge

public int connectBridge(java.lang.String hostIP,
                         int hostPort,
                         int terminalModel,
                         java.lang.String userid,
                         java.lang.String password)
                  throws java.lang.Exception
Obtains a session state context from the host data engine. If the destination CICS region requires a CESN sign-on and the connectBridge does not pass a valid UserId and Password, the 3270 session is presented with the CESN sign-on screen upon completing the connectBridge. If a valid UserId and Password are passed in on the connectBridge, the user is Authenticated without requiring a separate CESN logon. Upon completion of a successful connectBridge featuring a valid UserId and Password, the session is at a clear screen, ready for a transaction to be initiated by the user.

Parameters:
hostIP - String with IP address or hostname of target CICS region.
hostPort - Port corresponding to the target CICS region.
terminalModel - 3270 terminal model type (valid values: 2 for Model 2, 3 for Model 3, 4 for Model 4, 5 for Model 5).
userid - The user ID for the host data engine to use with the External Security Manager on behalf of this session. If no userid is desired, use a null string or spaces.
password - The password for the host data engine to use with the External Security Manager on behalf of this session. If no userid is desired, use a null string or spaces.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

connectBridge

public int connectBridge(java.lang.String hostIP,
                         int hostPort,
                         int terminalModel,
                         java.lang.String userid,
                         java.lang.String password,
                         java.lang.String terminalPoolName)
                  throws java.lang.Exception
Obtains a session state context from the host data engine. If the destination CICS region requires a CESN sign-on and the connectBridge does not pass a valid UserId and Password, the 3270 session is presented with the CESN sign-on screen upon completing the connectBridge. If a valid UserId and Password are passed in on the connectBridge, the user is Authenticated without requiring a separate CESN logon. Upon completion of a successful connectBridge featuring a valid UserId and Password, the session is at a clear screen, ready for a transaction to be initiated by the user.

Parameters:
hostIP - String with IP address or hostname of target CICS region.
hostPort - Port corresponding to the target CICS region.
terminalModel - 3270 terminal model type (valid values: 2 for Model 2, 3 for Model 3, 4 for Model 4, 5 for Model 5).
userid - The user ID for the host data engine to use with the External Security Manager on behalf of this session. If no userid is desired, use a null string or spaces.
password - The password for the host data engine to use with the External Security Manager on behalf of this session. If no userid is desired, use a null string or spaces.
terminalPoolName - The terminal pool name from which to draw the desired 3270 connection. If no particular pool is desired, use a null string or spaces.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

connectBridge

public int connectBridge(java.lang.String hostIP,
                         int hostPort,
                         int terminalModel,
                         java.lang.String userid,
                         java.lang.String password,
                         java.lang.String terminalPoolName,
                         java.lang.String networkName)
                  throws java.lang.Exception
Obtains a session state context from the host data engine. If the destination CICS region requires a CESN sign-on and the connectBridge does not pass a valid UserId and Password, the 3270 session is presented with the CESN sign-on screen upon completing the connectBridge. If a valid UserId and Password are passed in on the connectBridge, the user is Authenticated without requiring a separate CESN logon. Upon completion of a successful connectBridge featuring a valid UserId and Password, the session is at a clear screen, ready for a transaction to be initiated by the user.

Parameters:
hostIP - String with IP address or hostname of target CICS region.
hostPort - Port corresponding to the target CICS region.
terminalModel - 3270 terminal model type (valid values: 2 for Model 2, 3 for Model 3, 4 for Model 4, 5 for Model 5).
userid - The user ID for the host data engine to use with the External Security Manager on behalf of this session. If no userid is desired, use a null string or spaces.
password - The password for the host data engine to use with the External Security Manager on behalf of this session. If no userid is desired, use a null string or spaces.
terminalPoolName - The terminal pool name from which to draw the desired 3270 connection. If no particular pool is desired, use a null string or spaces.
networkName - The one to eight character to be assigned to the pseudo LU for the new connection. To use default name for this connection, use a null or spaces.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

connectBridge

public int connectBridge(java.lang.String hostIP,
                         int hostPort,
                         int terminalModel,
                         java.lang.String userid,
                         java.lang.String password,
                         java.lang.String terminalPoolName,
                         java.lang.String networkName,
                         java.lang.String terminalFacilityLike)
                  throws java.lang.Exception
Obtains a session state context from the host data engine. If the destination CICS region requires a CESN sign-on and the connectBridge does not pass a valid UserId and Password, the 3270 session is presented with the CESN sign-on screen upon completing the connectBridge. If a valid UserId and Password are passed in on the connectBridge, the user is Authenticated without requiring a separate CESN logon. Upon completion of a successful connectBridge featuring a valid UserId and Password, the session is at a clear screen, ready for a transaction to be initiated by the user.

Parameters:
hostIP - String with IP address or hostname of target CICS region.
hostPort - Port corresponding to the target CICS region.
terminalModel - 3270 terminal model type (valid values: 2 for Model 2, 3 for Model 3, 4 for Model 4, 5 for Model 5).
userid - The user ID for the host data engine to use with the External Security Manager on behalf of this session. If no userid is desired, use a null string or spaces.
password - The password for the host data engine to use with the External Security Manager on behalf of this session. If no userid is desired, use a null string or spaces.
terminalPoolName - The terminal pool name from which to draw the desired 3270 connection. If no particular pool is desired, use a null string or spaces.
networkName - The one to eight character to be assigned to the pseudo LU for the new connection. To use default name for this connection, use a null or spaces.
terminalFacilityLike - The optional text format IP address of the requesting client. To omit client IP address, use a null string or spaces.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

disconnect

public int disconnect()
               throws java.lang.Exception
Disconnects the session, releasing the session state context from the host data engine.

Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

findString

public int findString(int inScreen,
                      java.lang.String inString,
                      int inStartRow,
                      int inStartColumn,
                      int inFlags,
                      MutableInt outRow,
                      MutableInt outColumn)
               throws java.lang.Exception
Attempts to locate a given string on the current screen, beginning at a specified row and column position.

Parameters:
inScreen - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inString - The string to search for on the current screen.
inStartRow - The row position at which to start the search. This parameter must be greater than or equal to 1.
inStartColumn - The column position at which to start the search. This parameter must be greater than or equal to 1.
inFlags - Flags that control the method's behavior. The flags can be a combination of the following values:
  1    :  The findString method wraps to the beginning of the screen or field after reaching the end.
  2    :  The findString method searches backward.
  4    :  The findString method searches only in the field that contains the specified row and column.  All other flags apply only within the field.
          The search begins at the point in the field specified by the inRow and inColumn parameters.  The outRow and outColumn parameters contain
          the position on the screen where the string is found, or zero if the string is not found.
  8    :  The findString method ignores case when searching for a string.
  NOTE: If you send a zero in the inFlags parameter, this method performs a screen-wide, case-sensitive, non-wrapping, forward search.
 
outRow - The row position where the string was found. If the string was not found, this returns a zero.
outColumn - The column position where the string was found. If the string was not found, this returns a zero.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

findString

public int findString(java.lang.String inScreen,
                      java.lang.String inString,
                      int inStartRow,
                      int inStartColumn,
                      int inFlags,
                      MutableInt outRow,
                      MutableInt outColumn)
               throws java.lang.Exception
Attempts to locate a given string on the current screen, beginning at a specified row and column position.

Parameters:
inScreen - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inString - The string to search for on the current screen.
inStartRow - The row position at which to start the search. This parameter must be greater than or equal to 1.
inStartColumn - The column position at which to start the search. This parameter must be greater than or equal to 1.
inFlags - Flags that control the method's behavior. The flags can be a combination of the following values:
  1    :  The findString method wraps to the beginning of the screen or field after reaching the end.
  2    :  The findString method searches backward.
  4    :  The findString method searches only in the field that contains the specified row and column.  All other flags apply only within the field.
          The search begins at the point in the field specified by the inRow and inColumn parameters.  The outRow and outColumn parameters contain
          the position on the screen where the string is found, or zero if the string is not found.
  8    :  The findString method ignores case when searching for a string.
  NOTE: If you send a zero in the inFlags parameter, this method performs a screen-wide, case-sensitive, non-wrapping, forward search.
 
outRow - The row position where the string was found. If the string was not found, this returns a zero.
outColumn - The column position where the string was found. If the string was not found, this returns a zero.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getAllFieldInformation

public int getAllFieldInformation(int inScreen,
                                  MutableInt outFieldCount,
                                  MutableObject outFieldNames,
                                  MutableObject outFieldValues,
                                  MutableObject outFieldAttributes,
                                  MutableObject outFieldRows,
                                  MutableObject outFieldCols,
                                  MutableObject outFieldLengths)
                           throws java.lang.Exception
Retrieves the information of all fields on the current screen.

Parameters:
inScreen - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
outFieldCount - The total number of fields on the current screen.
outFieldNames - The field names of all the fields on the current screen. Returns an array of type String, each holds a String representing the field name.
outFieldValues - The field values of all the fields on the current screen. Returns an array of type String, each occurrence of which holds a String representing the field name.
outFieldAttributes - The field attributes of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int the sum of which is determined by adding the following values:
  1    :  Field is protected
  2    :  Field can contain only numeric values
  4    :  Field is light-pen detectable
  8    :  Field is non display, non light-pen detectable
  16   :  Field is high-intensity
 
outFieldRows - The coordinates of rows of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the row coordinate.
outFieldCols - The coordinates of columns of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the column coordinate.
outFieldLengths - The lengths of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the field length.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getAllFieldInformation

public int getAllFieldInformation(int inScreen,
                                  MutableInt outFieldCount,
                                  MutableObject outFieldNames,
                                  MutableObject outFieldValues,
                                  MutableObject outFieldAttributes,
                                  MutableObject outFieldRows,
                                  MutableObject outFieldCols,
                                  MutableObject outFieldLengths,
                                  MutableObject outFieldColors,
                                  MutableObject outFieldHighlights)
                           throws java.lang.Exception
Retrieves the information of all fields on the current screen.

Parameters:
inScreen - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
outFieldCount - The total number of fields on the current screen.
outFieldNames - The field names of all the fields on the current screen. Returns an array of type String, each holds a String representing the field name.
outFieldValues - The field values of all the fields on the current screen. Returns an array of type String, each occurrence of which holds a String representing the field name.
outFieldAttributes - The field attributes of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int the sum of which is determined by adding the following values:
  1    :  Field is protected
  2    :  Field can contain only numeric values
  4    :  Field is light-pen detectable
  8    :  Field is non display, non light-pen detectable
  16   :  Field is high-intensity
 
outFieldRows - The coordinates of rows of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the row coordinate.
outFieldCols - The coordinates of columns of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the column coordinate.
outFieldLengths - The lengths of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the field length.
outFieldColors - The field colors in use in the fields on the current screen. Returns an array of type int, each occurrence of which holds a value that represents the color:
  0    :  White
  1    :  Blue
  2    :  Red
  3    :  Pink
  4    :  Green
  5    :  Turquoise
  6    :  Yellow
  7    :  White
 
outFieldHighlights - The field highlighting in use in the fields on the current screen. Returns an array of type int, each occurrence of which holds a value that represents the highlighting currently displayed for the respective 3270 field:
  0    :  Normal
  1    :  Blinking
  2    :  Reversed video
  3    :  Underscore
 
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getAllFieldInformation

public int getAllFieldInformation(java.lang.String inScreen,
                                  MutableInt outFieldCount,
                                  MutableObject outFieldNames,
                                  MutableObject outFieldValues,
                                  MutableObject outFieldAttributes,
                                  MutableObject outFieldRows,
                                  MutableObject outFieldCols,
                                  MutableObject outFieldLengths)
                           throws java.lang.Exception
Retrieves the information of all fields on the current screen.

Parameters:
inScreen - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
outFieldCount - The total number of fields on the current screen.
outFieldNames - The field names of all the fields on the current screen. Returns an array of type String, each holds a String representing the field name.
outFieldValues - The field values of all the fields on the current screen. Returns an array of type String, each occurrence of which holds a String representing the field name.
outFieldAttributes - The field attributes of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int the sum of which is determined by adding the following values:
  1    :  Field is protected
  2    :  Field can contain only numeric values
  4    :  Field is light-pen detectable
  8    :  Field is non display, non light-pen detectable
  16   :  Field is high-intensity
 
outFieldRows - The coordinates of rows of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the row coordinate.
outFieldCols - The coordinates of columns of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the column coordinate.
outFieldLengths - The lengths of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the field length.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getAllFieldInformation

public int getAllFieldInformation(java.lang.String inScreen,
                                  MutableInt outFieldCount,
                                  MutableObject outFieldNames,
                                  MutableObject outFieldValues,
                                  MutableObject outFieldAttributes,
                                  MutableObject outFieldRows,
                                  MutableObject outFieldCols,
                                  MutableObject outFieldLengths,
                                  MutableObject outFieldColors,
                                  MutableObject outFieldHighlights)
                           throws java.lang.Exception
Retrieves the information of all fields on the current screen.

Parameters:
inScreen - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
outFieldCount - The total number of fields on the current screen.
outFieldNames - The field names of all the fields on the current screen. Returns an array of type String, each holds a String representing the field name.
outFieldValues - The field values of all the fields on the current screen. Returns an array of type String, each occurrence of which holds a String representing the field name.
outFieldAttributes - The field attributes of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int the sum of which is determined by adding the following values:
  1    :  Field is protected
  2    :  Field can contain only numeric values
  4    :  Field is light-pen detectable
  8    :  Field is non display, non light-pen detectable
  16   :  Field is high-intensity
 
outFieldRows - The coordinates of rows of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the row coordinate.
outFieldCols - The coordinates of columns of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the column coordinate.
outFieldLengths - The lengths of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the field length.
outFieldColors - The field colors in use in the fields on the current screen. Returns an array of type int, each occurrence of which holds a value that represents the color:
  0    :  White
  1    :  Blue
  2    :  Red
  3    :  Pink
  4    :  Green
  5    :  Turquoise
  6    :  Yellow
  7    :  White
 
outFieldHighlights - The field highlighting in use in the fields on the current screen. Returns an array of type int, each occurrence of which holds a value that represents the highlighting currently displayed for the respective 3270 field:
  0    :  Normal
  1    :  Blinking
  2    :  Reversed video
  3    :  Underscore
 
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getConnectionStatus

public int getConnectionStatus(MutableInt outStatus)
                        throws java.lang.Exception
Returns the status of the host connection.

Parameters:
outStatus - The status of the host connection, which is one of the following values:
  0    :  The session is connected.
  1    :  The session is not connected
  2    :  NOT SUPPORTED: The session is connected but the presentation space (PS) is busy.
  3    :  NOT SUPPORTED: The connection is inhibited.
  4    :  NOT SUPPORTED: The host is in an unknown state.
 
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getCurrentScreenName

public int getCurrentScreenName(int inTimeOut,
                                MutableObject outScreenName)
                         throws java.lang.Exception
Returns the name of the current host screen.

Parameters:
inTimeOut - In this implementation, this parameter is disregarded. It is included only for backward compatibility.
outScreenName - The name of the current screen.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getCursorPosition

public int getCursorPosition(MutableInt outRow,
                             MutableInt outColumn)
                      throws java.lang.Exception
Retrieves the cursor position on the current host screen.

Parameters:
outRow - The cursor row position.
outColumn - The cursor column position.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getFieldAttributes

public int getFieldAttributes(int inScreen,
                              int inField,
                              MutableInt outAttributes)
                       throws java.lang.Exception
Retrieves the attributes of a specified field on the current screen.

Parameters:
inScreen - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inField - The zero base index number of the field on the screen.
outAttributes - The returned attributes of the specified field. The attributes can be a combination (sum) of the following. For example, if 5 is returned, the field is both protected (1) and light-pen detectable (4):
  1    :  The field is a protected field.
  2    :  The field can contain only numeric values.
  4    :  The field is light-pen detectable.
  8    :  The field is non-display, non-lightpen detectable.
  16   :  The field is a high-intensity field.NOT SUPPORTED: The host is in an unknown state.
 
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getFieldAttributes

public int getFieldAttributes(int inScreen,
                              java.lang.String inField,
                              MutableInt outAttributes)
                       throws java.lang.Exception
Retrieves the attributes of a specified field on the current screen.

Parameters:
inScreen - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inField - The name of the field.
outAttributes - The returned attributes of the specified field. The attributes can be a combination (sum) of the following. For example, if 5 is returned, the field is both protected (1) and light-pen detectable (4):
  1    :  The field is a protected field.
  2    :  The field can contain only numeric values.
  4    :  The field is light-pen detectable.
  8    :  The field is non-display, non-lightpen detectable.
  16   :  The field is a high-intensity field.NOT SUPPORTED: The host is in an unknown state.
 
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getFieldAttributes

public int getFieldAttributes(java.lang.String inScreen,
                              int inField,
                              MutableInt outAttributes)
                       throws java.lang.Exception
Retrieves the attributes of a specified field on the current screen.

Parameters:
inScreen - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inField - The zero base index number of the field on the screen.
outAttributes - The returned attributes of the specified field. The attributes can be a combination (sum) of the following. For example, if 5 is returned, the field is both protected (1) and light-pen detectable (4):
  1    :  The field is a protected field.
  2    :  The field can contain only numeric values.
  4    :  The field is light-pen detectable.
  8    :  The field is non-display, non-lightpen detectable.
  16   :  The field is a high-intensity field.NOT SUPPORTED: The host is in an unknown state.
 
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getFieldAttributes

public int getFieldAttributes(java.lang.String inScreen,
                              java.lang.String inField,
                              MutableInt outAttributes)
                       throws java.lang.Exception
Retrieves the attributes of a specified field on the current screen.

Parameters:
inScreen - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inField - The name of the field.
outAttributes - The returned attributes of the specified field. The attributes can be a combination (sum) of the following. For example, if 5 is returned, the field is both protected (1) and light-pen detectable (4):
  1    :  The field is a protected field.
  2    :  The field can contain only numeric values.
  4    :  The field is light-pen detectable.
  8    :  The field is non-display, non-lightpen detectable.
  16   :  The field is a high-intensity field.NOT SUPPORTED: The host is in an unknown state.
 
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getFieldCoordinates

public int getFieldCoordinates(int inScreen,
                               int inField,
                               MutableInt outFieldRow,
                               MutableInt outFieldColumn,
                               MutableInt outFieldLength)
                        throws java.lang.Exception
Retrieves the coordinates (row, column, and length) of a specified field on the current screen.

Parameters:
inScreen - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inField - The zero-based index of the field for which to get coordinates.
outFieldRow - The returned row coordinate for the specified field.
outFieldColumn - The returned column coordinate for the specified field.
outFieldLength - The length of the specified field.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getFieldCoordinates

public int getFieldCoordinates(int inScreen,
                               java.lang.String inField,
                               MutableInt outFieldRow,
                               MutableInt outFieldColumn,
                               MutableInt outFieldLength)
                        throws java.lang.Exception
Retrieves the coordinates (row, column, and length) of a specified field on the current screen.

Parameters:
inScreen - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inField - The name of the field for which coordinates are desired.
outFieldRow - The returned row coordinate for the specified field.
outFieldColumn - The returned column coordinate for the specified field.
outFieldLength - The length of the specified field.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getFieldCoordinates

public int getFieldCoordinates(java.lang.String inScreen,
                               int inField,
                               MutableInt outFieldRow,
                               MutableInt outFieldColumn,
                               MutableInt outFieldLength)
                        throws java.lang.Exception
Retrieves the coordinates (row, column, and length) of a specified field on the current screen.

Parameters:
inScreen - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inField - The zero-based index of the field for which coordinates are desired.
outFieldRow - The returned row coordinate for the specified field.
outFieldColumn - The returned column coordinate for the specified field.
outFieldLength - The length of the specified field.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getFieldCoordinates

public int getFieldCoordinates(java.lang.String inScreen,
                               java.lang.String inField,
                               MutableInt outFieldRow,
                               MutableInt outFieldColumn,
                               MutableInt outFieldLength)
                        throws java.lang.Exception
Retrieves the coordinates (row, column, and length) of a specified field on the current screen.

Parameters:
inScreen - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inField - The name of the field for which coordinates are desired.
outFieldRow - The returned row coordinate for the specified field.
outFieldColumn - The returned column coordinate for the specified field.
outFieldLength - The length of the specified field.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getFieldCount

public int getFieldCount(int inScreen,
                         MutableInt outFieldCount)
                  throws java.lang.Exception
Retrieves the coordinates (row, column, and length) of a specified field on the current screen.

Parameters:
inScreen - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
outFieldCount - The number of fields for the given screen.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getFieldCount

public int getFieldCount(java.lang.String inScreen,
                         MutableInt outFieldCount)
                  throws java.lang.Exception
Retrieves the coordinates (row, column, and length) of a specified field on the current screen.

Parameters:
inScreen - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
outFieldCount - The number of fields for the given screen.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getFieldNameFromIndex

public int getFieldNameFromIndex(int inScreen,
                                 int inFieldIndex,
                                 MutableObject outFieldName)
                          throws java.lang.Exception
Retrieves the field name based on its index on the current screen. The index numbers start at zero and end at 1 less than the field count.

Parameters:
inScreen - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inFieldIndex - The index number of the field on the screen. The index is zero-based. This number must be less than the number of fields returned in getFieldCount().
outFieldName - The returned field name.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getFieldNameFromIndex

public int getFieldNameFromIndex(java.lang.String inScreen,
                                 int inFieldIndex,
                                 MutableObject outFieldName)
                          throws java.lang.Exception
Retrieves the field name based on its index on the current screen. The index numbers start at zero and end at 1 less than the field count.

Parameters:
inScreen - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inFieldIndex - The index number of the field on the screen. The index is zero-based. This number must be less than the number of fields returned in getFieldCount().
outFieldName - The returned field name.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getFieldValue

public int getFieldValue(int inScreen,
                         int inField,
                         MutableObject outValue)
                  throws java.lang.Exception
Retrieves the value of the specified field on the current screen.

Parameters:
inScreen - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inField - The zero-based index of the field on the current screen.
outValue - The returned value of the specified field.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getFieldValue

public int getFieldValue(int inScreen,
                         java.lang.String inField,
                         MutableObject outValue)
                  throws java.lang.Exception
Retrieves the value of the specified field on the current screen.

Parameters:
inScreen - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inField - The name of the field for which you are requesting a value.
outValue - The returned value of the specified field.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getFieldValue

public int getFieldValue(java.lang.String inScreen,
                         int inField,
                         MutableObject outValue)
                  throws java.lang.Exception
Retrieves the value of the specified field on the current screen.

Parameters:
inScreen - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inField - The zero-based index of the field on the current screen.
outValue - The returned value of the specified field.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getFieldValue

public int getFieldValue(java.lang.String inScreen,
                         java.lang.String inField,
                         MutableObject outValue)
                  throws java.lang.Exception
Retrieves the value of the specified field on the current screen.

Parameters:
inScreen - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inField - The zero-based index of the field on the current screen.
outValue - The returned value of the specified field.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getScreenInformation

public int getScreenInformation(MutableInt outCursorPosition,
                                MutableObject outAidKey,
                                MutableInt outFieldCount,
                                MutableObject outScreenName,
                                MutableObject outFieldNames,
                                MutableObject outFieldValues,
                                MutableObject out3270FieldAttributes,
                                MutableObject outFieldRows,
                                MutableObject outFieldCols,
                                MutableObject outFieldLengths,
                                MutableObject outFieldColors,
                                MutableObject outFieldHighlights)
                         throws java.lang.Exception
Gets all relevant information for a given session.

Parameters:
outCursorPosition - An integer of relative cursor position from start of buffer
outAidKey - A String containing a HLLAPI-style representation of the last AID key sent
outFieldCount - An integer of number of 3270 fields on the screen
outScreenName - A String representing the BMS mapset.mapname currently displayed
outFieldNames - The field names of all the fields on the current screen. Returns an array of type String, each holds a String representing the field name.
outFieldValues - The field values of all the fields on the current screen. Returns an array of type String, each occurrence of which holds a String representing the field name.
out3270FieldAttributes - Real 3270 FA for all the fields on the current screen. Returns an array of type byte, each occurrence of which holds a value for the FA.
  bit
  0,1  :  xx   Value is determined by bits 2  7
  2    :  0 =  Unprotected  1 = Protected
  3    :  0 =  Alphanum 1 = Numeric  If bits 2 and 3 are B'11' = Automatic skip of field
  4,5  :  00 = Display not selector pen detectabable
       :  01 = Display selector pen detectabable
       :  10 = Intensified display selector pen detectabable
       :  11 = Non-display Non-selector-pen-detectabable Non-printable
  6    :  Reserved  Must be zero
  7    :  Modified Data tag 0 = Field not modified  1 = field Modified
 
outFieldRows - The coordinates of rows of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the row coordinate.
outFieldCols - The coordinates of columns of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the column coordinate.
outFieldLengths - The lengths of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the field length.
outFieldColors - The field colors in use in the fields on the current screen. Returns an array of type int, each occurrence of which holds a value that represents the color:
  0    :  White
  1    :  Blue
  2    :  Red
  3    :  Pink
  4    :  Green
  5    :  Turquoise
  6    :  Yellow
  7    :  White
 
outFieldHighlights - The field highlighting in use in the fields on the current screen. Returns an array of type int, each occurrence of which holds a value that represents the highlighting currently displayed for the respective 3270 field:
  0    :  Normal
  1    :  Blinking
  2    :  Reversed video
  3    :  Underscore
 
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getScreenSize

public int getScreenSize(int inScreen,
                         MutableInt outRow,
                         MutableInt outColumn)
                  throws java.lang.Exception
Retrieves the size of the current screen.

Parameters:
inScreen - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
outRow - The returned number of rows for the current screen.
outColumn - The returned number of columns for the current screen.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getScreenSize

public int getScreenSize(java.lang.String inScreen,
                         MutableInt outRow,
                         MutableInt outColumn)
                  throws java.lang.Exception
Retrieves the size of the current screen.

Parameters:
inScreen - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
outRow - The returned number of rows for the current screen.
outColumn - The returned number of columns for the current screen.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getString

public int getString(int inScreen,
                     int inStartRow,
                     int inStartColumn,
                     int inLength,
                     MutableObject outText)
              throws java.lang.Exception
Retrieves any text on the current screen at the specified row, column, and length. If the length parameter is zero, getString retrieves text from the specified row and column to the end of the screen. The Row and Column parameters must always be greater than or equal to 1. The getString method returns the correct value even though it is contained in non-display fields. Therefore, be sure to check the field attribute prior to displaying text retrieved with this method.

Parameters:
inScreen - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inStartRow - The row position on the host screen at which to begin retrieving text.
inStartColumn - The column position on the host screen at which to begin retrieving text.
inLength - The length of the text string to be retrieved. If this value is zero, the text is retrieved up to the end of the screen.
outText - The text that is retrieved.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getString

public int getString(java.lang.String inScreen,
                     int inStartRow,
                     int inStartColumn,
                     int inLength,
                     MutableObject outText)
              throws java.lang.Exception
Retrieves any text on the current screen at the specified row, column, and length. If the length parameter is zero, getString retrieves text from the specified row and column to the end of the screen. The Row and Column parameters must always be greater than or equal to 1. The getString method returns the correct value even though it is contained in non-display fields. Therefore, be sure to check the field attribute prior to displaying text retrieved with this method.

Parameters:
inScreen - The current live host screen. For this release, the only valid values are -1 for int input or an Empty String or spaces for String input.
inStartRow - The row position on the host screen at which to begin retrieving text.
inStartColumn - The column position on the host screen at which to begin retrieving text.
inLength - The length of the text string to be retrieved. If this value is zero, the text is retrieved up to the end of the screen.
outText - The text that is retrieved.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

putString

public int putString(java.lang.String inText,
                     int inRow,
                     int inColumn,
                     MutableInt outNumChars)
              throws java.lang.Exception
Writes text to the session presentation space beginning at the row and column specified. If a protected field is encountered while writing, characters from the text string are discarded, and writing continues with the next unprotected field.

Parameters:
inText - The text string to write, beginning at the specified position.
inRow - The row position on the host screen at which to begin writing the text string.
inColumn - The column position on the host screen at which to begin writing the text string.
outNumChars - The returned number of characters that were actually written to the screen
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

getTerminalID

public int getTerminalID(MutableObject outTerminalID)
                  throws java.lang.Exception
Retrieves the checked out terminal ID for this session. If no terminal was checked out, retrieves spaces.

Parameters:
outTerminalID - The checked out terminal ID for this session, or spaces.
Returns:
zero for success.
Throws:
java.lang.Exception

getTransactionSystemId

public int getTransactionSystemId(java.lang.String inHostIP,
                                  int inHostPort,
                                  java.lang.String inTransactionId,
                                  MutableObject outSystemId)
                           throws java.lang.Exception
Get a text string containing the name of the CICS System Id (outSystemId) in which a given transaction Id (inTransactionId) executes. Returns outSystemId of all spaces if the transaction Id specified runs locally in the inHostIP inHostPort region.

Parameters:
inHostIP - String with IP address or hostname of target CICS region.
inHostPort - Port corresponding to the target CICS region.
inTransactionId - Text format Transaction Id (1 to 4 characters).
outSystemId - The name of the CICS System Id.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

setTraceActive

public int setTraceActive(java.lang.String inTraceQueueName)
                   throws java.lang.Exception
Start CICS 3270 Bridge Vector trace and optionally pass in a trace Temporary Storage queue name.

Parameters:
inTraceQueueName - Optional Trace Name to use. If no name is given trace is activated using the name specified in previous setTraceActive or setTraceName method.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

setTraceInactive

public int setTraceInactive()
                     throws java.lang.Exception
Stop CICS 3270 Bridge Vector trace.

Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

setTraceName

public int setTraceName(java.lang.String inTraceQueueName)
                 throws java.lang.Exception
Set name of CICS 3270 Bridge Vector trace for this session.

Parameters:
inTraceQueueName - Trace Name to use in subsequent trace operations.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

sendKeys

public int sendKeys(java.lang.String inKeys)
             throws java.lang.Exception
Writes text to the session presentation space beginning at the current cursor position. If a protected field is encountered while writing, characters from the text string are discarded, and writing continues with the next unprotected field. If the HLLAPI representation of an AID keystroke is encountered in the text string, sendKeys initiates transmission to the host of the Aid key followed by any modified fields in the session presentation space. Text and AID keystrokes can be combined multiple times in the input string in this implementation.

Parameters:
inKeys - The keys to send to the host. The HLLAPI representations for special keys that can be used follows:
 AID key : Key Sequence
 "@A@F"  :  Erase Input
 "@B"    :  Backtab 
 "@C"    :  Clear   
 "@E"    :  Enter   
 "@F"    :  Erase EOF
 "@L"    :  Cursor left
 "@N"    :  Newline
 "@T"    :  Tab     
 "@U"    :  Cursor up
 "@V"    :  Cursor down
 "@Z"    :  Cursor right
 "@<"    :  Backspace
 "@0"    :  Home  
 "@1"    :  PF1   
 "@2"    :  PF2   
 "@3"    :  PF3   
 "@4"    :  PF4   
 "@5"    :  PF5   
 "@6"    :  PF6   
 "@7"    :  PF7   
 "@8"    :  PF8   
 "@9"    :  PF9   
 "@a"    :  PF10  
 "@b"    :  PF11  
 "@c"    :  PF12  
 "@d"    :  PF13  
 "@e"    :  PF14  
 "@f"    :  PF15  
 "@g"    :  PF16  
 "@h"    :  PF17  
 "@i"    :  PF18  
 "@j"    :  PF19  
 "@k"    :  PF20  
 "@l"    :  PF21  
 "@m"    :  PF22  
 "@n"    :  PF23    
 "@o"    :  PF24  
 "@x"    :  PA1   
 "@y"    :  PA2   
 "@z"    :  PA3
 
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

sendKeysEx

public int sendKeysEx(java.lang.String inKeys)
               throws java.lang.Exception
This method is included for backward compatibility only. It is implemented as a sendKeys method call.

Parameters:
inKeys - The keys to send to the host. The HLLAPI representations for special keys are documented under 'sendKeys':
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

sendKeysGetString

public int sendKeysGetString(java.lang.String inKeys,
                             int inStartRow,
                             int inStartColumn,
                             int inLength,
                             MutableObject outText)
                      throws java.lang.Exception
Sends a sequence of keystrokes and aid keys to the host and retrieves any text on the current screen at the specified row, column, and length. If the length parameter is zero, getString retrieves text from the specified row and column to the end of the screen. The Row and Column parameters must always be greater than or equal to 1. The sendKeysGetString method returns the correct value even though it is contained in non-display fields. Therefore, be sure to check the field attribute prior to displaying text retrieved with this method.

Parameters:
inKeys - The HLLAPI style string of keys to send before collecting the requested string.
inStartRow - The row position on the host screen at which to begin retrieving text.
inStartColumn - The column position on the host screen at which to begin retrieving text.
inLength - The length of the text string to be retrieved. If this value is zero, the text is retrieved up to the end of the screen.
outText - The text that is retrieved.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

sendKeysGetAllFieldInformation

public int sendKeysGetAllFieldInformation(java.lang.String inKeys,
                                          MutableInt outFieldCount,
                                          MutableObject outFieldNames,
                                          MutableObject outFieldValues,
                                          MutableObject outFieldAttributes,
                                          MutableObject outFieldRows,
                                          MutableObject outFieldCols,
                                          MutableObject outFieldLengths,
                                          MutableObject outFieldColors,
                                          MutableObject outFieldHighlights)
                                   throws java.lang.Exception
Retrieves the information of all fields on the current screen.

Parameters:
inKeys - The HLLAPI style string of keys to send before collecting the requested string.
outFieldCount - The total number of fields on the current screen.
outFieldNames - The field names of all the fields on the current screen. Returns an array of type String, each holds a String representing the field name.
outFieldValues - The field values of all the fields on the current screen. Returns an array of type String, each occurrence of which holds a String representing the field name.
outFieldAttributes - The field attributes of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the field attribute.
outFieldRows - The coordinates of rows of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the row coordinate.
outFieldCols - The coordinates of columns of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the column coordinate.
outFieldLengths - The lengths of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the field length.
outFieldColors - The field colors in use in the fields on the current screen. Returns an array of type int, each occurrence of which holds a value that represents the color:
  0    :  White
  1    :  Blue
  2    :  Red
  3    :  Pink
  4    :  Green
  5    :  Turquoise
  6    :  Yellow
  7    :  White
 
outFieldHighlights - The field highlighting in use in the fields on the current screen. Returns an array of type int, each occurrence of which holds a value that represents the highlighting currently displayed for the respective 3270 field:
  0    :  Normal
  1    :  Blinking
  2    :  Reversed video
  3    :  Underscore
 
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

setCursorPosition

public int setCursorPosition(int inRow,
                             int inColumn)
                      throws java.lang.Exception
Sets the cursor position on the current host screen.

Parameters:
inRow - The cursor row position. The first row is row 1.
inColumn - The cursor column position. The first column is column 1.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

setFieldValue

public int setFieldValue(int inField,
                         java.lang.String inValue)
                  throws java.lang.Exception
Sets the value of the specified unprotected field on the current screen.

Parameters:
inField - The field for which a value is to be set. This only valid value for this release is -1.
inValue - The value to set for the specified field.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

setFieldValue

public int setFieldValue(java.lang.String inField,
                         java.lang.String inValue)
                  throws java.lang.Exception
Sets the value of the specified unprotected field on the current screen.

Parameters:
inField - The field for which a value is to be set. This only valid value for this release is a null String, or spaces.
inValue - The value to set for the specified field.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

setFieldValue

public int setFieldValue(MutableObject inFields,
                         MutableObject inValues)
                  throws java.lang.Exception
Sets the value of an array of specified unprotected fields on the current screen with a single call. Use of this function will increase performance of applications when updating multiple fields.

Parameters:
inFields - An array of type String, each occurrence of which describes the name of the field to have its value replaced.
inValues - An array of type String, each occurrence of which specifies the new value to be placed into the above named field.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

queryLoadModuleInformation

public int queryLoadModuleInformation(java.lang.String hostIP,
                                      int hostPort,
                                      java.lang.String userId,
                                      java.lang.String password,
                                      java.lang.String inLoadModuleName,
                                      MutableObject outLoadLibraryName,
                                      MutableInt outLoadModuleSize)
                               throws java.lang.Exception
Returns the module size and the name of the Load Library that a given application program or BMS map resides in via the Verastream Bridge Integrator. The userId, encrypted password, and load module name are sent to the host. If the password is correct for the userId and the program is found then the 44 character DSN name in which the load module resides is returned.

Parameters:
hostIP - String with IP address or hostname of target CICS region.
hostPort - integer TCP port address of target CICS region.
userId - String containing user identification one to eight bytes in length.
password - String existing password one to eight bytes in length for the given userId.
inLoadModuleName - String containing the program or BMS map name to locate.
outLoadLibraryName - DSN in which the loadmodule resides on the host.
outLoadModuleSize - length in bytes of the load module.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

x3270Screen

public int x3270Screen(java.lang.String inKeys,
                       int inFieldIndex,
                       java.lang.String inFieldValue,
                       MutableInt outCursorPosition,
                       MutableObject outAidKey,
                       MutableInt outFieldCount,
                       MutableObject outScreenName,
                       MutableObject outFieldNames,
                       MutableObject outFieldValues,
                       MutableObject out3270FieldAttributes,
                       MutableObject outFieldRows,
                       MutableObject outFieldCols,
                       MutableObject outFieldLengths,
                       MutableObject outFieldColors,
                       MutableObject outFieldHighlights)
                throws java.lang.Exception
Place String value into the specified 3270 field of the current screen buffer, execute an AID key sequence, and get all relevant 3270 information from the reqested screen in a given session.

Parameters:
inKeys - A string to be typed into the 3270 session including Verastream® Bridge Integrator mnemonics:
  @B      :  BACKTAB
  @C      :  CLEAR
  @E      :  ENTER
  @F      :  ERASE EOF
  @T      :  TAB
  @1      :  PF01
  @2      :  PF02
  @3      :  PF03
  @4      :  PF04
  @5      :  PF05
  @6      :  PF06
  @7      :  PF07
  @8      :  PF08
  @9      :  PF09
  @a      :  PF10
  @b      :  PF11
  @c      :  PF12
  @d      :  PF13
  @e      :  PF14
  @f      :  PF15
  @g      :  PF16
  @h      :  PF17
  @i      :  PF18
  @j      :  PF19
  @k      :  PF20
  @l      :  PF21
  @m      :  PF22
  @n      :  PF23
  @o      :  PF24
  @x      :  PA01
  @y      :  PA02
  @z      :  PA03
  @A@F    :  ERASE INP
  @A@P    :  Put information (setFieldValue) on screen at this place in the key sequence
  @A@G    :  Get information (getScreenInformation) from screen at this place in the key sequence
  @A@X    :  After control is returned to the caller, Disconnect this session
 
inFieldIndex - int containing the index number of the 3270 field
inFieldValue - String containing the value to place into the field identified by inFieldIndex
outCursorPosition - int of relative cursor position from start of buffer
outAidKey - String containing a HLLAPI-style representation of the last AID key sent
outFieldCount - int of number of 3270 fields on the screen
outScreenName - String representing the BMS mapset.mapname currently displayed
outFieldNames - Array of field names of all the fields on the current screen. Returns an array of type String, each holds a String representing the field name.
outFieldValues - Array of field values of all the fields on the current screen. Returns an array of type String, each occurrence of which holds a String representing the field name.
out3270FieldAttributes - byte array of real 3270 FA for all the fields on the current screen. Returns an array of type byte, each occurrence of which holds a value for the FA.
  bit
  0,1  :  xx   Value is determined by bits 2  7
  2    :  0 =  Unprotected  1 = Protected
  3    :  0 =  Alphanum 1 = Numeric  If bits 2 and 3 are B'11' = Automatic skip of field
  4,5  :  00 = Display not selector pen detectabable
       :  01 = Display selector pen detectabable
       :  10 = Intensified display selector pen detectabable
       :  11 = Non-display Non-selector-pen-detectabable Non-printable
  6    :  Reserved  Must be zero
  7    :  Modified Data tag 0 = Field not modified  1 = field Modified
 
outFieldRows - The coordinates of rows of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the row coordinate.
outFieldCols - The coordinates of columns of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the column coordinate.
outFieldLengths - The lengths of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the field length.
outFieldColors - The field colors in use in the fields on the current screen. Returns an array of type int, each occurrence of which holds a value that represents the color:
  0    :  White
  1    :  Blue
  2    :  Red
  3    :  Pink
  4    :  Green
  5    :  Turquoise
  6    :  Yellow
  7    :  White
 
outFieldHighlights - The field highlighting in use in the fields on the current screen. Returns an array of type int, each occurrence of which holds a value that represents the highlighting currently displayed for the respective 3270 field:
  0    :  Normal
  1    :  Blinking
  2    :  Reversed video
  3    :  Underscore
 
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

x3270Screen

public int x3270Screen(java.lang.String inKeys,
                       java.lang.String inFieldName,
                       java.lang.String inFieldValue,
                       MutableInt outCursorPosition,
                       MutableObject outAidKey,
                       MutableInt outFieldCount,
                       MutableObject outScreenName,
                       MutableObject outFieldNames,
                       MutableObject outFieldValues,
                       MutableObject out3270FieldAttributes,
                       MutableObject outFieldRows,
                       MutableObject outFieldCols,
                       MutableObject outFieldLengths,
                       MutableObject outFieldColors,
                       MutableObject outFieldHighlights)
                throws java.lang.Exception
Place String value into the specified 3270 field of the current screen buffer, execute an AID key sequence, and get all relevant 3270 information from the reqested screen in a given session.

Parameters:
inKeys - A string to be typed into the 3270 session including Verastream® Bridge Integrator mnemonics:
  @B      :  BACKTAB
  @C      :  CLEAR
  @E      :  ENTER
  @F      :  ERASE EOF
  @T      :  TAB
  @1      :  PF01
  @2      :  PF02
  @3      :  PF03
  @4      :  PF04
  @5      :  PF05
  @6      :  PF06
  @7      :  PF07
  @8      :  PF08
  @9      :  PF09
  @a      :  PF10
  @b      :  PF11
  @c      :  PF12
  @d      :  PF13
  @e      :  PF14
  @f      :  PF15
  @g      :  PF16
  @h      :  PF17
  @i      :  PF18
  @j      :  PF19
  @k      :  PF20
  @l      :  PF21
  @m      :  PF22
  @n      :  PF23
  @o      :  PF24
  @x      :  PA01
  @y      :  PA02
  @z      :  PA03
  @A@F    :  ERASE INP
  @A@P    :  Put information (setFieldValue) on screen at this place in the key sequence
  @A@G    :  Get information (getScreenInformation) from screen at this place in the key sequence
  @A@X    :  After control is returned to the caller, Disconnect this session
 
inFieldName - String containing the name of the 3270 field into which the value should be placed
inFieldValue - String containing the value to place into the field identified by inFieldIndex
outCursorPosition - int of relative cursor position from start of buffer
outAidKey - String containing a HLLAPI-style representation of the last AID key sent
outFieldCount - int of number of 3270 fields on the screen
outScreenName - String representing the BMS mapset.mapname currently displayed
outFieldNames - Array of field names of all the fields on the current screen. Returns an array of type String, each holds a String representing the field name.
outFieldValues - Array of field values of all the fields on the current screen. Returns an array of type String, each occurrence of which holds a String representing the field name.
out3270FieldAttributes - byte array of real 3270 FA for all the fields on the current screen. Returns an array of type byte, each occurrence of which holds a value for the FA.
  bit
  0,1  :  xx   Value is determined by bits 2  7
  2    :  0 =  Unprotected  1 = Protected
  3    :  0 =  Alphanum 1 = Numeric  If bits 2 and 3 are B'11' = Automatic skip of field
  4,5  :  00 = Display not selector pen detectabable
       :  01 = Display selector pen detectabable
       :  10 = Intensified display selector pen detectabable
       :  11 = Non-display Non-selector-pen-detectabable Non-printable
  6    :  Reserved  Must be zero
  7    :  Modified Data tag 0 = Field not modified  1 = field Modified
 
outFieldRows - The coordinates of rows of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the row coordinate.
outFieldCols - The coordinates of columns of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the column coordinate.
outFieldLengths - The lengths of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the field length.
outFieldColors - The field colors in use in the fields on the current screen. Returns an array of type int, each occurrence of which holds a value that represents the color:
  0    :  White
  1    :  Blue
  2    :  Red
  3    :  Pink
  4    :  Green
  5    :  Turquoise
  6    :  Yellow
  7    :  White
 
outFieldHighlights - The field highlighting in use in the fields on the current screen. Returns an array of type int, each occurrence of which holds a value that represents the highlighting currently displayed for the respective 3270 field:
  0    :  Normal
  1    :  Blinking
  2    :  Reversed video
  3    :  Underscore
 
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

x3270Screen

public int x3270Screen(java.lang.String inKeys,
                       java.lang.String[] inFieldNames,
                       java.lang.String[] inFieldValues,
                       MutableInt outCursorPosition,
                       MutableObject outAidKey,
                       MutableInt outFieldCount,
                       MutableObject outScreenName,
                       MutableObject outFieldNames,
                       MutableObject outFieldValues,
                       MutableObject out3270FieldAttributes,
                       MutableObject outFieldRows,
                       MutableObject outFieldCols,
                       MutableObject outFieldLengths,
                       MutableObject outFieldColors,
                       MutableObject outFieldHighlights)
                throws java.lang.Exception
Place String value into the specified 3270 field of the current screen buffer, execute an AID key sequence, and get all relevant 3270 information from the reqested screen in a given session.

Parameters:
inKeys - A string to be typed into the 3270 session including Verastream® Bridge Integrator mnemonics:
  @B      :  BACKTAB
  @C      :  CLEAR
  @E      :  ENTER
  @F      :  ERASE EOF
  @T      :  TAB
  @1      :  PF01
  @2      :  PF02
  @3      :  PF03
  @4      :  PF04
  @5      :  PF05
  @6      :  PF06
  @7      :  PF07
  @8      :  PF08
  @9      :  PF09
  @a      :  PF10
  @b      :  PF11
  @c      :  PF12
  @d      :  PF13
  @e      :  PF14
  @f      :  PF15
  @g      :  PF16
  @h      :  PF17
  @i      :  PF18
  @j      :  PF19
  @k      :  PF20
  @l      :  PF21
  @m      :  PF22
  @n      :  PF23
  @o      :  PF24
  @x      :  PA01
  @y      :  PA02
  @z      :  PA03
  @A@F    :  ERASE INP
  @A@P    :  Put information (setFieldValue) on screen at this place in the key sequence
  @A@G    :  Get information (getScreenInformation) from screen at this place in the key sequence
  @A@X    :  After control is returned to the caller, Disconnect this session
 
inFieldNames - String array with the names of the 3270 fields into which values should be placed
inFieldValues - String array containing the values to place into the fields identified by the correlated inFieldNames array
outCursorPosition - int of relative cursor position from start of buffer
outAidKey - String containing a HLLAPI-style representation of the last AID key sent
outFieldCount - int of number of 3270 fields on the screen
outScreenName - String representing the BMS mapset.mapname currently displayed
outFieldNames - Array of field names of all the fields on the current screen. Returns an array of type String, each holds a String representing the field name.
outFieldValues - Array of field values of all the fields on the current screen. Returns an array of type String, each occurrence of which holds a String representing the field name.
out3270FieldAttributes - byte array of real 3270 FA for all the fields on the current screen. Returns an array of type byte, each occurrence of which holds a value for the FA.
  bit
  0,1  :  xx   Value is determined by bits 2  7
  2    :  0 =  Unprotected  1 = Protected
  3    :  0 =  Alphanum 1 = Numeric  If bits 2 and 3 are B'11' = Automatic skip of field
  4,5  :  00 = Display not selector pen detectabable
       :  01 = Display selector pen detectabable
       :  10 = Intensified display selector pen detectabable
       :  11 = Non-display Non-selector-pen-detectabable Non-printable
  6    :  Reserved  Must be zero
  7    :  Modified Data tag 0 = Field not modified  1 = field Modified
 
outFieldRows - The coordinates of rows of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the row coordinate.
outFieldCols - The coordinates of columns of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the column coordinate.
outFieldLengths - The lengths of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the field length.
outFieldColors - The field colors in use in the fields on the current screen. Returns an array of type int, each occurrence of which holds a value that represents the color:
  0    :  White
  1    :  Blue
  2    :  Red
  3    :  Pink
  4    :  Green
  5    :  Turquoise
  6    :  Yellow
  7    :  White
 
outFieldHighlights - The field highlighting in use in the fields on the current screen. Returns an array of type int, each occurrence of which holds a value that represents the highlighting currently displayed for the respective 3270 field:
  0    :  Normal
  1    :  Blinking
  2    :  Reversed video
  3    :  Underscore
 
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method.
Throws:
java.lang.Exception

interpretFieldAttribute

public int interpretFieldAttribute(byte inFieldAttribute)
Returns an HPS style integer for a given 3270 Field Attribute(FA) byte.

Parameters:
inFieldAttribute - Byte containing a 3270 Field Attribute byte as defined in the 3270 datastream reference.
Returns:
zero for success. For possible failure values, see the getReturnCodeMessage method. Type int the sum of which is determined by adding the following values obtained from the Field Attribute byte:
  1    :  Field is protected
  2    :  Field can contain only numeric values
  4    :  Field is light-pen detectable
  8    :  Field is non-display, non-light-pen detectable
  16   :  Field is high-intensity
 

setSettleTime

public int setSettleTime(int inSettleTime)
This method is included for backward compatibility only. Performs no logic (NOP). There is no settle time requirement with the host data engine.

Parameters:
inSettleTime - The amount of time (in milliseconds) the host waits after XCLOCK resets. The default is 500 milliseconds.
Returns:
zero for Success.

setTimeOut

public int setTimeOut(int inTimeOut)
This method is included for backward compatibility only. Performs no logic (NOP).

Parameters:
inTimeOut - The number of milliseconds the host waits before timing out. The default is 20,000 milliseconds.
Returns:
zero for Success.

terminate

public int terminate()
This method is included for backward compatibility only. Performs no logic (NOP).

Returns:
zero for Success.

Verastream© Bridge Integrator 4.1