CICS® Transaction Gateway Programming Reference V3.1

com.ibm.ctg.client
Class CicsCpRequest

java.lang.Object
  |
  +--com.ibm.ctg.client.GatewayRequest
        |
        +--com.ibm.ctg.client.CicsCpRequest

public class CicsCpRequest
extends GatewayRequest

This class contains the details of the codepage used by the CICS Client. To execute the request, the CicsCpRequest object should be flowed to the Gateway using the JavaGateway.flow method.

See Also:
GatewayRequest

Field Summary
static int CODEPAGE_ERR
          The CICS Transaction Gateway detected an error
static int CODEPAGE_NORMAL
          The request completed normally
static int CODEPAGE_NOT_AVAILABLE
          A code page cannot be obtained
static int NLS_NOT_SUPPORTED
          The Java Virtual Machine on which the CICS Transaction Gateway application is running is pre v1.1
static int NO_ENCODING_CLASS
          The Java Virtual Machine on which the CICS Transaction Gateway application is running does not have a suitable encoding class.
static int OPSYS_NOT_RECOGNISED
          The machine on which the CICS Transaction Gateway application is running has an Operating System (System Property "os.name") which the CICS Transaction Gateway does not recognize
static int OPSYS_OS390
          The Java Virtual Machine on which the CICS Transaction Gateway application is running has an Operating System (System Property "os.name") of OS/390
protected static com.ibm.ctg.client.ResourceWrapper rbDefault
           
 
Fields inherited from class com.ibm.ctg.client.GatewayRequest
ERROR_CONNECTION_FAILED, ERROR_GATEWAY_CLOSED, ERROR_REPLY_MISMATCH, ERROR_UNKNOWN_REQUEST_TYPE, ERROR_WORK_WAS_REFUSED
 
Constructor Summary
CicsCpRequest()
          Default constructor.
 
Method Summary
(package private) static void ()
          This initializer loads the native library.
 java.lang.String getClientCp()
          Returns the CICS Client's codepage (after the CicsCpRequest object has been flowed to the Gateway.
 int getClientRc()
          Gets the Client Request return code set in this object, if there is one.
 java.lang.String getClientRcString()
          Returns the String representation of the return code relating to a CICS Client codepage request, or "Return Code Out of Range"
 int getRc()
          Returns the Gateway return code, set in this object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CODEPAGE_NORMAL

public static final int CODEPAGE_NORMAL
The request completed normally

CODEPAGE_NOT_AVAILABLE

public static final int CODEPAGE_NOT_AVAILABLE
A code page cannot be obtained

NLS_NOT_SUPPORTED

public static final int NLS_NOT_SUPPORTED
The Java Virtual Machine on which the CICS Transaction Gateway application is running is pre v1.1

NO_ENCODING_CLASS

public static final int NO_ENCODING_CLASS
The Java Virtual Machine on which the CICS Transaction Gateway application is running does not have a suitable encoding class. N.B. Currently, this return code is not used

OPSYS_OS390

public static final int OPSYS_OS390
The Java Virtual Machine on which the CICS Transaction Gateway application is running has an Operating System (System Property "os.name") of OS/390

OPSYS_NOT_RECOGNISED

public static final int OPSYS_NOT_RECOGNISED
The machine on which the CICS Transaction Gateway application is running has an Operating System (System Property "os.name") which the CICS Transaction Gateway does not recognize

CODEPAGE_ERR

public static final int CODEPAGE_ERR
The CICS Transaction Gateway detected an error

rbDefault

protected static com.ibm.ctg.client.ResourceWrapper rbDefault
Constructor Detail

CicsCpRequest

public CicsCpRequest()
Default constructor.

This will create an object suitable for querying the codepage used used by the CICS Client.

The CICS Client must be set up so that a valid codepage is defined. Please refer to platform specific documentation for the CICS Client you are using.

It is sometimes the case that the CICS Client uses a completely different method of determining the codepage than the Java Virtual Machine on which the CICS Transaction Gateway application is running. In this case, the CICS Transaction Gateway will use the same method as the CICS Client, and not the method used by the JVM.

The CICS Client codepage will not necessarily be returned in a Java format, therefore, it is necessary to validate this before using Java classes which require a Java format. Some JDK classes, from JDK 1.1 onwards, may try to alias the codepage before doing conversions. This should be the case when using some of the String class constructors at JDK 1.1 e.g. "String(byte[] bytes, String enc)" - where "enc" refers to the character encoding (i.e. the codepage).

If the CICS Transaction Gateway application is running on the OS/390 operating system, (i.e. System Property value "os.name" indicates OS/390), then getClientRcString() will return "OPSYS_OS390" and getClientCp() will return "unknown".

If the CICS Transaction Gateway fails to recognise the operating system that the CICS * Client is running on, (i.e. System Property value "os.name") then * getClientRcString() will return OPSYS_NOT_RECOGNISED.

NOTE: If you are running the CICS Transaction Gateway application on an Open Systems machine, (e.g. the operating system is AIX or Solaris), then in order for a CicsCpRequest to be correctly implemented, you should ensure that: (a) the Java Virtual Machine on which the CICS Transaction Gateway application is running is at v1.1 or above and (b) the locale held in the environment variable $LANG is correct, since this will be used by the JVM to determine the codepage.

Method Detail

static void ()
This initializer loads the native library.

getClientCp

public java.lang.String getClientCp()
Returns the CICS Client's codepage (after the CicsCpRequest object has been flowed to the Gateway.
Returns:
String CICS Client codepage (or "unknown")

getRc

public int getRc()
Returns the Gateway return code, set in this object. If a Gateway error code is set this is returned.
Returns:
int The Gateway return code

getClientRc

public int getClientRc()
Gets the Client Request return code set in this object, if there is one.
Returns:
int The CICS Client Code Page return code

getClientRcString

public java.lang.String getClientRcString()
Returns the String representation of the return code relating to a CICS Client codepage request, or "Return Code Out of Range"
Returns:
String The CICS Client codepage return code (or "Return Code Out of Range")

© Copyright IBM Corp. 1994, 1999