|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.as400.access.BaseDataQueue | +--com.ibm.as400.access.DataQueue
The DataQueue class represents an AS/400 data queue object.
Constructor Summary | |
DataQueue()
Constructs a DataQueue object. |
|
DataQueue(AS400 system,
java.lang.String path)
Constructs a DataQueue object. |
Method Summary | |
void |
create(DataQueueAttributes attributes)
Creates a data queue on the AS/400. |
void |
create(int maxEntryLength)
Creates a data queue on the AS/400. |
void |
create(int maxEntryLength,
java.lang.String authority,
boolean saveSenderInformation,
boolean FIFO,
boolean forceToAuxiliaryStorage,
java.lang.String description)
Creates a data queue on the AS/400. |
DataQueueEntry |
peek()
Reads an entry from the data queue without removing it from the queue. |
DataQueueEntry |
peek(int wait)
Reads an entry from the data queue without removing it from the queue. |
DataQueueEntry |
read()
Reads an entry from the data queue and removes it from the queue. |
DataQueueEntry |
read(int wait)
Reads an entry from the data queue and removes it from the queue. |
java.lang.String |
toString()
Returns the String representation of this data queue object. |
void |
write(byte[] data)
Writes an entry to the data queue. |
void |
write(java.lang.String data)
Writes a string entry to the data queue. |
Methods inherited from class com.ibm.as400.access.BaseDataQueue |
addDataQueueListener, addObjectListener, addPropertyChangeListener, addVetoableChangeListener, clear, delete, exists, getCcsid, getDescription, getForceToAuxiliaryStorage, getMaxEntryLength, getName, getPath, getSaveSenderInformation, getSystem, isFIFO, refreshAttributes, removeDataQueueListener, removeObjectListener, removePropertyChangeListener, removeVetoableChangeListener, setCcsid, setPath, setSystem |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public DataQueue()
public DataQueue(AS400 system, java.lang.String path)
system
- The AS/400 system on which the data queue exists.path
- The fully qualified integrated file system path name of the data queue. The library and queue name must each be 10 characters or less.Method Detail |
public void create(DataQueueAttributes attributes) throws AS400SecurityException, ErrorCompletingRequestException, java.io.IOException, IllegalObjectTypeException, java.lang.InterruptedException, ObjectAlreadyExistsException, ObjectDoesNotExistException
attributes
- The attributes of the data queue to be created.AS400SecurityException
- If a security or authority error occurs.ConnectionDroppedException
- If the connection is dropped unexpectedly.ErrorCompletingRequestException
- If an error occurs before the request is completed.java.io.IOException
- If an error occurs while communicating with the AS/400.IllegalObjectTypeException
- If the AS/400 object is not the required type.java.lang.InterruptedException
- If this thread is interrupted.ObjectAlreadyExistsException
- If the AS/400 object already exists.ObjectDoesNotExistException
- If the AS/400 object does not exist.ServerStartupException
- If the AS/400 server cannot be started.java.net.UnknownHostException
- If the AS/400 system cannot be located.public void create(int maxEntryLength) throws AS400SecurityException, ErrorCompletingRequestException, java.io.IOException, java.lang.InterruptedException, ObjectAlreadyExistsException, ObjectDoesNotExistException
maxEntryLength
- The maximum number of bytes per data queue entry. Valid values are 1-64512.AS400SecurityException
- If a security or authority error occurs.ConnectionDroppedException
- If the connection is dropped unexpectedly.ErrorCompletingRequestException
- If an error occurs before the request is completed.java.io.IOException
- If an error occurs while communicating with the AS/400.java.lang.InterruptedException
- If this thread is interrupted.ObjectAlreadyExistsException
- If the AS/400 object already exists.ObjectDoesNotExistException
- If the AS/400 object does not exist.ServerStartupException
- If the AS/400 server cannot be started.java.net.UnknownHostException
- If the AS/400 system cannot be located.public void create(int maxEntryLength, java.lang.String authority, boolean saveSenderInformation, boolean FIFO, boolean forceToAuxiliaryStorage, java.lang.String description) throws AS400SecurityException, ErrorCompletingRequestException, java.io.IOException, java.lang.InterruptedException, ObjectAlreadyExistsException, ObjectDoesNotExistException
maxEntryLength
- The maximum number of bytes per data queue entry. Valid values are 1-64512.authority
- The public authority for the data queue. Valid values are *ALL, *CHANGE, *EXCLUDE, *USE, *LIBCRTAUT.saveSenderInformation
- true if entry origin information will be saved; false otherwise.FIFO
- true if queue entries are processed in FIFO order, false if queue entries are processed in LIFO order.forceToAuxiliaryStorage
- true if writes are forced to storage before return; false otherwise.description
- The text description. This string must be 50 characters or less.AS400SecurityException
- If a security or authority error occurs.ConnectionDroppedException
- If the connection is dropped unexpectedly.ErrorCompletingRequestException
- If an error occurs before the request is completed.java.io.IOException
- If an error occurs while communicating with the AS/400.java.lang.InterruptedException
- If this thread is interrupted.ObjectAlreadyExistsException
- If the AS/400 object already exists.ObjectDoesNotExistException
- If the AS/400 object does not exist.ServerStartupException
- If the AS/400 server cannot be started.java.net.UnknownHostException
- If the AS/400 system cannot be located.public DataQueueEntry peek() throws AS400SecurityException, ErrorCompletingRequestException, java.io.IOException, IllegalObjectTypeException, java.lang.InterruptedException, ObjectDoesNotExistException
AS400SecurityException
- If a security or authority error occurs.ConnectionDroppedException
- If the connection is dropped unexpectedly.ErrorCompletingRequestException
- If an error occurs before the request is completed.java.io.IOException
- If an error occurs while communicating with the AS/400.IllegalObjectTypeException
- If the AS/400 object is not the required type.java.lang.InterruptedException
- If this thread is interrupted.ObjectDoesNotExistException
- If the AS/400 object does not exist.public DataQueueEntry peek(int wait) throws AS400SecurityException, ErrorCompletingRequestException, java.io.IOException, IllegalObjectTypeException, java.lang.InterruptedException, ObjectDoesNotExistException
wait
- The number of seconds to wait if the queue contains no entries. Negative one (-1) means to wait until an entry is available.AS400SecurityException
- If a security or authority error occurs.ConnectionDroppedException
- If the connection is dropped unexpectedly.ErrorCompletingRequestException
- If an error occurs before the request is completed.java.io.IOException
- If an error occurs while communicating with the AS/400.IllegalObjectTypeException
- If the AS/400 object is not the required type.java.lang.InterruptedException
- If this thread is interrupted.ObjectDoesNotExistException
- If the AS/400 object does not exist.public DataQueueEntry read() throws AS400SecurityException, ErrorCompletingRequestException, java.io.IOException, IllegalObjectTypeException, java.lang.InterruptedException, ObjectDoesNotExistException
AS400SecurityException
- If a security or authority error occurs.ConnectionDroppedException
- If the connection is dropped unexpectedly.ErrorCompletingRequestException
- If an error occurs before the request is completed.java.io.IOException
- If an error occurs while communicating with the AS/400.IllegalObjectTypeException
- If the AS/400 object is not the required type.java.lang.InterruptedException
- If this thread is interrupted.ObjectDoesNotExistException
- If the AS/400 object does not exist.public DataQueueEntry read(int wait) throws AS400SecurityException, ErrorCompletingRequestException, java.io.IOException, IllegalObjectTypeException, java.lang.InterruptedException, ObjectDoesNotExistException
wait
- The number of seconds to wait if the queue contains no entries. Negative one (-1) means to wait until an entry is available.AS400SecurityException
- If a security or authority error occurs.ConnectionDroppedException
- If the connection is dropped unexpectedly.ErrorCompletingRequestException
- If an error occurs before the request is completed.java.io.IOException
- If an error occurs while communicating with the AS/400.IllegalObjectTypeException
- If the AS/400 object is not the required type.java.lang.InterruptedException
- If this thread is interrupted.ObjectDoesNotExistException
- If the AS/400 object does not exist.public java.lang.String toString()
toString
in class BaseDataQueue
public void write(byte[] data) throws AS400SecurityException, ErrorCompletingRequestException, java.io.IOException, IllegalObjectTypeException, java.lang.InterruptedException, ObjectDoesNotExistException
data
- The array of bytes to write to the queue.AS400SecurityException
- If a security or authority error occurs.ConnectionDroppedException
- If the connection is dropped unexpectedly.ErrorCompletingRequestException
- If an error occurs before the request is completed.java.io.IOException
- If an error occurs while communicating with the AS/400.IllegalObjectTypeException
- If the AS/400 object is not the required type.java.lang.InterruptedException
- If this thread is interrupted.ObjectDoesNotExistException
- If the AS/400 object does not exist.public void write(java.lang.String data) throws AS400SecurityException, ErrorCompletingRequestException, java.io.IOException, IllegalObjectTypeException, java.lang.InterruptedException, ObjectDoesNotExistException
data
- The string to write to the queue.AS400SecurityException
- If a security or authority error occurs.ConnectionDroppedException
- If the connection is dropped unexpectedly.ErrorCompletingRequestException
- If an error occurs before the request is completed.java.io.IOException
- If an error occurs while communicating with the AS/400.IllegalObjectTypeException
- If the AS/400 object is not the required type.java.lang.InterruptedException
- If this thread is interrupted.ObjectDoesNotExistException
- If the AS/400 object does not exist.java.io.UnsupportedEncodingException
- If the ccsid is not supported.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |