TIBCO Enterprise Message Service
Version 4.3.0

com.tibco.tibjms.admin
Class QueueInfo

java.lang.Object
  extended bycom.tibco.tibjms.admin.DestinationInfo
      extended bycom.tibco.tibjms.admin.QueueInfo

public class QueueInfo
extends DestinationInfo

This class represents a message queue that is configured on the EMS server.


Field Summary
static int PREFETCH_DEFAULT
          Indicates that the default number of messages will be prefetched into the EMS client.
static int PREFETCH_NONE
          Indicates no messages will be prefetched into the EMS client.
 
Fields inherited from class com.tibco.tibjms.admin.DestinationInfo
ALL_TYPE, MSG_TRACE_BASIC, MSG_TRACE_DETAIL, MSG_TRACE_NONE, OVERFLOW_DEFAULT, OVERFLOW_DISCARD_OLD, QUEUE_TYPE, TOPIC_TYPE
 
Constructor Summary
QueueInfo(java.lang.String queueName)
          The public constructor creates a QueueInfo object with the given name.
 
Method Summary
 long getDeliveredMessageCount()
          Get the total number of messages that have been delivered to consumer applications but have not yet been acknowledged.
 long getInTransitMessageCount()
          Get the total number of messages that have been delivered to the queue owner but have not yet been acknowledged.
 int getMaxRedelivery()
          Get the maximum number of times the server will redeliver a given message from this queue to the queue receivers.
 int getPrefetch()
          Get the number of messages prefetched by the EMS client from the server to improve efficiency.
 int getReceiverCount()
          Get the number of active receivers on this queue.
 boolean isExclusive()
          Determine if this queue is exclusive.
 boolean isExclusiveInherited()
          Determine if the exclusive property is inherited from a parent queue.
 boolean isMaxRedeliveryInherited()
          Determine if the maxRedelivery property was inheritied from a parent queue or set directly for this queue.
 boolean isPrefetchInherited()
          Determine if the prefetch setting for this queue is inherited from a parent queue.
 boolean isRouteConnected()
          Determine if the route for this queue is connected.
 void setExclusive(boolean exclusive)
          Set the exclusive property for this queue.
 void setMaxRedelivery(int maxRedelivery)
          Set the maximum number of times the server will redeliver a given message from this queue to the queue receivers.
 void setPrefetch(int prefetch)
          Set the number of messages prefetched by the EMS client from the server to improve efficiency.
 java.lang.String toString()
           
 
Methods inherited from class com.tibco.tibjms.admin.DestinationInfo
addImportTransport, areBridgeTargetsInherited, areImportTransportsInherited, getBridgeTargets, getConsumerCount, getDescription, getExpiryOverride, getFlowControlMaxBytes, getImportTransports, getInboundStatistics, getJNDINames, getMaxBytes, getMaxMsgs, getMsgTrace, getName, getOutboundStatistics, getOverflowPolicy, getPendingMessageCount, getPendingMessageSize, isCMImported, isCMImportedInherited, isExpiryOverrideInherited, isFailsafe, isFailsafeInherited, isFlowControlMaxBytesInherited, isGlobal, isGlobalInherited, isImported, isImportedInherited, isMaxBytesInherited, isMaxMsgsInherited, isMsgTraceInherited, isOverflowPolicyInherited, isSecure, isSecureInherited, isSenderName, isSenderNameEnforced, isSenderNameEnforcedInherited, isSenderNameInherited, isStatic, isTemporary, removeImportTransport, setCMImported, setDescription, setExpiryOverride, setFailsafe, setFlowControlMaxBytes, setGlobal, setImported, setMaxBytes, setMaxMsgs, setMsgTrace, setOverflowPolicy, setSecure, setSenderName, setSenderNameEnforced, statString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

PREFETCH_NONE

public static final int PREFETCH_NONE
Indicates no messages will be prefetched into the EMS client.

See Also:
Constant Field Values

PREFETCH_DEFAULT

public static final int PREFETCH_DEFAULT
Indicates that the default number of messages will be prefetched into the EMS client.

See Also:
Constant Field Values
Constructor Detail

QueueInfo

public QueueInfo(java.lang.String queueName)
The public constructor creates a QueueInfo object with the given name. The queue is not created on the server until the object is passed to TibjmsAdmin.createQueue().

Parameters:
queueName - the name for the queue being created.
Method Detail

isExclusive

public boolean isExclusive()
Determine if this queue is exclusive.

Returns:
true if this queue has the exclusive property set.

isExclusiveInherited

public boolean isExclusiveInherited()
Determine if the exclusive property is inherited from a parent queue.

Returns:
true if the exclusive property is inherited from a parent queue.

setExclusive

public void setExclusive(boolean exclusive)
Set the exclusive property for this queue.

Parameters:
exclusive - true if this queue should be exclusive.

getPrefetch

public int getPrefetch()
Get the number of messages prefetched by the EMS client from the server to improve efficiency.

Returns:
the number of messages prefetched by the EMS client.

isPrefetchInherited

public boolean isPrefetchInherited()
Determine if the prefetch setting for this queue is inherited from a parent queue.

Returns:
true if the prefetch setting for this queue is inherited from a parent queue.

setPrefetch

public void setPrefetch(int prefetch)
Set the number of messages prefetched by the EMS client from the server to improve efficiency. To use the default prefetch setting, prefetch should be set to PREFETCH_DEFAULT. To disable this feature so messages are not prefetched into the client set prefetch to PREFETCH_NONE.

Parameters:
prefetch - the number of messages to prefetch for this queue.

isRouteConnected

public boolean isRouteConnected()
Determine if the route for this queue is connected.

Returns:
true if the route for this queue is connected.

getReceiverCount

public int getReceiverCount()
Get the number of active receivers on this queue.

Returns:
the number of active receivers on this queue.

getMaxRedelivery

public int getMaxRedelivery()
Get the maximum number of times the server will redeliver a given message from this queue to the queue receivers.

Returns:
the maximum number of times a message will be redelivered. A return value of zero indicates that the server will continue to deliver a message to the receivers until either the message is consumed or, if the message has a finite time to live, the message expires.

setMaxRedelivery

public void setMaxRedelivery(int maxRedelivery)
Set the maximum number of times the server will redeliver a given message from this queue to the queue receivers.

Parameters:
maxRedelivery - the maximum number of times a message should be redelivered. Set the value to zero to cancel the current value.

isMaxRedeliveryInherited

public boolean isMaxRedeliveryInherited()
Determine if the maxRedelivery property was inheritied from a parent queue or set directly for this queue.

Returns:
true if the maxRedelivery property was inherited.

getDeliveredMessageCount

public long getDeliveredMessageCount()
Get the total number of messages that have been delivered to consumer applications but have not yet been acknowledged.

Returns:
the total number of delivered messages for this queue.

getInTransitMessageCount

public long getInTransitMessageCount()
Get the total number of messages that have been delivered to the queue owner but have not yet been acknowledged.

Returns:
the total number of in transit messages for this queue.

toString

public java.lang.String toString()

TIBCO Enterprise Message Service
Version 4.3.0

Copyright © TIBCO Software Inc. All rights reserved