TIBCO Enterprise Message Service
Version 4.3.0

com.tibco.tibjms.admin
Class TopicInfo

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

public class TopicInfo
extends DestinationInfo

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


Field Summary
 
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
TopicInfo(java.lang.String topicName)
          The public constructor creates a TopicInfo object with the given name.
 
Method Summary
 void addExportTransport(java.lang.String transportName)
          Add a new export transport to the list of transports this destination exports messages to.
 boolean areExportTransportsInherited()
          Determines if the list of transports this topic exports messages on was inherited from a parent topic or whether it was set on the topic directly.
 int getActiveDurableCount()
          Get the current number of active durable subscribers for this topic.
 int getDurableCount()
          Get the current number of durable subscribers for this topic.
 java.lang.String[] getExportTransports()
          Get the names of the transports that this topic exports messages on.
 int getSubscriberCount()
          Get the current number of subscribers for this topic.
 boolean isCMExported()
          Deprecated. As of EMS Version 3.1.0, please view TIBCO Rendezvous exports using getExportTransports.
 boolean isCMExportedInherited()
          Deprecated. As of EMS Version 3.1.0, please view TIBCO Rendezvous export inheritance using areExportTransportsInherited.
 boolean isExported()
          Deprecated. As of EMS Version 3.1.0, please view TIBCO Rendezvous exports using getExportTransports.
 boolean isExportedInherited()
          Deprecated. As of EMS Version 3.1.0, please view TIBCO Rendezvous export inheritance using areExportTransportsInherited.
 void removeExportTransport(java.lang.String transportName)
          Remove an export transport from the list of transports this destination exports messages to.
 void setCMExported(boolean exported)
          Deprecated. As of EMS Version 3.1.0, please configure TIBCO Rendezvous exports using addExportTransport.
 void setExported(boolean exported)
          Deprecated. As of EMS Version 3.1.0, please configure TIBCO Rendezvous exports using addExportTransport.
 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
 

Constructor Detail

TopicInfo

public TopicInfo(java.lang.String topicName)
The public constructor creates a TopicInfo object with the given name. The topic is not created on the server until the object is passed to TibjmsAdmin.createTopic().

Parameters:
topicName - The name for the topic being created.
Method Detail

isExported

public boolean isExported()
Deprecated. As of EMS Version 3.1.0, please view TIBCO Rendezvous exports using getExportTransports.

Determine if the topic is exported to Tibrv.

Returns:
true if the topic has the tibrv_export property set.

isExportedInherited

public boolean isExportedInherited()
Deprecated. As of EMS Version 3.1.0, please view TIBCO Rendezvous export inheritance using areExportTransportsInherited.

Determine if the tibrv_export property is inherited from a parent topic.

Returns:
true if the tibrv_export property is inherited.

setExported

public void setExported(boolean exported)
Deprecated. As of EMS Version 3.1.0, please configure TIBCO Rendezvous exports using addExportTransport.

Set the tibrv_export property for the topic.

Parameters:
exported - true if the topic should be exported to Tibrv, false if it should not.

isCMExported

public boolean isCMExported()
Deprecated. As of EMS Version 3.1.0, please view TIBCO Rendezvous exports using getExportTransports.

Determine if the topic is exported to Tibrvcm.

Returns:
true if the toipc has the tibrvcm_export property set.

isCMExportedInherited

public boolean isCMExportedInherited()
Deprecated. As of EMS Version 3.1.0, please view TIBCO Rendezvous export inheritance using areExportTransportsInherited.

Determine if the tibrvcm_export property is inherited from a parent topic.

Returns:
true if the tibrvcm_export property is inherited.

setCMExported

public void setCMExported(boolean exported)
Deprecated. As of EMS Version 3.1.0, please configure TIBCO Rendezvous exports using addExportTransport.

Set the tibrvcm_export property for the topic.

Parameters:
exported - true if the topic should be exported to Tibrv, false if it should not.

getExportTransports

public java.lang.String[] getExportTransports()
Get the names of the transports that this topic exports messages on.

Returns:
array of transport names.

areExportTransportsInherited

public boolean areExportTransportsInherited()
Determines if the list of transports this topic exports messages on was inherited from a parent topic or whether it was set on the topic directly.

Returns:
true if transport list inherited from parent, false otherwise.

addExportTransport

public void addExportTransport(java.lang.String transportName)
                        throws TibjmsAdminInvalidNameException
Add a new export transport to the list of transports this destination exports messages to. If the current list of transports has been inherited from a parent topic then adding a transport will stop the inheritance and the inherited transports will all be removed from the list and replaced with the new one. From then on areExportTransportsInherited will indicate that the transports are no longer inherited and future calls to addExportTransport will simply add new transports to the list.

Parameters:
transportName - the name of the transport.
Throws:
TibjmsAdminInvalidNameException - if transportName is not a legal transport name

removeExportTransport

public void removeExportTransport(java.lang.String transportName)
                           throws TibjmsAdminInvalidNameException,
                                  TibjmsAdminException
Remove an export transport from the list of transports this destination exports messages to. The removal of a transport from the list if the transports are inherited from a parent topic is not permitted and results in an exception.

Parameters:
transportName - the name of the transport.
Throws:
TibjmsAdminInvalidNameException - if transportName is not a legal transport name
TibjmsAdminException - if export transports are inherited

getSubscriberCount

public int getSubscriberCount()
Get the current number of subscribers for this topic. This value is correct when this TopicInfo was retrieved from the server through TibjmsAdmin methods. It is never updated. To get an updated value, a new TopicInfo must be retrieved from the server.

Returns:
the number of subscibers for this queue when the TopicInfo was retrieved from the server.

getDurableCount

public int getDurableCount()
Get the current number of durable subscribers for this topic. This value is correct when this TopicInfo was retrieved from the server through TibjmsAdmin methods. It is never updated. To get an updated value, a new TopicInfo must be retrieved from the server.

Returns:
the number of durable subscribers for this queue when the TopicInfo was retrieved from the server.

getActiveDurableCount

public int getActiveDurableCount()
Get the current number of active durable subscribers for this topic. This value is correct when this TopicInfo was retrieved from the server through TibjmsAdmin methods. It is never updated. To get an updated value, a new TopicInfo must be retrieved from the server.

Returns:
the number of active durable subscribers for this queue when the TopicInfo was retrieved from the server.

toString

public java.lang.String toString()

TIBCO Enterprise Message Service
Version 4.3.0

Copyright © TIBCO Software Inc. All rights reserved