| Interface | Description |
|---|---|
| AsyncService |
This class provides the Java interfaces to three of the CICS Asynchronous API
commands:
|
| ChildResponse |
This class represents the response of a child task; part of the CICS
Asynchronous API.
|
| CICSTransactionCallable<T> |
This interface allows a user to indicate that the
Callable work should be executed under a CICS transaction
id of choice, rather than the default transaction id.
|
| CICSTransactionRunnable |
This interface allows a user to signify that the
Runnable work should be executed under a CICS transaction
id of choice, rather than the default transaction id.
|
| Constants |
Constants that are common to the JCICS library.
|
| IHolder |
This interface provides methods for interacting with a byte[] held within a Holder
class.
|
| ILongHolder |
This interface provides methods for interacting with a long held within a Holder
class.
|
| IRetrievedDataHolder |
This interface provides methods for interacting with a RetrievedData held within a Holder
class.
|
| OutputRedirectionPlugin |
This interface provides a single method to the CICS Wrapper class
for use when redirecting requests for STDOUT and STDERR.
|
| RegionTraceBits |
This interface provides a set of constants that should be used to construct
a
java.util.BitSet for use with the TRACE-related API. |
| RetrieveBits |
This interface provides a set of constants that should be used to construct
a
java.util.BitSet for use with the Task.retrieve() method. |
| TerminalSendBits |
This interface provides a set of constants that should be used to construct
a
java.util.BitSet for use with the SEND-related API. |
| TerminalSendCommonBits |
This interface provides a set of constants that should be used to construct
a
java.util.BitSet for use with the SEND-related API. |
| TerminalSendControlBits |
This interface provides a set of constants that should be used to construct
a
java.util.BitSet for use with sendControl(). |
| TerminalSendTextBits |
This interface provides a set of constants that should be used to construct
a
java.util.BitSet for use sendText(). |
| Class | Description |
|---|---|
| AddressResource |
This class provides the implementation of synchronization based on the
address of a data area.
|
| AIDValue |
This class provides a set of constants for use with getAIDbyte() method in the
TerminalPrincipalFacility class.
|
| API |
This is the base class for all JCICS classes that interact with CICS.
|
| Application |
The application to be invoked.
|
| ApplicationContext |
The context of an application that is running or is to be run in CICS TS.
|
| AsyncServiceImpl |
This class, implementing
AsyncService, provides the Java interfaces
to three of the CICS Asynchronous API commands: |
| AttachInitiator |
This bean is the main interface to APPC.
|
| AttachInitiatorBeanInfo |
This Class provides the BeanInfo for an AttachInitiator.
|
| CertificateInfo |
This Class provides the Java implementation of CICS API command EXTRACT CERTIFICATE.
|
| Channel |
This is the Java implementation of CICS Channels
|
| ChannelFactory |
This is the Factory for creating CICS Channels.
|
| ChildResponseImpl |
Implementation of ChildResponse.
|
| Chunk |
This class provides a mechanism by which a PIPELINE terminal handler program
can send multiple response chunks of data in response to a remote Web request.
|
| CICSExecutorService |
The CICSExecutorService provides a way to run work on a separate CICS capable thread.
|
| CICSFuture |
This class, part of the CICS Asynchronous API, implements
Future. |
| CicsSecurityManager |
This class provides a security manager for the CICS environment.
|
| CICSWebAppStateHolder |
INTERNAL CICS USE ONLY
|
| CommAreaHolder |
The class that represents a COMMAREA.
|
| Container |
This is the Java implementation of CICS Containers.
|
| ContainerIterator |
This is the ContainerIterator which allows CICS Java programs
to browse all Containers in a Channel.
|
| Conversation |
This class implements the interface that is common to both ends of an APPC conversation.
|
| ConversationPrincipalFacility | |
| ConversationSendOptions |
This class presents a way to specify the following options on the
SEND command:
|
| ConversationState |
This class implements an enumeration representing the different states
in which an APPC conversation can be.
|
| Cursor |
This class provides a set of methods and variables that correspond
to the CURSOR of a CICS terminal.
|
| CWAHolder |
This class holds an array of bytes that is a copy of the contents of the CWA.
|
| DataHolder |
This class holds an array of bytes that is the data read from a TDQ.
|
| Document |
This Class provides the Java implementation of the CICS DOCUMENT API.
|
| DocumentLocation |
This Class provides a wrapper for the AT and TO keywords for CICS DOCUMENT API command
DOCUMENT INSERT.
|
| EnterRequest |
This Bean provides the Java equivalent to the EXEC CICS ENTER command.
|
| ESDS |
This class is the implementation class for the ESDS kind of file.
|
| ESDS_Browse |
This class implements the CICS File Control interface for browsing ESDS
files via RBA.
|
| Event |
This is the Java implementation of the
EXEC CICS SIGNAL EVENT command.
|
| FileBrowse |
This class is the superclass of all of the browse-related implementation
classes.
|
| FileBrowse.LocalVars |
Inner class to hold ThreadLocal variables
|
| FormField |
This Class extends the NameValueData class and the class returned from
HttpRequest methods:
getFormField()
getNextFormField()
|
| FutureWrapper<V> |
Internal CICS use-only.
|
| HttpClientRequest |
This class provides the Java implementation of HTTP client requests related to the following
CICS API commands:
WEB SEND SESSTOKEN
WEB WRITE SESSTOKEN.
|
| HttpClientResponse |
This class provides the Java implementation of HTTP client response related to the following
CICS API commands:
WEB RECEIVE SESSTOKEN
WEB READ SESSTOKEN
WEB STARTBROWSE SESSTOKEN
WEB READNEXT SESSTOKEN
WEB ENDBROWSE SESSTOKEN.
|
| HttpHeader |
This Class extends the NameValueData class and the class returned from
HttpRequest methods:
getHeader()
getNextHeader()
|
| HttpRequest |
This class provides the Java implementation of HTTP requests related to the following
CICS API WEB server commands:
WEB EXTRACT
WEB READ HTTPHEADER
WEB READ FORMFIELD
WEB READ QUERYPARM
WEB STARTBROWSE HTTPHEADER
WEB READNEXT HTTPHEADER
WEB ENDBROWSE HTTPHEADER
WEB STARTBROWSE FORMFIELD
WEB READNEXT FORMFIELD
WEB ENDBROWSE FORMFIELD
WEB STARTBROWSE QUERYPARM
WEB READNEXT QUERYPARM
WEB ENDBROWSE QUERYPARM
WEB RECEIVE.
|
| HttpResponse |
This class provides the Java implementation of HTTP responses related to the following
CICS API WEB server commands:
WEB WRITE
WEB SEND.
|
| HttpSession |
This class provides the Java implementation of HTTP client requests related to the following
CICS API commands:
WEB OPEN
WEB CLOSE
WEB EXTRACT SESSTOKEN.
|
| IsCICS |
Class to call the JNI function xxx_DTCisCICS () to
obtain whether we're currently in CICS and/or we can use
the CICS API.
|
| ItemHolder |
This class holds an array of bytes that is the data read from a TSQ.
|
| JVMServerValue |
This class provides a set of constants for use with
application programs using the JVM Server Linkable API.
|
| KeyedFile |
This is the implementation class for the KeyedFile interface.
|
| KeyedFileBrowse |
This class implements browsing a keyed file.
|
| KeyHolder |
This class holds an array of bytes that is the key of a file.
|
| KSDS |
This class is the implementation class for the KSDS kind of file.
|
| Message |
Utility class for issuing CICS messages
|
| NameResource |
This class provides the implementation for named synchronized resources.
|
| NameValueData |
This abstract class is used to store name value pairs.
|
| Program |
This Class provides the Java interface to CICS Program Control equivalent
to the LINK command.
|
| QueryParm |
This Class extends the NameValueData class and the class returned from
HttpRequest method:
getNextQueryParm()
|
| RecordHolder |
This class holds an array of bytes that is the data read from a file.
|
| Region |
This class provides a set of methods and variables that correspond
to a CICS region.
|
| RemotableResource |
This abstract class provides the common implementation for resources that
can be accessed on other systems.
|
| Resource |
This abstract class provides the common implementation for named resources.
|
| RetrievedData |
This class holds the data retrieved for a task that has been STARTed.
|
| RetrievedDataHolder |
This class holds the values that can be retrieved for a (started) task.
|
| RRDS |
This class is the implementation class for the RRDS kind of file.
|
| RRDS_Browse |
This class implements the CICS File Control interface for browsing RRDS
files via RRN.
|
| SearchType |
This class implements an enumeration of the different search types that
can be used with generic keys.
|
| Service |
This class provides the Java interface to CICS Service API.
|
| SoapFault |
This class provides the Java interface to CICS SOAPFAULT API.
|
| StartRequest |
This Bean provides the Java equivalent to the EXEC CICS START command.
|
| StartRequestBeanInfo |
This Class provides the BeanInfo for a StartRequest.
|
| SymbolList |
This Class provides a wrapper for the symbol list keywords SYMBOLLIST, DELIMITER and
UNESCAPED of the CICS DOCUMENT API.
|
| SynchronizationResource |
This abstract class provides the common implementation for synchronized
resources.
|
| SyncLevel |
This class implements an enumeration of the different synchronization
levels that can be specified for an APPC conversation.
|
| SyncLevelEditor |
This Class provides a property editor for the syncLevel property of an
AttachInitiator.
|
| Task |
This class provides a set of methods and variables that correspond
to a CICS task.
|
| TcpipRequest |
This class provides the Java implementation of TCPIP requests related to the following
CICS API commands:
EXTRACT CERTIFICATE
EXTRACT TCPIP
WEB RECEIVE.
|
| TCTUAHolder |
This class holds an array of bytes that is a copy of the contents of the
TCTUA.
|
| TDQ |
This Class provides the Java implementation of CICS Transient Data Queues
(TDQs).
|
| Terminal |
This Class provides the Java interface to a CICS Terminal.
|
| TerminalPrincipalFacility |
This Class provides the Java interface to a CICS Terminal.
|
| TerminalPrincipalFacilityExtended | Deprecated
This class was provided in CICS TS 1.3 to support additional functionality for the
TerminalPrincipalFacility class, when using the Enterprise Toolkit for OS/390 (Java program objects).
|
| Transform |
This class provides the Java interface to the CICS TRANSFORM command.
|
| TransformInput |
This class represents the input parameters for the TRANSFORM command.
|
| TransformOutput |
This class represents the output parameters for the TRANSFORM command.
|
| TSQ |
This Class provides the Java interface to CICS Temporary Storage Queues
(TSQs).
|
| TSQBeanInfo |
This Class provides the BeanInfo for a TSQ.
|
| TSQNameEditor |
This Class provides a property editor for the name property of a TSQ.
|
| TSQType |
This class implements an enumeration of the different types of TSQ.
|
| TSQTypeEditor |
This Class provides a property editor for the type property of a TSQ.
|
| TWAHolder |
This class holds an array of bytes that is a copy of the contents of the
TWA.
|
| URIMap |
This class represents a URIMAP resource.
|
| Version |
The Version of an object in the form majorVersion.minorVersion.microVersion
|
| WebService |
This class provides the Java interface to CICS WebService resources.
|
| WSAContext |
WS-Addressing context inteface.
|
| WSAEpr |
WS-Addressing Endpoint Reference helper class.
|
| XmlTransform |
This class represents an XMLTRANSFORM resource.
|
| Enum | Description |
|---|---|
| Application.MatchStyle |
The style of matching that will be used when invoking an application.
|
| AsyncService.BlockingAction |
Enumeration of possible blocking actions for
AsyncService.getAny(BlockingAction). |
| ChildResponse.CompletionStatus |
Enumeration of possible return states of a child task, returned by
|
| CICSExecutorService.RejectedWorkPolicy |
Enum of ways to Handle rejected workload
|
| Exception | Description |
|---|---|
| AbendCancelException |
Provides a Java exception that corresponds to a CICS ABEND CANCEL.
|
| AbendException |
Class that provides a Java exception that corresponds to a CICS ABEND.
|
| AllocationErrorException |
Class that represents the CICS ALLOCERR condition.
|
| ApplicationNotFoundException |
Class that represents the CICS APPNOTFOUND condition.
|
| CCErrorException |
Class that represents the CICS CCERROR condition.
|
| CCSIDErrorException |
Class that represents the CICS CCSIDERR condition
|
| ChangedException |
Class that represents the CICS CHANGED condition.
|
| ChannelErrorException |
Class that represents the CICS CHANNELERR condition
|
| CicsConditionException |
Class that provides a Java class which is used as an exception
corresponding to a CICS condition.
|
| CicsException |
Class that provides the superclass for all CICS exception classes.
|
| CicsResponseConditionException |
This class provides the base for those exceptions that correspond to
CICS conditions for which a response code (in the EIBRCODE field of the EIB)
is defined.
|
| CicsRuntimeException |
Class that provides the superclass for all CICS RuntimeExceptions.
|
| CicsThreadingRuntimeException |
A CICSRuntimeException containing further information
on why CICS Thread creation failed.
|
| CodePageErrorException |
Class that represents the CICS CODEPAGEERR condition
|
| ContainerErrorException |
Class that represents the CICS CONTAINERERR condition
|
| DestinationSelectionErrorException |
Class that represents the CICS SELNERR condition.
|
| DestinationStatusChangeException |
Class that represents the CICS DSSTAT condition.
|
| DumpOpenErrorException |
Class that represents the CICS OPENERR condition.
|
| DuplicateKeyException |
Class that represents the CICS DUPKEY condition.
|
| DuplicateRecordException |
Class that represents the CICS DUPREC condition.
|
| EndException |
Class that represents the CICS END condition.
|
| EndOfChainIndicatorException |
Class that represents the CICS EOC condition.
|
| EndOfDataException |
Class that represents the CICS ENDDATA condition.
|
| EndOfDataSetIndicatorException |
Class that represents the CICS EODS condition.
|
| EndOfFileException |
Class that represents the CICS ENDFILE condition.
|
| EndOfFileIndicatorException |
Class that represents the CICS EOF condition.
|
| EndOfInputIndicatorException |
Class that represents the CICS ENDINPT condition.
|
| EndOfProgramException | Deprecated
Removed as no longer a sensible way to return from a Java Program.
|
| ErrorException |
Class that represents the CICS ERROR condition.
|
| EventErrorException |
Class that represents the CICS EVENTERR condition
|
| FileDisabledException |
Class that represents the CICS DISABLED condition.
|
| FileNotFoundException |
Class that represents the CICS FILENOTFOUND condition.
|
| FunctionErrorException |
Class that represents the CICS FUNCERR condition.
|
| InboundFMHException |
Class that represents the CICS INBFMH condition.
|
| InboundSignalException |
Class that represents the CICS SIGNAL condition.
|
| IncompatiblePipelineException |
An incompatible handler is configured in the pipeline.
|
| InvalidControlBlockIdException |
Class that represents the CICS CBIDERR condition.
|
| InvalidDirectionException |
Class that represents the CICS IGREQCD condition.
|
| InvalidErrorTerminalException |
Class that represents the CICS INVERRTERM condition.
|
| InvalidExitRequestException |
Class that represents the CICS INVEXITREQ condition.
|
| InvalidHandlerException |
An incorrect type of handler has been used.
|
| InvalidJournalIdException |
Class that represents the CICS JIDERR condition.
|
| InvalidLDCException |
Class that represents the CICS INVLDC condition.
|
| InvalidMapSizeException |
Class that represents the CICS INVMPSZ condition.
|
| InvalidNodeIdException |
Class that represents the CICS NODEIDERR condition.
|
| InvalidPartitionException |
Class that represents the CICS INVPARTN condition.
|
| InvalidPartitionSetException |
Class that represents the CICS INVPARTNSET condition.
|
| InvalidProgramIdException |
Class that represents the CICS PGMIDERR condition.
|
| InvalidQueueIdException |
Class that represents the CICS QIDERR condition.
|
| InvalidREQIDPrefixException |
Class that represents the CICS IGREQID condition.
|
| InvalidRequestException |
Class that represents the CICS INVREQ condition.
|
| InvalidRetrieveOptionException |
Class that represents the CICS ENVDEFERR condition.
|
| InvalidSystemIdException |
Class that represents the CICS SYSIDERR condition.
|
| InvalidTaskIdException |
Class that represents the CICS TASKIDERR condition.
|
| InvalidTerminalIdException |
Class that represents the CICS TERMIDERR condition.
|
| InvalidTransactionIdException |
Class that represents the CICS TRANSIDERR condition.
|
| InvalidTSRequestException |
Class that represents the CICS INVTSREQ condition.
|
| InvalidUserIdException |
Class that represents the CICS USERIDERR condition.
|
| IOErrorException |
Class that represents the CICS IOERR condition.
|
| ISCInvalidRequestException |
Class that represents the CICS ISCINVREQ condition.
|
| ItemErrorException |
Class that represents the CICS ITEMERR condition.
|
| LengthErrorException |
Class that represents the CICS LENGERR condition.
|
| LoadingException |
Class that represents the CICS LOADING condition.
|
| LockedException |
Class that represents the CICS LOCKED condition.
|
| LogicException |
Class that represents the CICS ILLOGIC condition.
|
| MapErrorException |
Class that represents the CICS MAPERROR condition.
|
| MapFailureException |
Class that represents the CICS MAPFAIL condition.
|
| MapPageOverflowException |
Class that represents the CICS OVERFLOW condition.
|
| NameErrorException |
Class that represents the CICS NAMEERROR condition.
|
| NoJournalBufferSpaceException |
Class that represents the CICS NOJBUFSP condition.
|
| NonHttpDataException |
This exception is produced when the java program has called HttpRequest method
getContent() which invokes CICS API command WEB RECEIVE and the data returned from
the command is of type NONHTTP.
|
| NoPassbookReadException |
Class that represents the CICS NOPASSBKRD condition.
|
| NoPassbookWriteException |
Class that represents the CICS NOPASSBKWR condition.
|
| NoSpaceException |
Class that represents the CICS NOSPACE condition.
|
| NoSpoolException |
Class that represents the CICS NOSPOOL condition.
|
| NoStorageException |
Class that represents the CICS NOSTG condition.
|
| NotAllocatedException |
Class that represents the CICS NOTALLOC condition.
|
| NotAuthorisedException |
Class that represents the CICS NOTAUTH condition.
|
| NotFinishedException |
Class that represents the CICS NOTFINISHED condition.
|
| NotFoundException |
Class that represents the CICS NOTFND condition.
|
| NotOpenException |
Class that represents the CICS NOTOPEN condition.
|
| NotSupportedException |
The request is not supported.
|
| NotValidException |
Class that represents the CICS NONVAL condition.
|
| PartitionFailureException |
Class that represents the CICS PARTNFAIL condition.
|
| PipelineMismatchException |
An incorrect pipeline mode has been used.
|
| QueueBusyException |
Class that represents the CICS QBUSY condition.
|
| QueueZeroException |
Class that represents the CICS QZERO condition.
|
| ReadAttentionException |
Class that represents the CICS RDATT condition.
|
| RecordBusyException |
Class that represents the CICS RECORDBUSY condition.
|
| RecordNotFoundException |
Class that represents the CICS NOTFND condition.
|
| ResourceDisabledException |
Class that represents the CICS DISABLED condition for any CICS resource.
|
| ResourceUnavailableException |
Class that represents the CICS ENQBUSY condition.
|
| ReturnedPageException |
Class that represents the CICS RETPAGE condition.
|
| RolledBackException |
Class that represents the CICS ROLLEDBACK condition.
|
| RouteFailedException |
Class that represents the CICS RTEFAIL condition.
|
| RoutePartiallyFailedException |
Class that represents the CICS RTESOME condition.
|
| SessionBusyException |
Class that represents the CICS SESSBUSY condition.
|
| SessionErrorException |
Class that represents the CICS SESSIONERR condition.
|
| SpoolBusyException |
Class that represents the CICS SPOLBUSY condition.
|
| SpoolErrorException |
Class that represents the CICS SPOLERR condition.
|
| StartFailedException |
Class that represents the CICS NOSTART condition.
|
| STRELERRException |
Class that represents the CICS STRELERR condition.
|
| SuppressedException |
Class that represents the CICS SUPPRESSED condition.
|
| SymbolErrorException |
This class represents the CICS SYMBOLERR condition.
|
| SystemBusyException |
Class that represents the CICS SYSBUSY condition.
|
| TaskAlreadyBoundRuntimeException |
An Exception thrown when trying to bind a thread to a CICS Task
|
| TCIDERRException |
Class that represents the CICS TCIDERR condition.
|
| TemplateErrorException |
This exception represents the CICS TEMPLATERR condition
|
| TerminalException |
Class that represents the CICS TERMERR condition.
|
| TimedOutException |
This exception represents the CICS TIMEDOUT condition
|
| TimeExpiredException |
Class that represents the CICS EXPIRED condition.
|
| TokenErrorException |
Class that represents the CICS TOKENERR condition
|
| TransferOfControlException | Deprecated
Program.xctl() was removed in CICS TS v5.3.
|
| TransportException |
A transport problem has occurred.
|
| TSIOErrorException |
Class that represents the CICS TSIOERR condition.
|
| UnexpectedInformationException |
Class that represents the CICS UNEXPIN condition.
|
| WriteBreakException |
Class that represents the CICS WRBRK condition.
|
| WrongStatusException |
Class that represents the CICS WRONGSTAT condition.
|
| Error | Description |
|---|---|
| AbendError | Deprecated
This class will be removed in a future release of CICS (since @5.3 SERVICE-RELEASE)
|
| CicsError |
Class that provides the superclass for all CICS error classes.
|
CICS TS JCICS (version 1.700.0).
This package provides the majority of the JCICS API for creating Java applications within CICS.
Bundles wishing to use this package must list the package in the Import-Package header of the bundle's manifest. For example:
Import-Package: com.ibm.cics.server;version="[1.700.0,2.0.0)"
Version History: CICS TS v3.1 - 1.0.0
: CICS TS v4.2 - 1.300.0
: CICS TS v5.1 - 1.401.0
: CICS TS v5.2 - 1.500.0
: CICS TS v5.3 - 1.600.0
: CICS TS v5.3 - 1.601.0 For APAR PI58639
1.602.0 For APAR PI58375
1.603.0 For APAR Tyche
1.604.0 For APAR Tyche Java TASK purge
: CICS TS v5.4 1.700.0 (Including Async API)