WBI BrokersTM
Config Manager Proxy API

com.ibm.broker.config.proxy
Class SubscriptionsProxy

java.lang.Object
  extended bycom.ibm.broker.config.proxy.AdministeredObject
      extended bycom.ibm.broker.config.proxy.SubscriptionsProxy

public class SubscriptionsProxy
extends AdministeredObject

Represents a query of the Configuration Manager's broker subscriptions table, and the results.

In order to use SubscriptionsProxy objects, applications must first obtain handles to them. Here is an example of how to do this:

     ConfigManagerConnectionParameters cmcp =
         new MQConfigManagerConnectionParameters("localhost", 1414, "QMGR");
     ConfigManagerProxy cmp = ConfigManagerProxy.getInstance(cmcp);
 
     String topics = null;                            // all topics
     String brokers = "BROKER%";                      // all brokers beginning 'BROKER'
     String users = null;                             // all users
     String subsPoints = null;                        // all subscriptions points
     GregorianCalendar start = null;                  // no start date
     GregorianCalendar end = new GregorianCalendar(); // to the present
     SubscriptionsProxy s = cmp.getSubscriptions(topics, brokers,
                                                 users, subsPoints,
                                                 start, end);
 
Each ConfigManagerProxy can have multiple subscriptions queries active.

Note: Once a SubscriptionsProxy is populated with the results of a query (that is, when hasBeenUpdatedByConfigManager() returns true) - the object will receive no further updates from the Configuration Manager. This means that, even if the set of active subscriptions changes, the SubscriptionsProxy returned will only reflect the state of the subscriptions table at the point the query was made. Applications must call ConfigManagerProxy.getSubscriptions() again in order to receive updated information.

com.ibm.broker.config.proxy.SubscriptionsProxy extends com.ibm.broker.config.proxy.AdministeredObject

Responsibilities Represents an SQL query of the Config Manager's Subscriptions table and its results.
Internal Collaborators None

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

 


Method Summary
 void deleteSubscriptions(Subscription[] subs)
          Asks the Configuration Manager to delete the supplied subscriptions.
 Enumeration elements()
          Returns an Enumeration of all Subscription objects available to the user that match this query.
 ConfigurationObjectType getConfigurationObjectType()
          Returns the ConfigurationObjectType associated with this AdministeredObject type.
 ConfigurationObjectType getConfigurationObjectTypeOfParent()
          Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject type.
 int getSize()
          Returns the number of Subscription objects available to the user.
 Subscription getSubscription(int position)
          Returns the Subscription at the supplied position in the list.
 
Methods inherited from class com.ibm.broker.config.proxy.AdministeredObject
deregisterListener, deregisterListener, elements, getAccessControlEntries, getLastBIPMessages, getLastCompletionCode, getLastUpdateUser, getLongDescription, getManagedSubcomponent, getManagedSubcomponentFromStringRepresentation, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponents, getName, getNumberOfSubcomponents, getParent, getPredictedNewSubcomponents, getProperties, getProperty, getProperty, getProperty, getProperty, getRepositoryTimestamp, getShortDescription, getTimeOfLastCompletionCode, getTimeOfLastUpdate, getType, getUUID, hasBeenRestrictedByConfigManager, hasBeenRestrictedByConfigManager, hasBeenUpdatedByConfigManager, hasBeenUpdatedByConfigManager, isAwaitingSubmissionForCreation, isDeployed, isShared, refresh, registerListener, registerListener, registerListener, setAccessControlEntries, setLongDescription, setName, setProperties, setShortDescription, toString, toVerboseString, unsubscribeFromConfigurationManagerUpdates, withName, withUUID
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getSize

public int getSize()
            throws ConfigManagerProxyPropertyNotInitializedException
Returns the number of Subscription objects available to the user.

Returns:
int Number of Subscription objects viewable.
Throws:
ConfigManagerProxyPropertyNotInitializedException - if the requested property is not yet known.

getSubscription

public Subscription getSubscription(int position)
                             throws ArrayIndexOutOfBoundsException,
                                    ConfigManagerProxyPropertyNotInitializedException
Returns the Subscription at the supplied position in the list.

Parameters:
position - Number of the Subscription to return. The first entry in the SubscriptionProxy is at position 1.
Returns:
Subscription The entry at the given element
Throws:
ArrayIndexOutOfBoundsException - if the value of the supplied position is less than one or greater than the number of viewable entries.
ConfigManagerProxyPropertyNotInitializedException - if the requested property is not yet known.

deleteSubscriptions

public void deleteSubscriptions(Subscription[] subs)
                         throws ConfigManagerProxyLoggedException
Asks the Configuration Manager to delete the supplied subscriptions.

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:
subs - Array of subscription objects to delete.
Throws:
ConfigManagerProxyLoggedException - if the request could not be sent to the Configuration Manager.

elements

public Enumeration elements()
                     throws ConfigManagerProxyPropertyNotInitializedException
Returns an Enumeration of all Subscription objects available to the user that match this query.

Returns:
Enumeration of available Subscription objects
Throws:
ConfigManagerProxyPropertyNotInitializedException - if the requested property is not yet known.

getConfigurationObjectType

public ConfigurationObjectType getConfigurationObjectType()
Returns the ConfigurationObjectType associated with this AdministeredObject type.

Specified by:
getConfigurationObjectType in class AdministeredObject
Returns:
ConfigurationObjectType associated with this class.

getConfigurationObjectTypeOfParent

public ConfigurationObjectType getConfigurationObjectTypeOfParent()
Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject type.

Specified by:
getConfigurationObjectTypeOfParent in class AdministeredObject
Returns:
ConfigurationObjectType associated with the logical parent of this class.

WBI BrokersTM
Config Manager Proxy API