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.
-
BaseDataQueue()
- Constructs a BaseDataQueue object.
-
BaseDataQueue(AS400, String)
- Constructs a BaseDataQueue object.
-
addDataQueueListener(DataQueueListener)
- Adds a data queue listener to receive data queue events from this Data Queue.
-
addObjectListener(ObjectListener)
- Adds an object listener to receive object events from this Data Queue.
-
addPropertyChangeListener(PropertyChangeListener)
- Adds a PropertyChangeListener.
-
addVetoableChangeListener(VetoableChangeListener)
- Adds the VetoableChangeListener.
-
clear()
- Removes all entries from the data queue.
-
delete()
- Deletes a data queue on the AS400.
-
finalize()
- Removes the references to the server and AS400 object.
-
getCcsid()
- Get the CCSID to be used for this data queue.
-
getDescription()
- Returns the text description of the data queue.
-
getForceToAuxiliaryStorage()
- Returns a value that indicates if entries are forced to auxiliary storage.
-
getMaxEntryLength()
- Returns the maximum entry length of the data queue.
-
getName()
- Returns the name of the data queue.
-
getPath()
- Returns the full integrated file system path name of the data queue.
-
getSaveSenderInformation()
- Returns whether sender information is stored with each data queue entry.
-
getSystem()
- Returns the AS400 object representing the system on which the data queue exists.
-
isFIFO()
- Returns a value that indicates if entries are read in FIFO order.
-
refreshAttributes()
- Refreshes the attributes of the data queue.
-
removeDataQueueListener(DataQueueListener)
- Removes a data queue to receive data queue events from this Data Queue.
-
removeObjectListener(ObjectListener)
- Removes an object listener to receive object events from this Data Queue.
-
removePropertyChangeListener(PropertyChangeListener)
- Removes this PropertyChangeListener from the internal list.
-
removeVetoableChangeListener(VetoableChangeListener)
- Removes this VetoableChangeListener from the internal list.
-
setCcsid(int)
- Sets the CCSID to be used for this data queue.
-
setPath(String)
- Sets the fully qualified data queue name.
-
setSystem(AS400)
- Sets the system on which the data queue exists.
BaseDataQueue
public BaseDataQueue()
- Constructs a BaseDataQueue object. The system and name properties will need to be set before using any method requiring a connection to the AS400.
BaseDataQueue
public BaseDataQueue(AS400 system,
String path)
- Constructs a BaseDataQueue object. It uses the specified system name 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 AS400 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.
addDataQueueListener
public synchronized void addDataQueueListener(DataQueueListener listener)
- Adds a data queue listener to receive data queue events from this Data Queue.
- Parameters:
- listener - The object listener.
- See Also:
- removeObjectListener
addObjectListener
public synchronized void addObjectListener(ObjectListener listener)
- Adds an object listener to receive object events from this Data Queue.
- Parameters:
- listener - The object listener.
- See Also:
- removeObjectListener
addPropertyChangeListener
public void addPropertyChangeListener(PropertyChangeListener l)
- Adds a PropertyChangeListener. The specified PropertyChangeListeners propertyChange method will be called each time the value of any bound property is changed. The PropertyListener object is addded to a list of PropertyChangeListeners managed by this CommandCall. It can be removed with removePropertyChangeListener.
- Parameters:
- l - The PropertyChangeListener.
- See Also:
- removePropertyChangeListener
addVetoableChangeListener
public void addVetoableChangeListener(VetoableChangeListener l)
- Adds the VetoableChangeListener. The specified VetoableChangeListeners vetoableChange method will be called each time the value of any constrained property is changed.
- Parameters:
- l - The VetoableChangeListener.
- See Also:
- removeVetoableChangeListener
clear
public void clear() throws AS400SecurityException, ErrorCompletingRequestException, IllegalObjectTypeException, InterruptedException, IOException, 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: IllegalObjectTypeException
- If the AS/400 object is not the required type.
- Throws: InterruptedException
- If this thread is interrupted.
- Throws: IOException
- If an error occurs while communicating with the AS/400.
- 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.
delete
public void delete() throws AS400SecurityException, ErrorCompletingRequestException, IllegalObjectTypeException, InterruptedException, IOException, ObjectDoesNotExistException
- Deletes a data queue on the AS400.
- 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: IllegalObjectTypeException
- If the AS/400 object is not the required type.
- Throws: InterruptedException
- If this thread is interrupted.
- Throws: IOException
- If an error occurs while communicating with the AS/400.
- 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.
finalize
protected void finalize() throws Throwable
- Removes the references to the server and AS400 object.
- Throws: Throwable
- Any exception encountered while cleaning up.
- Overrides:
- finalize in class Object
getCcsid
public int getCcsid()
- Get the CCSID to be used for this data queue.
- Returns:
- The CCSID to use for this queue.
getDescription
public String getDescription() throws AS400SecurityException, ErrorCompletingRequestException, IllegalObjectTypeException, InterruptedException, IOException, 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: IllegalObjectTypeException
- If the AS/400 object is not the required type.
- Throws: InterruptedException
- If this thread is interrupted.
- Throws: IOException
- If an error occurs while communicating with the AS/400.
- 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.
getForceToAuxiliaryStorage
public boolean getForceToAuxiliaryStorage() throws AS400SecurityException, ErrorCompletingRequestException, IllegalObjectTypeException, InterruptedException, IOException, 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:
- 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.
- 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: IllegalObjectTypeException
- If the AS/400 object is not the required type.
- Throws: InterruptedException
- If this thread is interrupted.
- Throws: IOException
- If an error occurs while communicating with the AS/400.
- 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.
isFIFO
public boolean isFIFO() throws AS400SecurityException, ErrorCompletingRequestException, IllegalObjectTypeException, InterruptedException, IOException, 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:
- 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.
- 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: IllegalObjectTypeException
- If the AS/400 object is not the required type.
- Throws: InterruptedException
- If this thread is interrupted.
- Throws: IOException
- If an error occurs while communicating with the AS/400.
- 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.
getMaxEntryLength
public int getMaxEntryLength() throws AS400SecurityException, ErrorCompletingRequestException, IllegalObjectTypeException, InterruptedException, IOException, ObjectDoesNotExistException
- Returns the maximum entry length of the data queue.
- Returns:
- The maximum entry length.
- 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: IllegalObjectTypeException
- If the AS/400 object is not the required type.
- Throws: InterruptedException
- If this thread is interrupted.
- Throws: IOException
- If an error occurs while communicating with the AS/400.
- 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.
getName
public String getName()
- Returns the name of the data queue.
- Returns:
- The data queue name.
getPath
public String getPath()
- Returns the full integrated file system path name of the data queue.
- Returns:
- The fully-qualified data queue name.
getSaveSenderInformation
public boolean getSaveSenderInformation() throws AS400SecurityException, ErrorCompletingRequestException, IllegalObjectTypeException, InterruptedException, IOException, 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: IllegalObjectTypeException
- If the AS/400 object is not the required type.
- Throws: InterruptedException
- If this thread is interrupted.
- Throws: IOException
- If an error occurs while communicating with the AS/400.
- 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.
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.
refreshAttributes
public void refreshAttributes() throws AS400SecurityException, ErrorCompletingRequestException, IllegalObjectTypeException, InterruptedException, IOException, 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: IllegalObjectTypeException
- If the AS/400 object is not the required type.
- Throws: InterruptedException
- If this thread is interrupted.
- Throws: IOException
- If an error occurs while communicating with the AS/400.
- 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.
removeDataQueueListener
public synchronized void removeDataQueueListener(DataQueueListener l)
- Removes a data queue to receive data queue events from this Data Queue.
- Parameters:
- listener - The data queue listener.
- See Also:
- addDataQueueListener
removeObjectListener
public synchronized void removeObjectListener(ObjectListener l)
- Removes an object listener to receive object events from this Data Queue.
- Parameters:
- listener - The object listener.
- See Also:
- addObjectListener
removePropertyChangeListener
public void removePropertyChangeListener(PropertyChangeListener l)
- Removes this PropertyChangeListener from the internal list. If the PropertyChangeListener is not on the list, nothing is done.
- Parameters:
- l - The PropertyChangeListener.
- See Also:
- addPropertyChangeListener
removeVetoableChangeListener
public void removeVetoableChangeListener(VetoableChangeListener l)
- Removes this VetoableChangeListener from the internal list. If the VetoableChangeListener is not on the list, nothing is done.
- Parameters:
- l - The VetoableChangeListener.
- See Also:
- addVetoableChangeListener
setCcsid
public void setCcsid(int ccsid) throws PropertyVetoException
- Sets the CCSID to be used for this data queue.
- Parameters:
- ccsid - The CCSID to use for this queue.
- Throws: PropertyVetoException
- A PropertyVetoException is thrown if any of the registered listeners vetos the property change.
setPath
public void setPath(String path) throws PropertyVetoException
- Sets the fully qualified data queue name.
- Parameters:
- path - The fully qualified integrated file system path name of the data queue.
- Throws: PropertyVetoException
- If the change is vetoed.
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.
All Packages Class Hierarchy This Package Previous Next Index