WBI BrokersTM
Config Manager Proxy API

com.ibm.broker.config.proxy
Class Subscription

java.lang.Object
  extended bycom.ibm.broker.config.proxy.Subscription

public class Subscription
extends Object

Each Subscription object represents a single topic subscription on a broker. Subscription objects are returned as results from SubscriptionProxy queries.

com.ibm.broker.config.proxy.Subscription

Responsibilities Represents a single read-only entry from the Subscription table.
Internal Collaborators None

 Change Activity:
 -------- ----------- -------------   ------------------------------------
 Reason:  Date:       Originator:     Comments:
 -------- ----------- -------------   ------------------------------------
 25103.1  2004-04-22  HDMPL           v6 Release
 
 


Method Summary
 void delete(SubscriptionsProxy owningProxy)
          Asks the Configuration Manager to delete the supplied subscription.
 String getBroker()
          Returns the broker field for the current subscription
 String getClient()
          Returns the client field for the current subscription
 String getFilter()
          Returns the filter field for the current subscription
 Date getRegistrationDate()
          Returns the registration date for the current subscription
static Subscription getSubscriptionFromString(String encodedData)
          Returns a new Subscription object that contains the information described in the encoded String.
 String getSubscriptionPoint()
          Returns the subscription point field for the current subscription
 String getTopicName()
          Returns the topicname field for the current subscription
 String getUser()
          Returns the user field for the current subscription
 String toString()
          Displays information on the subscription (for trace)
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getTopicName

public String getTopicName()
Returns the topicname field for the current subscription

Returns:
String Translated topicname field

getUser

public String getUser()
Returns the user field for the current subscription

Returns:
String user field

getSubscriptionPoint

public String getSubscriptionPoint()
Returns the subscription point field for the current subscription

Returns:
String subscription point field

getRegistrationDate

public Date getRegistrationDate()
Returns the registration date for the current subscription

Returns:
Date registration date field

getClient

public String getClient()
Returns the client field for the current subscription

Returns:
String client field

getFilter

public String getFilter()
Returns the filter field for the current subscription

Returns:
String filter field

getBroker

public String getBroker()
Returns the broker field for the current subscription

Returns:
String broker field

delete

public void delete(SubscriptionsProxy owningProxy)
            throws ConfigManagerProxyLoggedException
Asks the Configuration Manager to delete the supplied subscription.

Note: Any response message from the Config Manager resulting from this method will be sent to listeners of the ConfigManagerProxy object, because Subscriptions and SubscriptionsProxies cannot have AdministeredObjectListeners.

Parameters:
owningProxy - Proxy that can be used to route the delete request to the Config Manager.
Throws:
ConfigManagerProxyLoggedException - If the request could not be sent to the Configuration Manager.

getSubscriptionFromString

public static Subscription getSubscriptionFromString(String encodedData)
Returns a new Subscription object that contains the information described in the encoded String.

Parameters:
encodedData - String encoded in the format used by the SubscriptionsProxy.
Returns:
Subscription Representation of the input string

toString

public String toString()
Displays information on the subscription (for trace)

Returns:
String The format is not guaranteed

WBI BrokersTM
Config Manager Proxy API