|
TIBCO Enterprise Message Service Version 4.3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.tibco.tibjms.admin.DestinationInfo
This abstract class contains methods common to both QueueInfo
and TopicInfo. It represents a Topic or Queue known to the server.
Destinations fall into three categories: static, dynamic, and temporary.
Static destinations are explicitly configured and appear in the
configuration files on the server.
Dynamic destinations are created dynamically by EMS clients or routed servers.
Dynamic destinations cannot be modified.
Temporary destinations are defined by the JMS specification.
Temporary destinations cannot be modified.
TopicInfo or QueueInfo objects received via TibjmsAdmin.getTopic() or
TibjmsAdmin.getQueue() methods do not contain the statistical data
about the destination. In order to obtain statistical information about
destinations use TibjmsAdmin.getTopicsStatistics() or TibjmsAdmin.getQueuesStatistics().
Field Summary | |
static int |
ALL_TYPE
Type indicating a topic or queue. |
static byte |
MSG_TRACE_BASIC
Indicates that message sequence number and message ID will be traced. |
static byte |
MSG_TRACE_DETAIL
Indicates that the message body will be traced in addition to the message sequnce number and message ID, . |
static byte |
MSG_TRACE_NONE
Indicates that messages will not be traced. |
static int |
OVERFLOW_DEFAULT
Indicates that the destination has no specific overflow policy set. |
static int |
OVERFLOW_DISCARD_OLD
Indicates that if maxmsgs or maxbytes are exceeded for the queue then when new messages arrive, old messages will be discarded. |
static int |
QUEUE_TYPE
Type indicating a queue. |
static int |
TOPIC_TYPE
Type indicating a topic. |
Method Summary | |
void |
addImportTransport(java.lang.String transportName)
Add a new import transport to the list of transports this destination imports messages from. |
boolean |
areBridgeTargetsInherited()
Determines if the list of targets was inherited from a parent destination or whether it was set on the destination directly. |
boolean |
areImportTransportsInherited()
Determines if the list of transports this destination imports messages from was inherited from a parent destination or whether it was set on the destination directly. |
BridgeTarget[] |
getBridgeTargets()
Get the target destinations that this destination bridges to. |
int |
getConsumerCount()
Get the number of consumers for this destination. |
java.lang.String |
getDescription()
Get the description of this destination. |
long |
getExpiryOverride()
Get the expiry override for this destination. |
long |
getFlowControlMaxBytes()
Get the volume of pending messages (in bytes) at which flow control is enabled for this destination. |
java.lang.String[] |
getImportTransports()
Get the names of the transports that this destination imports messages from. |
StatData |
getInboundStatistics()
Get inbound statistics for this destination. |
java.lang.String[] |
getJNDINames()
Get the array of JNDI names for this destination. |
long |
getMaxBytes()
Get the maximum number of message bytes that the server will store for pending messages bound for this destination. |
long |
getMaxMsgs()
Get the maximum number of messages that the server will store for pending messages bound for this destination. |
byte |
getMsgTrace()
Indicates whether message tracing is enabled for this destination and, if it is enabled, what is to be traced. |
java.lang.String |
getName()
Get the name of this destination. |
StatData |
getOutboundStatistics()
Get outbound statistics for this destination. |
int |
getOverflowPolicy()
Get the overflow policy for this destination. |
long |
getPendingMessageCount()
Get the total number of pending messages for this destination. |
long |
getPendingMessageSize()
Get the total size for all pending messages for this destination. |
boolean |
isCMImported()
Deprecated. As of EMS Version 3.1.0, please view TIBCO Rendezvous imports using getImportTransports . |
boolean |
isCMImportedInherited()
Deprecated. As of EMS Version 3.1.0, please view TIBCO Rendezvous import inheritance using areImportTransportsInherited . |
boolean |
isExpiryOverrideInherited()
Determine if the expiry override property was inheritied from a parent destination or set directly for this destination. |
boolean |
isFailsafe()
Determine if this destination is failsafe. |
boolean |
isFailsafeInherited()
Determine if the failsafe property was inheritied from a parent destination or set directly for this destination. |
boolean |
isFlowControlMaxBytesInherited()
Determine if the flowControlMaxBytes property was inheritied from a parent destination or set directly for this destination. |
boolean |
isGlobal()
Determine if this destination is global. |
boolean |
isGlobalInherited()
Determine if the global property was inheritied from a parent destination or set directly for this destination. |
boolean |
isImported()
Deprecated. As of EMS Version 3.1.0, please view TIBCO Rendezvous imports using getImportTransports . |
boolean |
isImportedInherited()
Deprecated. As of EMS Version 3.1.0, please view TIBCO Rendezvous import inheritance using areImportTransportsInherited . |
boolean |
isMaxBytesInherited()
Determine if the maxBytes property was inheritied from a parent destination or set directly for this destination. |
boolean |
isMaxMsgsInherited()
Determine if the maxMsgs property was inheritied from a parent destination or set directly for this destination. |
boolean |
isMsgTraceInherited()
Determine if the message trace property was inheritied from a parent destination or set directly for this destination. |
boolean |
isOverflowPolicyInherited()
Determine if the overflow property was inheritied from a parent destination or set directly for this destination. |
boolean |
isSecure()
Determine if this destination is secure. |
boolean |
isSecureInherited()
Determine if the secure property was inheritied from a parent destination or set directly for this destination. |
boolean |
isSenderName()
Indicates whether or not the sender_name property is set on this destionation. |
boolean |
isSenderNameEnforced()
Indicates whether or not the sender_name_enforced property is set on this destination. |
boolean |
isSenderNameEnforcedInherited()
Indicates whether or not the sender_name_enforced is inherited. |
boolean |
isSenderNameInherited()
Indicates whether or not the sender_name property is inherited. |
boolean |
isStatic()
Determine if this destination is static. |
boolean |
isTemporary()
Determine if this destination is temporary. |
void |
removeImportTransport(java.lang.String transportName)
Remove an import transport from the list of transports this destination imports messages from. |
void |
setCMImported(boolean imported)
Deprecated. As of EMS Version 3.1.0, please configure TIBCO Rendezvous imports using addImportTransport . |
void |
setDescription(java.lang.String description)
Set the description of this destination. |
void |
setExpiryOverride(long expiry)
Set the expiry override for this destination. |
void |
setFailsafe(boolean failsafe)
Set the failsafe property of this destination. |
void |
setFlowControlMaxBytes(long fcBytes)
Set the volume of pending messages (in bytes) at which flow control will be enabled for this destination. |
void |
setGlobal(boolean global)
Set the global property of this destination. |
void |
setImported(boolean imported)
Deprecated. As of EMS Version 3.1.0, please configure TIBCO Rendezvous imports using addImportTransport . |
void |
setMaxBytes(long maxBytes)
Set the maximum number of message bytes that the server will store for pending messages bound for this destination. |
void |
setMaxMsgs(long maxMsgs)
Set the maximum number of messages that the server will store for pending messages bound for this destination. |
void |
setMsgTrace(byte trace)
Set the level of message tracing for this destination. |
void |
setOverflowPolicy(int overflow)
Set the overflow policy for this destination. |
void |
setSecure(boolean secure)
Set the secure property of this destination. |
void |
setSenderName(boolean senderName)
Set sender_name property. |
void |
setSenderNameEnforced(boolean senderNameEnforced)
Set sender_name_enforced property. |
java.lang.String |
statString()
Helper method that generates the statistical information in the form of a string. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int ALL_TYPE
public static final int QUEUE_TYPE
public static final int TOPIC_TYPE
public static final byte MSG_TRACE_NONE
public static final byte MSG_TRACE_BASIC
public static final byte MSG_TRACE_DETAIL
public static final int OVERFLOW_DEFAULT
public static final int OVERFLOW_DISCARD_OLD
Method Detail |
public java.lang.String[] getJNDINames()
public java.lang.String getName()
public java.lang.String getDescription()
public void setDescription(java.lang.String description)
description
- the description for this destination.public boolean isFailsafe()
public void setFailsafe(boolean failsafe)
failsafe
- true if this destination should be failsafe.public boolean isFailsafeInherited()
public boolean isSecure()
public void setSecure(boolean secure)
secure
- true if this destination should be secure.public boolean isSecureInherited()
public boolean isGlobal()
public void setGlobal(boolean global)
global
- true if this destination should be global.public boolean isGlobalInherited()
public boolean isImported()
getImportTransports
.
public void setImported(boolean imported)
addImportTransport
.
imported
- true if this destination should be imported.public boolean isImportedInherited()
areImportTransportsInherited
.
public boolean isCMImported()
getImportTransports
.
public void setCMImported(boolean imported)
addImportTransport
.
imported
- true if this destination should be imported from RVCM.public java.lang.String[] getImportTransports()
public boolean areImportTransportsInherited()
public void addImportTransport(java.lang.String transportName) throws TibjmsAdminInvalidNameException
transportName
- the name of the transport.
TibjmsAdminInvalidNameException
- if transportName is not a legal
transport namepublic void removeImportTransport(java.lang.String transportName) throws TibjmsAdminInvalidNameException, TibjmsAdminException
transportName
- the name of the transport.
TibjmsAdminInvalidNameException
- if transportName is not a legal
transport name
TibjmsAdminException
- if import transports are inheritedpublic BridgeTarget[] getBridgeTargets()
public boolean areBridgeTargetsInherited()
public boolean isSenderName()
public void setSenderName(boolean senderName)
senderName
- name of sender.public boolean isSenderNameInherited()
public boolean isSenderNameEnforced()
public void setSenderNameEnforced(boolean senderNameEnforced)
senderNameEnforced
- true if the property is to be set, false otherwise.public boolean isSenderNameEnforcedInherited()
public boolean isCMImportedInherited()
areImportTransportsInherited
.
public long getMaxBytes()
public void setMaxBytes(long maxBytes)
maxBytes
- the maximum number of message bytes the server should store bound for this destination.public boolean isMaxBytesInherited()
public long getMaxMsgs()
public void setMaxMsgs(long maxMsgs)
maxMsgs
- the maximum number of messages the server should store
bound for this destination. If the destination is a topic, the method
will have no effect.public boolean isMaxMsgsInherited()
public int getOverflowPolicy()
OVERFLOW_DEFAULT
or OVERFLOW_DISCARD_OLD
.
Not currently supported for topics.
OVERFLOW_DEFAULT
.public void setOverflowPolicy(int overflow) throws java.lang.IllegalArgumentException, TibjmsAdminException
OVERFLOW_DEFAULT
and OVERFLOW_DISCARD_OLD
.
Not currently supported for topics.
overflow
- the overflow policy for this destination. If the
destination is a topic the method will have no effect.
java.lang.IllegalArgumentException
- if overflow is invalid.
TibjmsAdminException
public boolean isOverflowPolicyInherited()
public byte getMsgTrace()
public void setMsgTrace(byte trace) throws java.lang.IllegalArgumentException
trace
- a byte representing the desired level of message tracing
for this destination.
java.lang.IllegalArgumentException
- if trace is invalid.public boolean isMsgTraceInherited()
public long getFlowControlMaxBytes()
public void setFlowControlMaxBytes(long fcBytes)
fcBytes
- the volume of messages (in bytes) that the server
should store for this destination before enabling flow control. Set the
value to zero to cancel the current value.public boolean isFlowControlMaxBytesInherited()
public boolean isStatic()
public boolean isTemporary()
public long getPendingMessageCount()
public long getPendingMessageSize()
public int getConsumerCount()
public StatData getInboundStatistics()
public StatData getOutboundStatistics()
public long getExpiryOverride()
public void setExpiryOverride(long expiry)
expiry
- the expiration time in milliseconds.public boolean isExpiryOverrideInherited()
public java.lang.String statString()
|
TIBCO Enterprise Message Service Version 4.3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |