Package com.ibm.mq

Class MQSubscription

java.lang.Object
com.ibm.mq.jmqi.JmqiObject
com.ibm.mq.MQManagedObject
com.ibm.mq.MQSubscription
public class MQSubscription extends MQManagedObject
MQSubscription is a helper object designed to encapsulate the HSUB reference. Under normal operating circumstances the user will not use or modify the object. It is a sub class of MQManagedObject and in this fashion can take advantage of the close features offered by the base class.

  • Method Details

    • requestPublicationUpdate

      public int requestPublicationUpdate(int options) throws MQException
      Requests an update publication to be sent for the current topic. This is normally used if the user specified the CMQC.MQSO_PUBLICATIONS_ON_REQUEST option. If the queue manager has a retained publication for the topic, this is sent to the subscriber.

      The method returns the number of retained publications to be sent to the subscription queue or multicast address. There is no guarantee that this many messages will be available for the application to get, especially if they are non-persistent messages, or if the transport being used is multicast.

      There may be more than one publication if the subscribed topic contained a wildcard. If no wildcards were present in the topic string when the subscription was made, then only one publication will be sent as a result of this call.

      Parameters:
      options - This parameter maps directly to the options field of the MQSRO structure. Any or none of the following options can be specified.
      • CMQC.MQSRO_FAIL_IF_QUIESCING

        The method fails if the queue manager is in a quiescent state. On z/OS, for a CICS or IMS application, this option also forces the method to fail if the connection is in a quiescent state.

      • CMQC.MQSRO_NONE

        If none of the options described above are required, this option can be used. Use this value to indicate that no other options have been specified.

      Returns:
      The number of retained publications to be sent to the subscription queue or multicast address.
      Throws:
      MQException - If the call fails.

    • inquire

      public void inquire(int[] selectors, int[] intAttrs, byte[] charAttrs) throws MQException
      Although available on the MQManagedObject base class, this method has no relevance upon MQSubscription.
      Overrides:
      inquire in class MQManagedObject
      Parameters:
      selectors - Ignored as this method is not relevant to this class.
      intAttrs - Ignored as this method is not relevant to this class.
      charAttrs - Ignored as this method is not relevant to this class.
      Throws:
      MQException - if the inquire fails.
      See Also:

    • set

      public void set(int[] selectors, int[] intAttrs, byte[] charAttrs) throws MQException
      Although available on the MQManagedObject base class, this method has no relevance upon MQSubscription.
      Overrides:
      set in class MQManagedObject
      Parameters:
      selectors - Ignored as this method is not relevant to this class.
      intAttrs - Ignored as this method is not relevant to this class.
      charAttrs - Ignored as this method is not relevant to this class.
      Throws:
      MQException - if the set call fails.
      See Also:

    • getAttributeString

      public String getAttributeString(int aSelector, int length) throws MQException
      Although available on the MQManagedObject base class, this method has no relevance upon MQSubscription.
      Overrides:
      getAttributeString in class MQManagedObject
      Parameters:
      aSelector - Ignored as this method is not relevant to this class.
      length - Ignored as this method is not relevant to this class.
      Returns:
      String attribute string
      Throws:
      MQException - if the call fails.
      See Also:

    • setAttributeString

      public void setAttributeString(int aSelector, String aValue, int length) throws MQException
      Although available on the MQManagedObject base class, this method has no relevance upon MQSubscription.
      Overrides:
      setAttributeString in class MQManagedObject
      Parameters:
      aSelector - Ignored as this method is not relevant to this class.
      aValue - Ignored as this method is not relevant to this class.
      length - Ignored as this method is not relevant to this class.
      Throws:
      MQException - if the call fails.
      See Also:

    • getAlternateUserId

      public String getAlternateUserId() throws MQException
      This property is not valid for an MQSubscription.
      Overrides:
      getAlternateUserId in class MQManagedObject
      Returns:
      This method will always return null.
      Throws:
      MQException - If the call fails.
      See Also:

    • getDescription

      public String getDescription() throws MQException
      This property is not valid for an MQSubscription.
      Overrides:
      getDescription in class MQManagedObject
      Returns:
      This method will always return null.
      Throws:
      MQException - If this method is called after the resource has been closed, to indicate that the resource is no longer available.
      See Also:

    • getOpenOptions

      public int getOpenOptions() throws MQException
      This property is not valid for an MQSubscription.
      Overrides:
      getOpenOptions in class MQManagedObject
      Returns:
      This method will always return -1.
      Throws:
      MQException - If the call fails.
      See Also: