|
|||||||||
| 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.KeyedDataQueue
public class KeyedDataQueue extends BaseDataQueue
The KeyedDataQueue class represents a keyed data queue object.
| Constructor and Description |
|---|
KeyedDataQueue()
Constructs a KeyedDataQueue object. |
KeyedDataQueue(AS400 system,
String path)
Constructs a KeyedDataQueue object. |
| Modifier and Type | Method and Description |
|---|---|
void |
clear(byte[] key)
Removes all entries that match the key from the data queue. |
void |
clear(String key)
Removes all entries that match the key from the data queue. |
void |
create(int keyLength,
int maxEntryLength)
Creates a keyed data queue on the system. |
void |
create(int keyLength,
int maxEntryLength,
String authority,
boolean saveSenderInformation,
boolean forceToAuxiliaryStorage,
String description)
Creates a keyed data queue on the system. |
int |
getKeyLength()
Returns the length of the keys (in bytes) on this queue. |
KeyedDataQueueEntry |
peek(byte[] key)
Reads an entry from the data queue without removing it from the queue. |
KeyedDataQueueEntry |
peek(byte[] key,
int wait,
String searchType)
Reads an entry from the data queue without removing it from the queue. |
KeyedDataQueueEntry |
peek(String key)
Reads an entry from the data queue without removing it from the queue. |
KeyedDataQueueEntry |
peek(String key,
int wait,
String searchType)
Reads an entry from the data queue without removing it from the queue. |
KeyedDataQueueEntry |
read(byte[] key)
Reads an entry from the data queue and removes it from the queue. |
KeyedDataQueueEntry |
read(byte[] key,
int wait,
String searchType)
Reads an entry from the data queue and removes it from the queue. |
KeyedDataQueueEntry |
read(String key)
Reads an entry from the data queue and removes it from the queue. |
KeyedDataQueueEntry |
read(String key,
int wait,
String searchType)
Reads an entry from the data queue and removes it from the queue. |
String |
toString()
Returns the String representation of this keyed data queue object. |
void |
write(byte[] key,
byte[] data)
Writes an entry to the data queue. |
void |
write(String key,
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 KeyedDataQueue()
public KeyedDataQueue(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 clear(byte[] key)
throws AS400SecurityException,
ErrorCompletingRequestException,
IOException,
IllegalObjectTypeException,
InterruptedException,
ObjectDoesNotExistException
key - The key with which data queue entries will be compared. All entries whose key is equal to this parameter will be removed from 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 clear(String key)
throws AS400SecurityException,
ErrorCompletingRequestException,
IOException,
IllegalObjectTypeException,
InterruptedException,
ObjectDoesNotExistException
key - The key with which data queue entries will be compared. All entries whose key is equal to this parameter will be removed from 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 create(int keyLength,
int maxEntryLength)
throws AS400SecurityException,
ErrorCompletingRequestException,
IOException,
InterruptedException,
ObjectAlreadyExistsException,
ObjectDoesNotExistException
keyLength - The number of bytes per data queue key. Valid values are 1-256.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 keyLength,
int maxEntryLength,
String authority,
boolean saveSenderInformation,
boolean forceToAuxiliaryStorage,
String description)
throws AS400SecurityException,
ErrorCompletingRequestException,
IOException,
InterruptedException,
ObjectAlreadyExistsException,
ObjectDoesNotExistException
keyLength - The number of bytes per data queue key. Valid values are 1-256.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 - Determines if entry origin information will be saved.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 int getKeyLength()
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 KeyedDataQueueEntry peek(byte[] key)
throws AS400SecurityException,
ErrorCompletingRequestException,
IOException,
IllegalObjectTypeException,
InterruptedException,
ObjectDoesNotExistException
key - The array that contains the key used to search for an entry. An entry must have a key equal to this value to be read.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 KeyedDataQueueEntry peek(byte[] key,
int wait,
String searchType)
throws AS400SecurityException,
ErrorCompletingRequestException,
IOException,
IllegalObjectTypeException,
InterruptedException,
ObjectDoesNotExistException
key - The array that contains the key used to search for an entry.wait - The number of seconds to wait if the queue contains no entries. Negative one (-1) indicates to wait until an entry is available.searchType - The type of comparison to use to determine if a key is a match. Valid values are EQ (equal), NE (not equal), LT (less than), LE (less than or equal), GT (greater than), and GE (greater than or equal).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 KeyedDataQueueEntry peek(String key)
throws AS400SecurityException,
ErrorCompletingRequestException,
IOException,
IllegalObjectTypeException,
InterruptedException,
ObjectDoesNotExistException
key - The string that contains the key used to search for an entry. An entry must have a key equal to this value to be read.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 KeyedDataQueueEntry peek(String key,
int wait,
String searchType)
throws AS400SecurityException,
ErrorCompletingRequestException,
IOException,
IllegalObjectTypeException,
InterruptedException,
ObjectDoesNotExistException
key - The string that contains the key used to search for an entry.wait - The number of seconds to wait if the queue contains no entries. Negative one (-1) means to wait until an entry is available.searchType - The type of comparison to use to determine if a key is a match. Valid values are EQ (equal), NE (not equal), LT (less than), LE (less than or equal), GT (greater than), and GE (greater than or equal).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 KeyedDataQueueEntry read(byte[] key)
throws AS400SecurityException,
ErrorCompletingRequestException,
IOException,
IllegalObjectTypeException,
InterruptedException,
ObjectDoesNotExistException
key - The array that contains the key used to search for an entry. An entry must have a key equal to this value to be read.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 KeyedDataQueueEntry read(byte[] key,
int wait,
String searchType)
throws AS400SecurityException,
ErrorCompletingRequestException,
IOException,
IllegalObjectTypeException,
InterruptedException,
ObjectDoesNotExistException
key - The array that contains the key used to search for an entry.wait - The number of seconds to wait if the queue contains no entries. Negative one (-1) indicates to wait until an entry is available.searchType - The type of comparison to use to determine if a key is a match. Valid values are EQ (equal), NE (not equal), LT (less than), LE (less than or equal), GT (greater than), and GE (greater than or equal).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 KeyedDataQueueEntry read(String key)
throws AS400SecurityException,
ErrorCompletingRequestException,
IOException,
IllegalObjectTypeException,
InterruptedException,
ObjectDoesNotExistException
key - The string that contains the key used to search for an entry. An entry must have a key equal to this value to be read.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 KeyedDataQueueEntry read(String key,
int wait,
String searchType)
throws AS400SecurityException,
ErrorCompletingRequestException,
IOException,
IllegalObjectTypeException,
InterruptedException,
ObjectDoesNotExistException
key - The string that contains the key used to search for an entry.wait - The number of seconds to wait if the queue contains no entries. Negative one (-1) indicates to wait until an entry is available.searchType - The type of comparison to use to determine if a key is a match. Valid values are EQ (equal), NE (not equal), LT (less than), LE (less than or equal), GT (greater than), and GE (greater than or equal).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[] key,
byte[] data)
throws AS400SecurityException,
ErrorCompletingRequestException,
IOException,
IllegalObjectTypeException,
InterruptedException,
ObjectDoesNotExistException
key - The array that contains the key for this entry.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 key,
String data)
throws AS400SecurityException,
ErrorCompletingRequestException,
IOException,
IllegalObjectTypeException,
InterruptedException,
ObjectDoesNotExistException
key - The string that contains the key for this entry.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 | ||||||||