Websphere MQ Everyplace

com.ibm.mqe
Interface MQeQueueProxy


public interface MQeQueueProxy

Provides queue rule methods with a mechanism to query properties of a queue.

See Also:
MQeQueueRule

Method Summary
 long getCreationDate()
          This method returns a long value representing the date and time at which the queue was created.
 byte getDefaultPriority()
          This method returns an integer value that is the queue’s default priority.
 java.lang.String getDescription()
          This method returns a String object containing the description string for the queue.
 long getExpiryInterval()
          This method returns a long value that is the message expiry interval (in milliseconds) for the queue.
 int getMaxMessageSize()
          This method returns an integer value that is the maximum size of message (in bytes) which the queue can hold.
 int getMaxQueueSize()
          This method returns an integer value that is the maximum number of messages that can be held on this queue.
 int getNumberOfMessages()
          This method returns an integer value that is the current number of messages held on this queue.
 MQeAttribute getQueueAttribute()
          This method returns a MQeAttribute object, which defines the authenticator, cryptor, and compressor used by this queue.
 java.lang.String getQueueManagerName()
           Replies the queues queueManagerName.
 java.lang.String getQueueName()
           Replies the queues name.
 java.lang.String getQueueStore()
          This method returns a String object containing the pathname of the queue’s persistent store.
 boolean isRemoteQueue()
          This method returns a boolean value indicating whether or not this queue is a remote queue.
 boolean isSynchronous()
          This method returns boolean value indicating whether or not this queue is synchronous.
 

Method Detail

getQueueManagerName

public java.lang.String getQueueManagerName()
                                     throws MQeException

Replies the queues queueManagerName.

Returns:
A String containing the QueueManager Name.
Throws:
MQeException

getQueueName

public java.lang.String getQueueName()
                              throws MQeException

Replies the queues name.

Returns:
A String containing the Queue Name.
Throws:
MQeException

getCreationDate

public long getCreationDate()
                     throws MQeException

This method returns a long value representing the date and time at which the queue was created.

Returns:
A long value representing the time that this queue was created.
Throws:
MQeException

getDefaultPriority

public byte getDefaultPriority()
                        throws MQeException

This method returns an integer value that is the queue’s default priority.

This is the priority value which will be used for any message placed on the queue that has not previously been assigned a priority value.

Returns:
An integer value which is the default priority for this queue.
Throws:
MQeException

getDescription

public java.lang.String getDescription()
                                throws MQeException

This method returns a String object containing the description string for the queue.

Returns:
A String object containing the description string for this queue.
Throws:
MQeException

getExpiryInterval

public long getExpiryInterval()
                       throws MQeException

This method returns a long value that is the message expiry interval (in milliseconds) for the queue.

Any message that has been on the queue for a length of time greater than the expiry interval will be marked as expired. The queue’s rules then determine what happens to the message.

Returns:
A long value that is the message expiry interval (in milliseconds) for this queue. A value of zero means that the queue has no message expiry interval set.
Throws:
MQeException

getMaxMessageSize

public int getMaxMessageSize()
                      throws MQeException

This method returns an integer value that is the maximum size of message (in bytes) which the queue can hold.

Returns:
An integer value that is the maximum size of a message (in bytes) that can be held on this queue.
Throws:
MQeException

getMaxQueueSize

public int getMaxQueueSize()
                    throws MQeException

This method returns an integer value that is the maximum number of messages that can be held on this queue.

Returns:
An integer value that is the maximum number of messages that can be held on this queue.
Throws:
MQeException

getNumberOfMessages

public int getNumberOfMessages()
                        throws java.lang.Exception

This method returns an integer value that is the current number of messages held on this queue.

Returns:
An integer value that is the current number of messages held on this queue.
Throws:
MQeException
java.lang.Exception

getQueueAttribute

public MQeAttribute getQueueAttribute()
                               throws MQeException

This method returns a MQeAttribute object, which defines the authenticator, cryptor, and compressor used by this queue. These attributes are used upon any messages stored on the queue.

Returns:
A MQeAttribute object that defines the authenticator, cryptor, and compressor used by the queue.
Throws:
MQeException

getQueueStore

public java.lang.String getQueueStore()
                               throws MQeException

This method returns a String object containing the pathname of the queue’s persistent store.

Returns:
A String object that is the pathname to the queue’s persistent store.
Throws:
MQeException

isRemoteQueue

public boolean isRemoteQueue()

This method returns a boolean value indicating whether or not this queue is a remote queue.

Returns:
A boolean indicating whether this queue is a remote queue.

isSynchronous

public boolean isSynchronous()

This method returns boolean value indicating whether or not this queue is synchronous.

Returns:
A boolean indicating whether this queue is synchronous.

Websphere MQ Everyplace