|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.ibm.as400.access.BaseDataQueue
com.ibm.as400.access.DataQueue
public class DataQueue extends BaseDataQueue
The DataQueue class represents an IBM i sequential data queue object.
| Constructor and Description |
|---|
DataQueue()
Constructs a DataQueue object. |
DataQueue(AS400 system,
String path)
Constructs a DataQueue object. |
| Modifier and Type | Method and Description |
|---|---|
void |
create(DataQueueAttributes attributes)
Creates a sequential data queue on the system. |
void |
create(int maxEntryLength)
Creates a sequential data queue on the system. |
void |
create(int maxEntryLength,
String authority,
boolean saveSenderInformation,
boolean FIFO,
boolean forceToAuxiliaryStorage,
String description)
Creates a sequential data queue on the system. |
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. |
String |
toString()
Returns the String representation of this data queue object. |
void |
write(byte[] data)
Writes an entry to the data queue. |
void |
write(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,
String path)
system - The system object representing the 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,
IOException,
IllegalObjectTypeException,
InterruptedException,
ObjectAlreadyExistsException,
ObjectDoesNotExistException
attributes - The attributes of the data queue to be created.AS400SecurityException - If a security or authority error occurs.ErrorCompletingRequestException - If an error occurs before the request is completed.IOException - If an error occurs while communicating with the system.IllegalObjectTypeException - If the object on the system is not the required type.InterruptedException - If this thread is interrupted.ObjectAlreadyExistsException - If the object already exists on the system.ObjectDoesNotExistException - If the object does not exist on the system.
public void create(int maxEntryLength)
throws AS400SecurityException,
ErrorCompletingRequestException,
IOException,
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.ErrorCompletingRequestException - If an error occurs before the request is completed.IOException - If an error occurs while communicating with the system.InterruptedException - If this thread is interrupted.ObjectAlreadyExistsException - If the object already exists on the system.ObjectDoesNotExistException - If the object does not exist on the system.
public void create(int maxEntryLength,
String authority,
boolean saveSenderInformation,
boolean FIFO,
boolean forceToAuxiliaryStorage,
String description)
throws AS400SecurityException,
ErrorCompletingRequestException,
IOException,
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.ErrorCompletingRequestException - If an error occurs before the request is completed.IOException - If an error occurs while communicating with the system.InterruptedException - If this thread is interrupted.ObjectAlreadyExistsException - If the object already exists on the system.ObjectDoesNotExistException - If the object does not exist on the system.
public DataQueueEntry peek()
throws AS400SecurityException,
ErrorCompletingRequestException,
IOException,
IllegalObjectTypeException,
InterruptedException,
ObjectDoesNotExistException
AS400SecurityException - If a security or authority error occurs.ErrorCompletingRequestException - If an error occurs before the request is completed.IOException - If an error occurs while communicating with the system.IllegalObjectTypeException - If the object on the system is not the required type.InterruptedException - If this thread is interrupted.ObjectDoesNotExistException - If the object does not exist on the system.
public DataQueueEntry peek(int wait)
throws AS400SecurityException,
ErrorCompletingRequestException,
IOException,
IllegalObjectTypeException,
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.ErrorCompletingRequestException - If an error occurs before the request is completed.IOException - If an error occurs while communicating with the system.IllegalObjectTypeException - If the object on the system is not the required type.InterruptedException - If this thread is interrupted.ObjectDoesNotExistException - If the object does not exist on the system.
public DataQueueEntry read()
throws AS400SecurityException,
ErrorCompletingRequestException,
IOException,
IllegalObjectTypeException,
InterruptedException,
ObjectDoesNotExistException
AS400SecurityException - If a security or authority error occurs.ErrorCompletingRequestException - If an error occurs before the request is completed.IOException - If an error occurs while communicating with the system.IllegalObjectTypeException - If the object on the system is not the required type.InterruptedException - If this thread is interrupted.ObjectDoesNotExistException - If the object does not exist on the system.
public DataQueueEntry read(int wait)
throws AS400SecurityException,
ErrorCompletingRequestException,
IOException,
IllegalObjectTypeException,
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.ErrorCompletingRequestException - If an error occurs before the request is completed.IOException - If an error occurs while communicating with the system.IllegalObjectTypeException - If the object on the system is not the required type.InterruptedException - If this thread is interrupted.ObjectDoesNotExistException - If the object does not exist on the system.public String toString()
toString in class BaseDataQueue
public void write(byte[] data)
throws AS400SecurityException,
ErrorCompletingRequestException,
IOException,
IllegalObjectTypeException,
InterruptedException,
ObjectDoesNotExistException
data - The array of bytes to write to the queue.AS400SecurityException - If a security or authority error occurs.ErrorCompletingRequestException - If an error occurs before the request is completed.IOException - If an error occurs while communicating with the system.IllegalObjectTypeException - If the object on the system is not the required type.InterruptedException - If this thread is interrupted.ObjectDoesNotExistException - If the object does not exist on the system.
public void write(String data)
throws AS400SecurityException,
ErrorCompletingRequestException,
IOException,
IllegalObjectTypeException,
InterruptedException,
ObjectDoesNotExistException
data - The string to write to the queue.AS400SecurityException - If a security or authority error occurs.ErrorCompletingRequestException - If an error occurs before the request is completed.IOException - If an error occurs while communicating with the system.IllegalObjectTypeException - If the object on the system is not the required type.InterruptedException - If this thread is interrupted.ObjectDoesNotExistException - If the object does not exist on the system.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||