com.ibm.broker.config.proxy

Class ActivityLogProxy

java.lang.Object

com.ibm.broker.config.proxy.AdministeredObject

com.ibm.broker.config.proxy.ActivityLogProxy

public class ActivityLogProxy
extends AdministeredObject

The ActivityLogProxy represents the set of activity log entries for broker objects.

In order to use ActivityLogProxy 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);
     ExecutionGroupProxy eg = b.getExecutionGroupByName("default");
     ActivityLogProxy alp = eg.getActivityLog();
 

com.ibm.broker.config.proxy.ActivityLogProxy extends com.ibm.broker.config.proxy.AdministeredObject
Responsibilities	Represents a broker objects activity log.
Internal Collaborators	com.ibm.broker.config.proxy.ActivityLogEntry

 Change Activity:
 --------   ----------- -------------   ------------------------------------
 Reason:    Date:       Originator:     Comments:
 --------   ----------- -------------   ------------------------------------
 80006.2    2011-04-15  HDCAB           v8 Release

 

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Enumeration<ActivityLogEntry>	elements() Returns an Enumeration of all ActivityLogEntry objects available to the user in the log.
ConfigurationObjectType	getConfigurationObjectType() Returns the ConfigurationObjectType associated with this AdministeredObject type.
ConfigurationObjectType	getConfigurationObjectTypeOfParent() Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject type.
ActivityLogEntry	getLogEntry(int position) Returns the ActivityLogEntry at the supplied position in the activity log,
java.lang.String	getName() Returns the name of the object
int	getSize() Returns the number of available ActivityLogEntry objects.
boolean	hasBeenPopulatedByBroker() Returns true if and only if this object handle has received at least one update publication from the connected broker.
boolean	hasBeenPopulatedByBroker(boolean waitIfNotUpdated) Returns true if and only if this object handle has received at least one update publication from the connected broker.
java.lang.String	toString() Displays the name of the current object (or type and UUID the name if it is available).

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, hasBeenRestrictedByBroker, hasBeenRestrictedByBroker, hasBeenRestrictedByConfigManager, hasBeenRestrictedByConfigManager, hasBeenUpdatedByConfigManager, hasBeenUpdatedByConfigManager, isAwaitingSubmissionForCreation, isAwaitingSubmissionForDeletion, isDeployed, isShared, refresh, registerListener, registerListener, registerListener, setLongDescription, setName, setProperties, setShortDescription, toVerboseString, unsubscribeFromConfigurationManagerUpdates, withName, withUUID

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 ActivityLogEntry objects.

Returns:

int Number of ActivityLogEntry objects viewable in the activity log

Throws:

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

getLogEntry

public ActivityLogEntry getLogEntry(int position)
                             throws java.lang.ArrayIndexOutOfBoundsException,
                                    ConfigManagerProxyPropertyNotInitializedException

Returns the ActivityLogEntry at the supplied position in the activity log,

Parameters:

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

Returns:

ActivityLogEntry 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 ActivityLogEntry could not be determined because the information was not supplied from the broker before a timeout occurred.

elements

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

Returns an Enumeration of all ActivityLogEntry objects available to the user in the log.

Returns:

Enumeration of available ActivityLogEntry objects

Throws:

ConfigManagerProxyPropertyNotInitializedException - if the log 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

hasBeenPopulatedByBroker

public boolean hasBeenPopulatedByBroker()

Returns true if and only if this object handle has received at least one update publication from the connected broker. This call returns immediately. If this method returns false, it means that requests for attributes of this AdministeredObject are likely to cause a pause while the information is discovered.

Overrides:

hasBeenPopulatedByBroker in class AdministeredObject

Returns:

boolean true if the object has had at least one update by the server, false otherwise.

hasBeenPopulatedByBroker

public boolean hasBeenPopulatedByBroker(boolean waitIfNotUpdated)

Returns true if and only if this object handle has received at least one update publication from the connected broker. If no updates have been received, this method optionally waits for the first update to arrive.

Overrides:

hasBeenPopulatedByBroker in class AdministeredObject

Parameters:

waitIfNotUpdated - If set to true, this method will retry for the currently configured timeout period if the object has not been updated. If the object has not been updated after the timeout period has expired, false will be returned.

Returns:

boolean true if the object has had at least one update by the broker, false otherwise.

See Also:

BrokerProxy.setRetryCharacteristics(long)