com.ibm.broker.config.proxy

Class AdminQueueProxy

java.lang.Object

com.ibm.broker.config.proxy.AdministeredObject

com.ibm.broker.config.proxy.AdminQueueProxy

public class AdminQueueProxy
extends AdministeredObject

The AdminQueueProxy represents the set of administration queue entries for the broker.

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

     BrokerConnectionParameters bcp =
         new MQBrokerConnectionParameters("localhost", 1414, "QMGR");
     BrokerProxy b = BrokerProxy.getInstance(bcp);
     AdminQueueProxy l = b.getAdminQueueProxy();
 

com.ibm.broker.config.proxy.AdminQueueProxy extends com.ibm.broker.config.proxy.AdministeredObject
Responsibilities	Represents a collection of AdminQueueEntry objects.
Internal Collaborators	com.ibm.broker.config.proxy.AdminQueueEntry

 Change Activity:
 --------   ----------- -------------   ------------------------------------
 Reason:    Date:       Originator:     Comments:
 --------   ----------- -------------   ------------------------------------
 51619.40   2009-05-26  HDCAB           v7 Release

 

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel(AdminQueueEntry anAdminQueueEntry) Removes the administration queue entry from the administration queue.
void	cancel(java.lang.String workIdentifier) Removes the administration queue entry from the administration queue that matches the work identifier.
java.util.Enumeration<AdminQueueEntry>	elements() Returns an Enumeration of all AdminQueueEntry objects available to the user in the Administration Queue.
AdminQueueEntry	getAdminQueueEntry(int position) Returns the AdminQueueEntry at the supplied position in the Administration Queue.
AdminQueueEntry	getAdminQueueEntryByUUID(java.lang.String workIdentifier) Returns the AdminQueueEntry with the specified work identifier.
ConfigurationObjectType	getConfigurationObjectType() Returns the ConfigurationObjectType associated with this AdministeredObject type.
ConfigurationObjectType	getConfigurationObjectTypeOfParent() Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject type.
java.lang.String	getName() Returns the name of the object
int	getSize() Returns the number of available AdminQueueEntry objects.
void	setLongDescription(java.lang.String desc) This method overrides the base class implementation, so that an exception is thrown if this method is invoked against this class.
void	setName(java.lang.String name) This method overrides the base class implementation, so that an exception is thrown if this method is invoked against this class.
void	setProperties(java.util.Properties suppliedProps) This method overrides the base class implementation, so that an exception is thrown if this method is invoked against this class.
void	setShortDescription(java.lang.String desc) This method overrides the base class implementation, so that an exception is thrown if this method is invoked against this class.
java.lang.String	toString() Displays the name of the current object (or type and UUID the name if it is available).
static java.util.Properties	withName(java.lang.String name) Returns a new Properties object that has the Name attribute set to the supplied String, and the type attribute to be the name of the subclass of AdministeredObject being used.
static java.util.Properties	withUUID(java.lang.String uuid) Returns a new Properties object that has the UUID attribute set to the supplied String, and the type attribute to be the name of the subclass of AdministeredObject being used.

Methods inherited from class com.ibm.broker.config.proxy.AdministeredObject

deregisterListener, deregisterListener, elements, equals, getAdvancedProperties, getBasicProperties, getLastBIPMessages, getLastCompletionCode, getLastUpdateUser, getLongDescription, getManagedSubcomponent, getManagedSubcomponentFromStringRepresentation, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponentsAsStrings, getManagedSubcomponentsAsStrings, getNumberOfSubcomponents, getParent, getProperties, getProperty, getProperty, getProperty, getProperty, getRepositoryTimestamp, getShortDescription, getTimeOfLastCompletionCode, getTimeOfLastUpdate, getType, getUUID, hasBeenPopulatedByBroker, hasBeenPopulatedByBroker, hasBeenRestrictedByBroker, hasBeenRestrictedByBroker, hasBeenRestrictedByConfigManager, hasBeenRestrictedByConfigManager, hasBeenUpdatedByConfigManager, hasBeenUpdatedByConfigManager, isAwaitingSubmissionForCreation, isAwaitingSubmissionForDeletion, isDeployed, isShared, refresh, registerListener, registerListener, registerListener, toVerboseString, unsubscribeFromConfigurationManagerUpdates

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getSize

public int getSize()
            throws ConfigManagerProxyPropertyNotInitializedException

Returns the number of available AdminQueueEntry objects.

Returns:

int Number of AdminQueueEntry objects viewable in the AdminQueueProxy.

Throws:

ConfigManagerProxyPropertyNotInitializedException - if the size of the administration queue could not be determined because the information was not supplied from the broker before a timeout occurred.

getAdminQueueEntry

public AdminQueueEntry getAdminQueueEntry(int position)
                                   throws java.lang.ArrayIndexOutOfBoundsException,
                                          ConfigManagerProxyPropertyNotInitializedException

Returns the AdminQueueEntry at the supplied position in the Administration Queue. The AdminQueueEntry returned represents the status of an administration queue entry at the point in time it is retrieved. To get an updated version of an AdminQueueEntry this method should be used again to return a new instance of the AdminQueueEntry.

Parameters:

position - Number of the AdminQueueEntry to return. The minimum value is 1, the maximum value is determined by getSize().

Returns:

AdminQueueEntry The entry at the given element

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the value of the supplied position is less than one or greater than the number of viewable entries.

ConfigManagerProxyPropertyNotInitializedException - if the value of the AdminQueueEntry could not be determined because the information was not supplied from the broker before a timeout occurred.

getAdminQueueEntryByUUID

public AdminQueueEntry getAdminQueueEntryByUUID(java.lang.String workIdentifier)
                                         throws ConfigManagerProxyPropertyNotInitializedException

Returns the AdminQueueEntry with the specified work identifier.

Parameters:

workIdentifier - The identifier of the AdminQueueEntry

Returns:

AdminQueueEntry The entry with the specified work identifier or null if the entry could not be found.

Throws:

ConfigManagerProxyPropertyNotInitializedException - if the value of the AdminQueueEntry could not be determined because the information was not supplied from the broker before a timeout occurred.

elements

public java.util.Enumeration<AdminQueueEntry> elements()
                                                throws ConfigManagerProxyPropertyNotInitializedException

Returns an Enumeration of all AdminQueueEntry objects available to the user in the Administration Queue.

Returns:

Enumeration of available AdminQueueEntry objects

Throws:

ConfigManagerProxyPropertyNotInitializedException - if the administration queue elements could not be determined because the information was not supplied from the broker before a timeout occurred.

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.

getName

public java.lang.String getName()
                         throws ConfigManagerProxyPropertyNotInitializedException

Returns the name of the object

Overrides:

getName in class AdministeredObject

Returns:

String name of the current object.

Throws:

ConfigManagerProxyPropertyNotInitializedException - if the name could not be determined because the information was not supplied from the broker before a timeout occurred.

toString

public java.lang.String toString()

Displays the name of the current object (or type and UUID the name if it is available). The format is not guaranteed, and therefore should not be parsed programatically.

Overrides:

toString in class AdministeredObject

Returns:

String Representation of the current object

cancel

public void cancel(java.lang.String workIdentifier)
            throws ConfigManagerProxyLoggedException

Removes the administration queue entry from the administration queue that matches the work identifier.

Throws:

ConfigManagerProxyLoggedException - if the work identifier is not valid. If an AdminQueueEntry cannot be matched to the work identifier or the AdminQueueEntry has a state such that it cannot be cancelled, the cancel request will be ignored.

cancel

public void cancel(AdminQueueEntry anAdminQueueEntry)
            throws ConfigManagerProxyLoggedException

Removes the administration queue entry from the administration queue.

Throws:

ConfigManagerProxyLoggedException - if the AdminQueueEntry is null. If the AdminQueueEntry has a state such that it cannot be cancelled, the cancel request will be ignored.

setName

public void setName(java.lang.String name)
             throws ConfigManagerProxyLoggedException

This method overrides the base class implementation, so that an exception is thrown if this method is invoked against this class. It is not possible to change the name of the admininistration queue.

Overrides:

setName in class AdministeredObject

Parameters:

name - (this is ignored)

Throws:

ConfigManagerProxyLoggedException - to indicate this method should not be called.

setShortDescription

public void setShortDescription(java.lang.String desc)
                         throws ConfigManagerProxyLoggedException

This method overrides the base class implementation, so that an exception is thrown if this method is invoked against this class. It is not possible to change the short description of the admininistration queue.

Overrides:

setShortDescription in class AdministeredObject

Parameters:

desc - (this is ignored)

Throws:

ConfigManagerProxyLoggedException - to indicate this method should not be called.

setLongDescription

public void setLongDescription(java.lang.String desc)
                        throws ConfigManagerProxyLoggedException

This method overrides the base class implementation, so that an exception is thrown if this method is invoked against this class. It is not possible to change the long description of the admininistration queue.

Overrides:

setLongDescription in class AdministeredObject

Parameters:

desc - (this is ignored)

Throws:

ConfigManagerProxyLoggedException - to indicate this method should not be called.

setProperties

public void setProperties(java.util.Properties suppliedProps)
                   throws ConfigManagerProxyLoggedException

This method overrides the base class implementation, so that an exception is thrown if this method is invoked against this class. It is not possible to change the properties of the admininistration queue.

Overrides:

setProperties in class AdministeredObject

Parameters:

suppliedProps - (this is ignored)

Throws:

ConfigManagerProxyLoggedException - to indicate this method should not be called.

withUUID

public static java.util.Properties withUUID(java.lang.String uuid)

Returns a new Properties object that has the UUID attribute set to the supplied String, and the type attribute to be the name of the subclass of AdministeredObject being used. This provides an easy way of supplying filters to the get*() methods. For example, broker1.getManagedSubcomponent(ExecutionGroup.withUUID("1234")); will return the Execution Group with UUID "1234" that exists in broker1.

Returns:

java.util.Properties a new Properties object with the relevant key/value pairs set.

withName

public static java.util.Properties withName(java.lang.String name)

Returns a new Properties object that has the Name attribute set to the supplied String, and the type attribute to be the name of the subclass of AdministeredObject being used. This provides an easy way of supplying filters to the get*() calls. For example, broker1.getExecutionGroup(ExecutionGroup.withName("eg1")); will return the Execution Group with Name "eg1" that exists in broker1.

Returns:

java.util.Properties - a new Properties object with the relevant key/value pairs set.