Sun MTP JCICS API Overview

This document is the specification for the JCICS API that is incorporated in the Sun Mainframe Transaction Processing software product.

See:
          Description

Packages
com.ibm.cics.server  
com.ibm.record  
com.sun.emp.mtp.jcics  

 

This document is the specification for the JCICS API that is incorporated in the Sun Mainframe Transaction Processing software product.

This is a partial implementation. The following table details which methods are actually implemented.

Implementation Summary
Class Method Implemented
     
AddressResource AddressResource() Yes
AddressResource getAddress() Yes
AddressResource setAddress(byte[]) Yes
AddressResource dequeue() No
AddressResource enqueue() No
AddressResource tryEnqueue() No
     
API API() Yes
     
AttachInitiator AttachInitiator() No
AttachInitiator getProcess() No
AttachInitiator getProfile() No
AttachInitiator getQueue() No
AttachInitiator getSyncLevel() No
AttachInitiator getSysid() No
AttachInitiator initiate() No
AttachInitiator initiate(byte[]) No
AttachInitiator setProcess(java.lang.String) No
AttachInitiator setProfile(java.lang.String) No
AttachInitiator setQueue(boolean) No
AttachInitiator setSyncLevel(com.ibm.cics.server.SyncLevel) No
AttachInitiator setSysId(java.lang.String) No
     
CommAreaHolder CommAreaHolder() Yes
CommAreaHolder CommAreaHolder(byte[]) Yes
     
Conversation converse(com.ibm.cics.server.DataHolder) No
Conversation converse(com.ibm.cics.server.DataHolder, int, boolean) No
Conversation flush() No
Conversation free() No
Conversation getConvId() No
Conversation getDataComplete() No
Conversation getErrorCode() No
Conversation getErrorOccurred() No
Conversation getNoData() No
Conversation getSignalReceived() No
Conversation getState() No
Conversation getSyncLevel() No
Conversation issueAbend() No
Conversation issueConfirmation() No
Conversation issueError() No
Conversation issuePrepare() No
Conversation issueSignal() No
Conversation receive(com.ibm.cics.server.DataHolder) No
Conversation receive(com.ibm.cics.server.DataHolder, int, boolean) No
Conversation send(byte[]) No
Conversation send(byte[], com.ibm.cics.server.ConversationSendOptions) No
Conversation send(com.ibm.cics.server.ConversationSendOptions) No
     
ConversationPrincipalFacility getNetName() No
ConversationPrincipalFacility getPipData() No
ConversationPrincipalFacility getPrinSysId() No
ConversationPrincipalFacility getProcess() No
ConversationPrincipalFacility getUserId() No
     
ConversationSendOptions ConversationSendOptions() No
ConversationSendOptions clearAll() No
ConversationSendOptions clearConfirm() No
ConversationSendOptions clearInvite() No
ConversationSendOptions clearLast() No
ConversationSendOptions clearWait() No
ConversationSendOptions getConfirm() No
ConversationSendOptions getInvite() No
ConversationSendOptions getLast() No
ConversationSendOptions getWait() No
ConversationSendOptions setConfirm() No
ConversationSendOptions setInvite() No
ConversationSendOptions setLast() No
ConversationSendOptions setWait() No
     
ConversationState equals(java.lang.Object) Yes
ConversationState toString() Yes
ConversationState lookup(int) Yes
     
Cursor Cursor(int, int) Yes
Cursor Cursor(int, int, int, int) Yes
Cursor increment() Yes
Cursor increment(int) Yes
Cursor incrementRow() Yes
Cursor decrement() Yes
Cursor decrement(int) Yes
Cursor setColumn(int) Yes
Cursor setRow(int) Yes
Cursor toBinary() Yes
     
CWAHolder CWAHolder() Yes
CWAHolder CWAHolder(byte[]) Yes
     
DataHolder DataHolder() Yes
     
EnterRequest EnterRequest() No
EnterRequest enterTrace() No
EnterRequest enterTrace(byte[]) No
EnterRequest getResource() No
EnterRequest getTraceIdentifier() No
EnterRequest isException() No
EnterRequest setException(boolean) No
EnterRequest setResource(java.lang.String) No
EnterRequest setTraceIdentifier(short) No
     
ESDS All Methods No
     
ESDS_Browse All Methods No
     
File All Methods No
     
FileBrowse end() No
FileBrowse getRequestID() No
     
ItemHolder ItemHolder() Yes
     
KeyedFile All Methods No
     
KeyedFileBrowse next(byte[], com.ibm.cics.server.RecordHolder, com.ibm.cics.server.KeyHolder) No
KeyedFileBrowse next(com.ibm.cics.server.RecordHolder, com.ibm.cics.server.KeyHolder) No
KeyedFileBrowse previous(byte[], com.ibm.cics.server.RecordHolder, com.ibm.cics.server.KeyHolder) No
KeyedFileBrowse previous(com.ibm.cics.server.RecordHolder, com.ibm.cics.server.KeyHolder) No
KeyedFileBrowse reset(byte[]) No
KeyedFileBrowse reset(byte[], com.ibm.cics.server.SearchType) No
KeyedFileBrowse reset(byte[], boolean) No
KeyedFileBrowse reset(byte[], boolean, com.ibm.cics.server.SearchType) No
     
KeyHolder KeyHolder() Yes
KeyHolder KeyHolder(byte[]) Yes
     
KSDS All Methods No
     
NameResource NameResource() Yes
NameResource getName() Yes
NameResource setName(java.lang.String) Yes
NameResource dequeue() No
NameResource enqueue() No
NameResource tryEnqueue() No
     
Program Program() Yes
Program getSyncOnReturn() Yes
Program getTransId() Yes
Program link() Yes
Program link(byte[]) Yes
Program link(byte[], int) Yes
Program link(com.ibm.record.IByteBuffer) Yes
Program link(com.ibm.record.IByteBuffer, com.ibm.record.IByteBuffer) Yes
Program setSyncOnReturn(boolean) Yes
Program setTransId(java.lang.String) Yes
Program xctl() No
Program xctl(byte[]) No
     
RecordHolder RecordHolder() Yes
     
Region disableTrace() No
Region disableTrace(java.util.BitSet) No
Region enableTrace() No
Region enableTrace(java.util.BitSet) No
Region getAPPLID() Yes
Region getCWA(com.ibm.cics.server.CWAHolder) Yes
Region getSYSID() Yes
Region setAPPLID(java.lang.String) No
Region setCWA(byte[]) Yes
Region setSYSID(java.lang.String) No
     
RemotableResource RemotableResource() Yes
RemotableResource getSysId() Yes
RemotableResource setSysId(java.lang.String) No
     
Resource Resource() Yes
Resource getDescription() Yes
Resource setDescription(java.lang.String) Yes
Resource getName() Yes
Resource setName(java.lang.String) Yes
     
RetrievedData No Public Methods Y
     
RetrievedDataHolder RetrievedDataHolder() Yes
     
RRDS All Methods No
     
RRDS_Browse All Methods No
     
SearchType equals(java.lang.Object) Yes
     
StartRequest StartRequest() Yes
StartRequest cancel() No
StartRequest getID() Yes
StartRequest getIDAsString() Yes
StartRequest getQueueName() Yes
StartRequest getQueueNameAsString() Yes
StartRequest getRTerminal() No
StartRequest getRTransaction() No
StartRequest getTerminal() No
StartRequest getTime() No
StartRequest isChecked() Yes
StartRequest isProtected() Yes
StartRequest issue() No
StartRequest issue(byte[]) No
StartRequest setID(byte[]) Yes
StartRequest setIDFromString(java.lang.String) No
StartRequest setQueueName(byte[]) No
StartRequest setQueueNameFromString(java.lang.String) No
StartRequest setRTerminal(java.lang.String) No
StartRequest setRTransaction(java.lang.String) No
StartRequest setTerminal(java.lang.String) Yes
StartRequest setTime(java.util.Calendar) No
StartRequest isChecked(boolean) Yes
StartRequest setProtected(boolean) Yes
     
SynchronizationResource SynchronizationResource() Yes
SynchronizationResource getDescription() Yes
SynchronizationResource setDescrption(java.lang.String) Yes
     
SyncLevel equals(java.lang.Object) Yes
SyncLevel toString() Yes
SyncLevel lookup(int) Yes
     
SyncLevelEditor All Methods No
     
Task abend(java.lang.String) Yes
Task commit() Yes
Task disableTaskTrace() No
Task enableTaskTrace() No
Task forceAbend(java.lang.String) No
Task getFCI() Yes
Task getPrincipalFacility() Yes
Task getQNAME() Yes
Task getSTARTCODE() Yes
Task getTask() Yes
Task getTaskNumber() Yes
Task getTransactionName() Yes
Task getTWA(com.ibm.cics.server.TWAHolder) Yes
Task setTWA(byte[]) Yes
Task getUSERID() Yes
Task retrieve(java.util.BitSet, com.ibm.cics.server.RetrievedDataHolder) Yes
Task rollback() Yes
     
TCTUAHolder TCTUAHolder() Yes
TCTUAHolder TCTUAHolder(byte[]) Yes
     
TDQ TDQ() Yes
TDQ delete() Yes
TDQ readData(com.ibm.cics.server.DataHolder) Yes
TDQ readDataConditional(com.ibm.cics.server.DataHolder) Yes
TDQ writeData(byte[]) Yes
     
Terminal Terminal(java.lang.String) Yes
Terminal Terminal(java.lang.String, java.lang.String) Yes
Terminal getName() Yes
Terminal getCursor() No
Terminal getUser() No
     
TerminalPrincipalFacility clear() Yes
TerminalPrincipalFacility erase() Yes
TerminalPrincipalFacility sendControl(com.ibm.cics.server.Cursor) Yes
TerminalPrincipalFacility sendControl(java.util.BitSet) Yes
TerminalPrincipalFacility sendControl(com.ibm.cics.server.Cursor, java.util.BitSet) Yes
TerminalPrincipalFacility send(byte[]) Yes
TerminalPrincipalFacility send(byte[], java.util.BitSet) Yes
TerminalPrincipalFacility sendText(byte[]) Yes
TerminalPrincipalFacility sendText(byte[], com.ibm.cics.server.Cursor) Yes
TerminalPrincipalFacility sendText(byte[], com.ibm.cics.server.Cursor, java.util.BitSet) Yes
TerminalPrincipalFacility sendText(byte[], java.util.BitSet) Yes
TerminalPrincipalFacility converse(com.ibm.cics.server.DataHolder) No
TerminalPrincipalFacility converseASIS(com.ibm.cics.server.DataHolder) No
TerminalPrincipalFacility getTCTUA(com.ibm.cics.server.TCTUAHolder) Yes
TerminalPrincipalFacility getTERMCODE() No
TerminalPrincipalFacility setNextCOMMAREA(byte[]) Yes
TerminalPrincipalFacility setNextTransaction(java.lang.String) Yes
TerminalPrincipalFacility setTCTUA(byte[]) Yes
TerminalPrincipalFacility waitTerminal() No
TerminalPrincipalFacility receive(com.ibm.cics.server.DataHolder) Yes
TerminalPrincipalFacility receiveASIS(com.ibm.cics.server.DataHolder) Yes
TerminalPrincipalFacility receiveBuffer(com.ibm.cics.server.DataHolder) Yes
TerminalPrincipalFacility receiveBufferASIS(com.ibm.cics.server.DataHolder) Yes
     
TSQ TSQ() Yes
TSQ delete() No
TSQ getQueueName() No
TSQ getType() No
TSQ readItem(int, com.ibm.cics.server.ItemHolder) No
TSQ readNextItem(com.ibm.cics.server.ItemHolder) No
TSQ rewriteItem(int, byte[]) No
TSQ rewriteItemConditional(int, byte[]) No
TSQ setName(java.lang.String) Yes
TSQ setQueueName(byte[]) No
TSQ setType(com.ibm.cics.server.TSQType) No
TSQ writeItem(byte[]) No
TSQ writeItemConditional(byte[]) No
     
TSQNameEditor All Methods No
     
TSQType equals(java.lang.Object) Yes
TSQType toString() Yes
     
TSQTypeEditor All Methods No
     
TWAHolder TWAHolder() Yes
TWAHolder TWAHolder(byte[]) Yes
     
ByteAreaElement ByteAreaElement(java.lang.String, java.lang.String, int, java.lang.String, int) Yes
ByteAreaElement printMsg(java.lang.String) Yes
ByteAreaElement toString() Yes
ByteAreaElement toString(byte[]) Yes
ByteAreaElement getLength() Yes
ByteAreaElement setToDefaultValue(byte[]) Yes
ByteAreaElement getValue(byte[]) Yes
ByteAreaElement getIValue(byte[]) Yes
ByteAreaElement getByteValue(byte[]) Yes
ByteAreaElement getDisplacement() Yes
ByteAreaElement getType() Yes
ByteAreaElement setByteValue(byte[], byte[]) Yes
ByteAreaElement setValue(byte[], byte[]) Yes
ByteAreaElement setValue(byte[], int) Yes
ByteAreaElement setValue(byte[], java.lang.String) Yes
     
ByteAreaLayout ByteAreaLayout(java.lang.String[], byte[]) Yes
ByteAreaLayout ByteAreaLayout(java.lang.String[]) Yes
ByteAreaLayout toString() Yes
ByteAreaLayout resetToDefaultValues() Yes
ByteAreaLayout theByteArea() Yes
ByteAreaLayout resetByteAreaValues(byte[]) Yes
ByteAreaLayout getLength() Yes
ByteAreaLayout getLength(java.lang.String) Yes
ByteAreaLayout getIValue(java.lang.String) Yes
ByteAreaLayout getValue(java.lang.String) Yes
ByteAreaLayout getByteValue(java.lang.String) Yes
ByteAreaLayout getDisplacement(java.lang.String) Yes
ByteAreaLayout setValue(java.lang.String, java.lang.String) Yes
ByteAreaLayout setValue(java.lang.String, byte[]) Yes
ByteAreaLayout setValue(java.lang.String, int) Yes
ByteAreaLayout setToDefaultValue(java.lang.String) Yes
     
ExceptionHelper ExceptionHelper(int, byte[], byte[]) Yes
ExceptionHelper ExceptionHelper(int, byte[], byte[], int, int, int, int, int) Yes
ExceptionHelper getEIBFN() Yes
ExceptionHelper getEIBRCODE() Yes
ExceptionHelper getRESP2() Yes
     
ProgramInitiator getInstance() Yes
ProgramInitiator getClass(java.lang.String, java.lang.String) Yes
ProgramInitiator getMainMethod(java.lang.String, java.lang.String) Yes
ProgramInitiator invokeMainMethod(java.lang.reflect.Method, com.ibm.cics.server.CommAreaHolder) Yes
ProgramInitiator dumpException(java.lang.Throwable) Yes
     
RecordLayout RecordLayout() Yes
RecordLayout checkBytes(byte[]) Yes
RecordLayout getBytes() Yes
RecordLayout setBytes(byte[]) Yes
     
SocketMessage SocketMessage() Yes


Copyright (c) 2005 by Sun Microsystems, Inc.