public class CicsCpRequest extends GatewayRequest
JavaGateway.flow(GatewayRequest)
method.GatewayRequest
Modifier and Type | Field and Description |
---|---|
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 recognise.
|
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.
|
static int |
OPSYS_ZOS
The Java Virtual Machine on which the CICS Transaction Gateway application is running has an Operating System
(System Property "os.name") of z/OS.
|
astrGateway_Rc, ERROR_BASE, ERROR_CONNECTION_FAILED, ERROR_EXIT_RETRY_INVALID, ERROR_GATEWAY_BACK_LEVEL, ERROR_GATEWAY_CLOSED, ERROR_GATEWAY_EXCEPTION, ERROR_INVALID_REQUEST_TYPE, ERROR_NOT_AUTHORIZED, ERROR_NOT_SUPPORTED, ERROR_REPLY_MISMATCH, ERROR_UNKNOWN_REQUEST_TYPE, ERROR_WORK_WAS_REFUSED, ERROR_XA_SUPPORT_NOT_ENABLED, strINVALID_GATEWAY_RC
Constructor and Description |
---|
CicsCpRequest()
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getClientCp()
Returns the code page of the CICS TG (after the
CicsCpRequest object has been
flow ed to the CICS TG). |
int |
getClientRc()
Gets the CICS TG 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 TG code page request, or "Return Code Out of Range".
|
int |
getRc()
Returns the Gateway return code, set in this object.
|
getGatewayRc, getGatewayRcString
public static final int CODEPAGE_NORMAL
public static final int CODEPAGE_NOT_AVAILABLE
public static final int NLS_NOT_SUPPORTED
public static final int NO_ENCODING_CLASS
public static final int OPSYS_OS390
public static final int OPSYS_NOT_RECOGNISED
public static final int CODEPAGE_ERR
public static final int OPSYS_ZOS
public CicsCpRequest()
This will create an object suitable for querying the code page used used by the CICS TG.
The CICS TG must be set up so that a valid code page is defined.
The CICS TG code page 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 may try to alias the
code page before performing conversions. This should be the case when
using some of the String class constructors such as
String(byte[] bytes, String enc)
where "enc" refers to
the character encoding (the code page).
If the CICS Transaction Gateway application is running on the z/OS
operating system, (the system property value "os.name"
indicates
z/OS), then getClientRcString()
will return
"OPSYS_ZOS"
and getClientCp()
will
return "unknown"
.
If the CICS Transaction Gateway fails to recognise the operating system
that it is running on from the System property value "os.name"
then getClientRcString()
will return
"OPSYS_NOT_RECOGNISED"
.
If you are running the CICS Transaction Gateway application on an Open
Systems machine such AIX or Solaris, then in order for a CicsCpRequest
to be correctly implemented, you should ensure that the locale held in
the LANG
environment variable is correct, since this will be used
by the JVM to determine the code page.
public java.lang.String getClientCp()
flow
ed to the CICS TG).public int getRc()
public int getClientRc()
public java.lang.String getClientRcString()