All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.access.BaseDataQueue

java.lang.Object
   |
   +----com.ibm.as400.access.BaseDataQueue

public abstract class BaseDataQueue
extends Object
implements Serializable
The BaseDataQueue class represents an AS/400 data queue object.


Constructor Index

 o BaseDataQueue()
Constructs a BaseDataQueue object.
 o BaseDataQueue(AS400, String)
Constructs a BaseDataQueue object.

Method Index

 o addDataQueueListener(DataQueueListener)
Adds a listener to be notified when a data queue event occurs.
 o addObjectListener(ObjectListener)
Adds a listener to be notified when an object event occurs.
 o addPropertyChangeListener(PropertyChangeListener)
Adds a listener to be notified when the value of any bound property changes.
 o addVetoableChangeListener(VetoableChangeListener)
Adds a listener to be notified when the value of any constrained property changes.
 o clear()
Removes all entries from the data queue.
 o delete()
Deletes the data queue.
 o getCcsid()
Returns the CCSID used for the data in this data queue.
 o getDescription()
Returns the text description of the data queue.
 o getForceToAuxiliaryStorage()
Returns a value that indicates if entries are forced to auxiliary storage.
 o getMaxEntryLength()
Returns the maximum entry length of the data queue.
 o getName()
Returns the name of the data queue.
 o getPath()
Returns the full integrated file system path name of the data queue.
 o getSaveSenderInformation()
Returns whether sender information is stored with each data queue entry.
 o getSystem()
Returns the AS400 object representing the system on which the data queue exists.
 o isFIFO()
Returns a value that indicates if entries are read in FIFO order.
 o refreshAttributes()
Refreshes the attributes of the data queue.
 o removeDataQueueListener(DataQueueListener)
Removes a data queue listener.
 o removeObjectListener(ObjectListener)
Removes a object listener.
 o removePropertyChangeListener(PropertyChangeListener)
Removes a property change listener.
 o removeVetoableChangeListener(VetoableChangeListener)
Removes a vetoable change listener.
 o setCcsid(int)
Sets the CCSID to use for the data in this data queue.
 o setPath(String)
Sets the fully qualified integrated file system path name of the data queue.
 o setSystem(AS400)
Sets the system on which the data queue exists.
 o toString()
Returns the String representation of this data queue object.

Constructors

 o BaseDataQueue
 public BaseDataQueue()
Constructs a BaseDataQueue object. The system and path properties will need to be set before using any method requiring a connection to the AS/400.

 o BaseDataQueue
 public BaseDataQueue(AS400 system,
                      String path)
Constructs a BaseDataQueue object. It uses the specified system and path. Depending on how the AS400 object was constructed, the user may need to be prompted for the system name, user ID, or password when any method requiring a connection to the AS/400 is done.

Parameters:
system - The AS/400 system on which the data queue exists.
path - The fully qualified integrated file system path name of the data queue.

Methods

 o addDataQueueListener
 public void addDataQueueListener(DataQueueListener listener)
Adds a listener to be notified when a data queue event occurs.

Parameters:
listener - The listener.
 o addObjectListener
 public void addObjectListener(ObjectListener listener)
Adds a listener to be notified when an object event occurs.

Parameters:
listener - The listener.
 o addPropertyChangeListener
 public void addPropertyChangeListener(PropertyChangeListener listener)
Adds a listener to be notified when the value of any bound property changes.

Parameters:
listener - The listener.
 o addVetoableChangeListener
 public void addVetoableChangeListener(VetoableChangeListener listener)
Adds a listener to be notified when the value of any constrained property changes.

Parameters:
listener - The listener.
 o clear
 public void clear() throws AS400SecurityException, ErrorCompletingRequestException, IOException, IllegalObjectTypeException, InterruptedException, ObjectDoesNotExistException
Removes all entries from the data queue.

Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: IllegalObjectTypeException
If the AS/400 object is not the required type.
Throws: InterruptedException
If this thread is interrupted.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: ServerStartupException
If the AS/400 server cannot be started.
Throws: UnknownHostException
If the AS/400 system cannot be located.
 o delete
 public void delete() throws AS400SecurityException, ErrorCompletingRequestException, IOException, IllegalObjectTypeException, InterruptedException, ObjectDoesNotExistException
Deletes the data queue.

Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: IllegalObjectTypeException
If the AS/400 object is not the required type.
Throws: InterruptedException
If this thread is interrupted.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: ServerStartupException
If the AS/400 server cannot be started.
Throws: UnknownHostException
If the AS/400 system cannot be located.
 o getCcsid
 public int getCcsid()
Returns the CCSID used for the data in this data queue.

Returns:
The CCSID used for the data in this data queue.
 o getDescription
 public String getDescription() throws AS400SecurityException, ErrorCompletingRequestException, IOException, IllegalObjectTypeException, InterruptedException, ObjectDoesNotExistException
Returns the text description of the data queue.

Returns:
The text description of the data queue.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: IllegalObjectTypeException
If the AS/400 object is not the required type.
Throws: InterruptedException
If this thread is interrupted.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: ServerStartupException
If the AS/400 server cannot be started.
Throws: UnknownHostException
If the AS/400 system cannot be located.
 o getForceToAuxiliaryStorage
 public boolean getForceToAuxiliaryStorage() throws AS400SecurityException, ErrorCompletingRequestException, IOException, IllegalObjectTypeException, InterruptedException, ObjectDoesNotExistException
Returns a value that indicates if entries are forced to auxiliary storage. If true, entries are immediately written to permanent storage. If false, written entries may be kept in memory and could be lost in the case of a power outage.

Returns:
true if entries are immediately written to permanent storage; false otherwise.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: IllegalObjectTypeException
If the AS/400 object is not the required type.
Throws: InterruptedException
If this thread is interrupted.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: ServerStartupException
If the AS/400 server cannot be started.
Throws: UnknownHostException
If the AS/400 system cannot be located.
 o getMaxEntryLength
 public int getMaxEntryLength() throws AS400SecurityException, ErrorCompletingRequestException, IOException, IllegalObjectTypeException, InterruptedException, ObjectDoesNotExistException
Returns the maximum entry length of the data queue.

Returns:
The maximum entry length of the data queue.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: IllegalObjectTypeException
If the AS/400 object is not the required type.
Throws: InterruptedException
If this thread is interrupted.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: ServerStartupException
If the AS/400 server cannot be started.
Throws: UnknownHostException
If the AS/400 system cannot be located.
 o getName
 public String getName()
Returns the name of the data queue.

Returns:
The data queue name.
 o getPath
 public String getPath()
Returns the full integrated file system path name of the data queue.

Returns:
The fully-qualified data queue name.
 o getSaveSenderInformation
 public boolean getSaveSenderInformation() throws AS400SecurityException, ErrorCompletingRequestException, IOException, IllegalObjectTypeException, InterruptedException, ObjectDoesNotExistException
Returns whether sender information is stored with each data queue entry.

Returns:
true if sender information is saved; false otherwise.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: IllegalObjectTypeException
If the AS/400 object is not the required type.
Throws: InterruptedException
If this thread is interrupted.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: ServerStartupException
If the AS/400 server cannot be started.
Throws: UnknownHostException
If the AS/400 system cannot be located.
 o getSystem
 public AS400 getSystem()
Returns the AS400 object representing the system on which the data queue exists.

Returns:
The system on which the data queue exists.
 o isFIFO
 public boolean isFIFO() throws AS400SecurityException, ErrorCompletingRequestException, IOException, IllegalObjectTypeException, InterruptedException, ObjectDoesNotExistException
Returns a value that indicates if entries are read in FIFO order. Returns true if entries are read off the data queue in FIFO order. Returns false if entries are read off the data queue in LIFO order.

Returns:
true if entries are read off the data queue in FIFO order; false otherwise.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: IllegalObjectTypeException
If the AS/400 object is not the required type.
Throws: InterruptedException
If this thread is interrupted.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: ServerStartupException
If the AS/400 server cannot be started.
Throws: UnknownHostException
If the AS/400 system cannot be located.
 o refreshAttributes
 public void refreshAttributes() throws AS400SecurityException, ErrorCompletingRequestException, IOException, IllegalObjectTypeException, InterruptedException, ObjectDoesNotExistException
Refreshes the attributes of the data queue.

Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: IllegalObjectTypeException
If the AS/400 object is not the required type.
Throws: InterruptedException
If this thread is interrupted.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: ServerStartupException
If the AS/400 server cannot be started.
Throws: UnknownHostException
If the AS/400 system cannot be located.
 o removeDataQueueListener
 public void removeDataQueueListener(DataQueueListener listener)
Removes a data queue listener.

Parameters:
listener - The listener.
 o removeObjectListener
 public void removeObjectListener(ObjectListener listener)
Removes a object listener.

Parameters:
listener - The listener.
 o removePropertyChangeListener
 public void removePropertyChangeListener(PropertyChangeListener listener)
Removes a property change listener.

Parameters:
listener - The listener.
 o removeVetoableChangeListener
 public void removeVetoableChangeListener(VetoableChangeListener listener)
Removes a vetoable change listener.

Parameters:
listener - The listener.
 o setCcsid
 public void setCcsid(int ccsid) throws PropertyVetoException
Sets the CCSID to use for the data in this data queue.

Parameters:
ccsid - The CCSID to use for the data in this data queue.
Throws: PropertyVetoException
If the change is vetoed.
 o setPath
 public void setPath(String path) throws PropertyVetoException
Sets the fully qualified integrated file system path name of the data queue.

Parameters:
path - The fully qualified integrated file system path name of the data queue.
Throws: PropertyVetoException
If the change is vetoed.
 o setSystem
 public void setSystem(AS400 system) throws PropertyVetoException
Sets the system on which the data queue exists.

Parameters:
system - The AS/400 system on which the data queue exists.
Throws: PropertyVetoException
If the change is vetoed.
 o toString
 public String toString()
Returns the String representation of this data queue object.

Returns:
The String representation of this data queue object.
Overrides:
toString in class Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index