Class Hierarchy All Classes All Fields and Methods

Class com.ibm.broker.config.proxy.SubscriptionsProxy

java.lang.Object
        com.ibm.broker.config.proxy.AdministeredObject
                com.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 Configuration 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 Index
Method Description
void addAccessControlEntries(AccessControlEntry[]) Adds this list to the list of access control entries that applies to this object.
void deleteSubscriptions(Subscription[]) 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.
AccessControlEntry[] getAccessControlEntries() Creates and returns a set of AccessControlEntry objects that describes the set of (principal,permission) tuples that have been applied specifically to this object.
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) Returns the Subscription at the supplied position in the list.
void removeAccessControlEntries(AccessControlEntry[]) Deletes this list from the list of access control entries that applies to this object.
void setAccessControlEntries(AccessControlEntry[]) Sets the complete list of access control entries that apply to this object.

Methods

addAccessControlEntries

public void addAccessControlEntries(AccessControlEntry[] accessControlList) throws ConfigManagerProxyLoggedException

Adds this list to the list of access control entries that applies to this object. Null elements in the array are ignored.

This operation is completely transactional. If the Configuration Manager successfully processes this request, all access control entries from the supplied array will be associated with this administered object. If not, the access control list for this object will have not been modified.

If the Configuration Manager to which the Configuration Manager Proxy is connected is of a version less than v6, this method will have no effect.

deleteSubscriptions

public void deleteSubscriptions(Subscription[] subs) throws ConfigManagerProxyLoggedException

Asks the Configuration Manager to delete the supplied subscriptions.

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

elements

public Enumeration elements() throws ConfigManagerProxyPropertyNotInitializedException

Returns an Enumeration of all Subscription objects available to the user that match this query.

getAccessControlEntries

public AccessControlEntry[] getAccessControlEntries() 

Creates and returns a set of AccessControlEntry objects that describes the set of (principal,permission) tuples that have been applied specifically to this object.

This method does not return details of permissions that have been implicitly granted by inherited access control entries.

getConfigurationObjectType

public ConfigurationObjectType getConfigurationObjectType() 

Returns the ConfigurationObjectType associated with this AdministeredObject type.

getConfigurationObjectTypeOfParent

public ConfigurationObjectType getConfigurationObjectTypeOfParent() 

Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject type.

getSize

public int getSize() throws ConfigManagerProxyPropertyNotInitializedException

Returns the number of Subscription objects available to the user.

getSubscription

public synchronized Subscription getSubscription(int position) throws ArrayIndexOutOfBoundsException, ConfigManagerProxyPropertyNotInitializedException

Returns the Subscription at the supplied position in the list.

removeAccessControlEntries

public void removeAccessControlEntries(AccessControlEntry[] accessControlList) throws ConfigManagerProxyLoggedException

Deletes this list from the list of access control entries that applies to this object. Null elements in the array are ignored. In addition, if any elements of the array are not associated with the administered object, they will be ignored.

This operation is completely transactional. If the Configuration Manager successfully processes this request, no access control entries from the supplied array will be associated with this administered object. If not, the access control list for this object will have not been modified.

If the Configuration Manager to which the Configuration Manager Proxy is connected is of a version less than v6, this method will have no effect.

setAccessControlEntries

public void setAccessControlEntries(AccessControlEntry[] accessControlList) throws ConfigManagerProxyLoggedException

Sets the complete list of access control entries that apply to this object. Null elements in the array are ignored. If the array itself is null or empty, all access control entries for this object are removed.

This method submits only changed access control entries to the Configuration Manager. It converts the supplied array into a set of access control entries to add and a set of access control entries to remove, based on the information currently supplied from the Configuration Manager. The add and remove operations are processed separately by the Configuration Manager as two atomic, transactional requests.

If the Configuration Manager to which the Configuration Manager Proxy is connected is of a version less than v6, this method will have no effect.

Class Hierarchy All Classes All Fields and Methods