Class TibjmsQueue

  • java.lang.Object
    • com.tibco.tibjms.TibjmsDestination
      • com.tibco.tibjms.TibjmsQueue
  • All Implemented Interfaces:
    com.tibco.tibjms.TibjmsXMLConst, java.io.Serializable, java.lang.Cloneable, Destination, Queue, javax.naming.Referenceable

    public class TibjmsQueue
    extends com.tibco.tibjms.TibjmsDestination
    implements Queue, java.io.Serializable, java.lang.Cloneable, javax.naming.Referenceable
    Implementation of javax.jms.Queue which can be used for administrative purposes.

    Normally EMS applications look up Queue objects via JNDI calls. This class can be used by the administrator application if it is required to store TibjmsQueue objects in the 3rd party JNDI store such as LDAP or similar.
    See Also:
    Serialized Form
    • Field Summary

      • Fields inherited from interface com.tibco.tibjms.TibjmsXMLConst

        TIBJMS_LDAP_ADMINOBJ, TIBJMS_LDAP_CN, TIBJMS_LDAP_OBJCLASS, TIBJMS_LDAP_TOP, TIBJMS_LDAP_XMLDATA, TIBJMS_XML_ADMINOBJ, TIBJMS_XML_AUTHONLY, TIBJMS_XML_AUTHORITIES, TIBJMS_XML_B64DATA, TIBJMS_XML_CERT, TIBJMS_XML_CERTS, TIBJMS_XML_CIDENTITY, TIBJMS_XML_CIPHERS, TIBJMS_XML_CLIENTID, TIBJMS_XML_CONFACT, TIBJMS_XML_CONNATTEMPTS, TIBJMS_XML_CONNATTEMPTTIMEOUT, TIBJMS_XML_CONNDELAY, TIBJMS_XML_DEBUG_TRACE, TIBJMS_XML_DESTTYPE, TIBJMS_XML_DISABLED, TIBJMS_XML_DTDURL, TIBJMS_XML_ENABLED, TIBJMS_XML_ENCODING, TIBJMS_XML_EXPECTHNAME, TIBJMS_XML_FILE, TIBJMS_XML_GENERIC, TIBJMS_XML_GENPARAMS, TIBJMS_XML_ISSUER, TIBJMS_XML_METRIC, TIBJMS_XML_MULTICAST, TIBJMS_XML_MULTICAST_DAEMON, TIBJMS_XML_NAME, TIBJMS_XML_PARAMETER, TIBJMS_XML_PASSWORD, TIBJMS_XML_PKEY, TIBJMS_XML_QUEUE, TIBJMS_XML_RECONNATTEMPTS, TIBJMS_XML_RECONNATTEMPTTIMEOUT, TIBJMS_XML_RECONNDELAY, TIBJMS_XML_SECPARAMS, TIBJMS_XML_SSLPARAMS, TIBJMS_XML_TOPIC, TIBJMS_XML_TRACE, TIBJMS_XML_TRUSTED, TIBJMS_XML_URL, TIBJMS_XML_USERNAME, TIBJMS_XML_VALUE, TIBJMS_XML_VENDOR, TIBJMS_XML_VERIFYHNAME, TIBJMS_XML_VERIFYHOST, TIBJMS_XML_XA
    • Constructor Summary

      Constructors 
      Constructor Description
      TibjmsQueue()
      Constructs a new TibjmsQueue object.
      TibjmsQueue​(java.lang.String address)
      Constructs a new TibjmsQueue object with the given address.
      TibjmsQueue​(java.lang.String address, java.lang.String jndiName)
      Internal constructor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object clone()  
      boolean equals​(java.lang.Object obj)  
      java.lang.String getAddress()
      Gets the address of this queue.
      java.lang.String getQueueName()
      Gets the name of this queue.
      javax.naming.Reference getReference()  
      void setAddress​(java.lang.String address)
      Sets the address of this queue.
      java.lang.String toString()
      Returns a string representation of this object.
      • Methods inherited from class com.tibco.tibjms.TibjmsDestination

        buildXML, getJndiName, hashCode
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • TibjmsQueue

        public TibjmsQueue()
        Constructs a new TibjmsQueue object.
      • TibjmsQueue

        public TibjmsQueue​(java.lang.String address)
        Constructs a new TibjmsQueue object with the given address.
        Parameters:
        address - address of the queue
      • TibjmsQueue

        public TibjmsQueue​(java.lang.String address,
                           java.lang.String jndiName)
        Internal constructor.
    • Method Detail

      • clone

        public java.lang.Object clone()
                               throws java.lang.CloneNotSupportedException
        Overrides:
        clone in class com.tibco.tibjms.TibjmsDestination
        Throws:
        java.lang.CloneNotSupportedException
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class com.tibco.tibjms.TibjmsDestination
      • getQueueName

        public java.lang.String getQueueName()
                                      throws JMSException
        Description copied from interface: Queue
        Gets the name of this queue.

        Clients that depend upon the name are not portable.

        Specified by:
        getQueueName in interface Queue
        Returns:
        the queue name
        Throws:
        JMSException - if the Jakarta Messaging provider implementation of Queue fails to return the queue name due to some internal error.
      • toString

        public java.lang.String toString()
        Description copied from interface: Queue
        Returns a string representation of this object.
        Specified by:
        toString in interface Queue
        Overrides:
        toString in class com.tibco.tibjms.TibjmsDestination
        Returns:
        the provider-specific identity values for this queue
      • getReference

        public javax.naming.Reference getReference()
                                            throws javax.naming.NamingException
        Specified by:
        getReference in interface javax.naming.Referenceable
        Throws:
        javax.naming.NamingException
      • getAddress

        public java.lang.String getAddress()
        Gets the address of this queue. Address and name are synonyms.
        Overrides:
        getAddress in class com.tibco.tibjms.TibjmsDestination
        Returns:
        the queue's address
      • setAddress

        public void setAddress​(java.lang.String address)
                        throws JMSException
        Sets the address of this queue. Address and name are synonyms.

        Example:

        TibjmsQueue queue = new TibjmsQueue();
        queue.setAddress("queue.sample");
        Overrides:
        setAddress in class com.tibco.tibjms.TibjmsDestination
        Parameters:
        address - the string representing the address, or name, of this queue
        Throws:
        JMSException - if the address has already been set