public class LogProxy extends AdministeredObject
The LogProxy represents the set of administration log entries for the broker.
In order to use LogProxy 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); LogProxy l = b.getLog();
com.ibm.broker.config.proxy.LogProxy extends
com.ibm.broker.config.proxy.AdministeredObject
|
|
Responsibilities | Represents the broker's administration log. |
Internal Collaborators | com.ibm.broker.config.proxy.LogEntry |
Change Activity: -------- ----------- ------------- ------------------------------------ Reason: Date: Originator: Comments: -------- ----------- ------------- ------------------------------------ 25103.1 2004-03-29 HDMPL v6 Release 44739.7 2007-07-30 HDMPL v6.1 Release: Methods now return genericized types where relevant 51619.8 2008-12-16 HDMPL v7 Release: Now accessed through BrokerProxy
Modifier and Type | Method and Description |
---|---|
void |
clear()
Asks the broker to clear the log of all messages.
|
java.util.Enumeration<LogEntry> |
elements()
Returns an Enumeration of all LogEntry 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.
|
LogEntry |
getLogEntry(int position)
Returns the LogEntry at the supplied position in the log,
|
java.lang.String |
getName()
Returns the name of the object
|
int |
getSize()
Returns the number of available LogEntry objects.
|
java.lang.String |
toString()
Displays the name of the current object (or type and UUID
the name if it is available).
|
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, setLongDescription, setName, setProperties, setShortDescription, toVerboseString, unsubscribeFromConfigurationManagerUpdates, withName, withUUID
public int getSize() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the size of the log could not be determined because
the information was not supplied from the broker before a
timeout occurred.public LogEntry getLogEntry(int position) throws java.lang.ArrayIndexOutOfBoundsException, ConfigManagerProxyPropertyNotInitializedException
position
- Number of the LogEntry to return. The
minimum value is 1, the maximum value is determined by
getSize().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 LogEntry could not be determined because
the information was not supplied from the broker before a
timeout occurred.public java.util.Enumeration<LogEntry> elements() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the log elements could not be determined because
the information was not supplied from the broker before a
timeout occurred.public void clear() throws ConfigManagerProxyLoggedException
ConfigManagerProxyLoggedException
- if the request to
clear the log could not be sent to the broker.public ConfigurationObjectType getConfigurationObjectType()
getConfigurationObjectType
in class AdministeredObject
public ConfigurationObjectType getConfigurationObjectTypeOfParent()
getConfigurationObjectTypeOfParent
in class AdministeredObject
public java.lang.String getName() throws ConfigManagerProxyPropertyNotInitializedException
getName
in class AdministeredObject
ConfigManagerProxyPropertyNotInitializedException
- if the name could not be determined because
the information was not supplied from the broker before a
timeout occurred.public java.lang.String toString()
toString
in class AdministeredObject