|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.cics.server.API | +--com.ibm.cics.server.Resource | +--com.ibm.cics.server.RemotableResource | +--com.ibm.cics.server.TSQ
This Class provides the Java interface to CICS Temporary Storage Queues (TSQs).
Constructor Summary | |
TSQ()
Construct a TSQ bean. |
Method Summary | |
void |
delete()
Delete a Temporary Storage Queue (TSQ). |
java.lang.String |
getName()
Return the name of the TSQ as a string, using the platform's default character encoding to convert from the internal byte[] format in which the name is stored. |
byte[] |
getQueueName()
Return the queueName of the TSQ. |
TSQType |
getType()
Return the type of the TSQ. |
int |
readItem(int item,
ItemHolder holder)
Read a specified item from a TSQ. |
int |
readNextItem(ItemHolder holder)
Read the next item from a TSQ. |
void |
rewriteItem(int item,
byte[] data)
Rewrite an existing item. |
void |
rewriteItemConditional(int item,
byte[] data)
Rewrite an existing item. |
void |
setName(java.lang.String name)
Sets the name of the TSQ. |
void |
setQueueName(byte[] queueName)
Sets the queueName of the TSQ. |
void |
setType(TSQType type)
Sets the type of the TSQ. |
int |
writeItem(byte[] data)
Simplest version of WRITEQ TS . |
int |
writeItemConditional(byte[] data)
Write an item to a TSQ. |
Methods inherited from class com.ibm.cics.server.RemotableResource |
getSysId, setSysId |
Methods inherited from class com.ibm.cics.server.Resource |
getDescription, setDescription |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public TSQ()
Method Detail |
public void delete() throws InvalidRequestException, IOErrorException, ISCInvalidRequestException, NotAuthorisedException, InvalidQueueIdException, InvalidSystemIdException
InvalidRequestException
- An INVREQ occurred.IOErrorException
- An IOERR occurred.ISCInvalidRequestException
- An ISCINVREQ occurred.NotAuthorisedException
- A NOTAUTH occurred.InvalidQueueIdException
- A QIDERR occurred.InvalidSystemIdException
- A SYSIDERR occurred.public java.lang.String getName()
getName
in class Resource
public byte[] getQueueName()
public TSQType getType()
public int readItem(int item, ItemHolder holder) throws InvalidRequestException, IOErrorException, ISCInvalidRequestException, ItemErrorException, LengthErrorException, NotAuthorisedException, InvalidQueueIdException, InvalidSystemIdException
item
- The number of the item to read.holder
- The holder for the data to be returned.InvalidRequestException
- An INVREQ occurred.IOErrorException
- An IOERR occurred.ISCInvalidRequestException
- An ISCINVREQ occurred.ItemErrorException
- An ITEMERROR occurred.LengthErrorException
- A LENGERR occurred.NotAuthorisedException
- A NOTAUTH occurred.InvalidQueueIdException
- A QIDERR occurred.InvalidSystemIdException
- A SYSIDERR occurred.public int readNextItem(ItemHolder holder) throws InvalidRequestException, IOErrorException, ISCInvalidRequestException, ItemErrorException, LengthErrorException, NotAuthorisedException, InvalidQueueIdException, InvalidSystemIdException
holder
- The holder for the data to be returned.InvalidRequestException
- An INVREQ occurred.IOErrorException
- An IOERR occurred.ISCInvalidRequestException
- An ISCINVREQ occurred.ItemErrorException
- An ITEMERROR occurred.LengthErrorException
- A LENGERR occurred.NotAuthorisedException
- A NOTAUTH occurred.InvalidQueueIdException
- A QIDERR occurred.InvalidSystemIdException
- A SYSIDERR occurred.public void rewriteItem(int item, byte[] data) throws InvalidRequestException, IOErrorException, ISCInvalidRequestException, ItemErrorException, LengthErrorException, NotAuthorisedException, InvalidQueueIdException, InvalidSystemIdException
item
- The number of the item to be rewritten.data
- A Java byte array containing the data to rewrite.InvalidRequestException
- An INVREQ occurred.IOErrorException
- An IOERR occurred.ISCInvalidRequestException
- An ISCINVREQ occurred.ItemErrorException
- An ITEMERROR occurred.LengthErrorException
- A LENGERR occurred.NotAuthorisedException
- A NOTAUTH occurred.InvalidQueueIdException
- A QIDERR occurred.InvalidSystemIdException
- A SYSIDERR occurred.public void rewriteItemConditional(int item, byte[] data) throws InvalidRequestException, IOErrorException, ISCInvalidRequestException, ItemErrorException, LengthErrorException, NoSpaceException, NotAuthorisedException, InvalidQueueIdException, InvalidSystemIdException
item
- The number of the item to be rewritten.data
- A Java byte array containing the data to rewrite.InvalidRequestException
- An INVREQ occurred.IOErrorException
- An IOERR occurred.ISCInvalidRequestException
- An ISCINVREQ occurred.ItemErrorException
- An ITEMERROR occurred.LengthErrorException
- A LENGERR occurred.NoSpaceException
- A NOSPACE occurred.NotAuthorisedException
- A NOTAUTH occurred.InvalidQueueIdException
- A QIDERR occurred.InvalidSystemIdException
- A SYSIDERR occurred.public void setName(java.lang.String name) throws java.lang.NullPointerException
setName
in class Resource
name
- the name of the TSQ as a string.
This string is padded with blanks to the next higher queue name length
boundary and converted to bytes using the platform's default character
encoding.
Overlength queue names will be truncated.
For example:
queueName in AIX will be in MVS will be
"ABC" x'4142432020202020' x'C1C2C34040404040'
"ABCDEFGHI" x'4142434445464748' x'C1C2C3C4C5C6C7C8C940404040404040'java.lang.NullPointerException
- queueName is nullpublic void setQueueName(byte[] queueName) throws java.lang.NullPointerException
queueName
- the queueName of the TSQ.
If the queueName passed in is shorter than the TSQ name length of the
platform, it is padded to the next higher queue name length boundary.
The pad byte contains the hex value of blank in the platform's default
character encoding.
Overlength queueNames will be truncated.
For example:
queueName in AIX will be in MVS will be
x'414243' x'4142432020202020' x'4142434040404040'
x'C1C2C3C4C5C6C7C8C9' x'C1C2C3C4C5C6C7C8' x'C1C2C3C4C5C6C7C8C940404040404040'java.lang.NullPointerException
- queueName is nullpublic void setType(TSQType type)
type
- the type of the TSQ.public int writeItem(byte[] data) throws InvalidRequestException, IOErrorException, ISCInvalidRequestException, ItemErrorException, LengthErrorException, NotAuthorisedException, InvalidSystemIdException
WRITEQ TS
.
If there is insufficient space in the TS dataset, the task will
be suspended.data
- A Java byte array containing the data to be written to the
TSQ.InvalidRequestException
- An INVREQ occurred.IOErrorException
- An IOERR occurred.ISCInvalidRequestException
- An ISCINVREQ occurred.ItemErrorException
- An ITEMERROR occurred.LengthErrorException
- A LENGERR occurred.NotAuthorisedException
- A NOTAUTH occurred.InvalidSystemIdException
- A SYSIDERR occurred.public int writeItemConditional(byte[] data) throws InvalidRequestException, IOErrorException, ISCInvalidRequestException, ItemErrorException, LengthErrorException, NoSpaceException, NotAuthorisedException, InvalidSystemIdException
data
- A Java byte array containing the data to rewrite.InvalidRequestException
- An INVREQ occurred.IOErrorException
- An IOERR occurred.ISCInvalidRequestException
- An ISCINVREQ occurred.ItemErrorException
- An ITEMERROR occurred.LengthErrorException
- A LENGERR occurred.NoSpaceException
- A NOSPACE occurred.NotAuthorisedException
- A NOTAUTH occurred.InvalidSystemIdException
- A SYSIDERR occurred.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |