java.lang.Object com.ibm.broker.config.proxy.AdministeredObject com.ibm.broker.config.proxy.LogProxy
public class LogProxy
extends AdministeredObject
The LogProxy represents the selection of broker log entries for the current user.
In order to use LogProxy 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); LogProxy l = cmp.getLog();
com.ibm.broker.config.proxy.LogProxy extends
com.ibm.broker.config.proxy.AdministeredObject
|
|
Responsibilities | Represents a collection of Log Entries. |
Internal Collaborators | com.ibm.broker.config.proxy.LogEntry |
Change Activity: -------- ----------- ------------- ------------------------------------ Reason: Date: Originator: Comments: -------- ----------- ------------- ------------------------------------ 25103.1 2004-03-29 HDMPL v6 Release
Method | Description |
---|---|
void clear() | Removes all log entries associated with this LogProxy (that is, clears the log of all of this user's messages). |
Enumeration 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) | Returns the LogEntry at the supplied position in the log, |
String getName() | Returns the name of the object |
int getSize() | Returns the number of LogEntry objects available to the user. |
String toString() | Displays the type and UUID of the current object (or the name if it is available). |
public void clear() throws ConfigManagerProxyLoggedExceptionRemoves all log entries associated with this LogProxy (that is, clears the log of all of this user's messages).
- Throws
ConfigManagerProxyLoggedException
if the request to clear the log could not be sent to the Configuration Manager.
public Enumeration elements() throws ConfigManagerProxyPropertyNotInitializedExceptionReturns an Enumeration of all LogEntry objects available to the user in the log.
- Returns
- Enumeration of available LogEntry objects
- Throws
ConfigManagerProxyPropertyNotInitializedException
if the requested property is not yet known.
public ConfigurationObjectType getConfigurationObjectType()Returns the ConfigurationObjectType associated with this AdministeredObject type.
- Returns
- ConfigurationObjectType associated with this class.
- Overrides
public ConfigurationObjectType getConfigurationObjectTypeOfParent()Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject type.
- Returns
- ConfigurationObjectType associated with the logical parent of this class.
- Overrides
public synchronized LogEntry getLogEntry(int position) throws ArrayIndexOutOfBoundsException, ConfigManagerProxyPropertyNotInitializedExceptionReturns the LogEntry at the supplied position in the log,
- Parameters
- position - Number of the LogEntry to return. The minimum value is 1, the maximum value is determined by getSize().
- Returns
- LogEntry 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.- Throws
ConfigManagerProxyPropertyNotInitializedException
if the requested property is not yet known.
public String getName() throws ConfigManagerProxyPropertyNotInitializedExceptionReturns the name of the object
- Returns
- String name of the current object.
- Throws
ConfigManagerProxyPropertyNotInitializedException
if the property could not be determined because the Config Manager has not yet supplied the relevant information.- Overrides
- getName in class AdministeredObject
public int getSize() throws ConfigManagerProxyPropertyNotInitializedExceptionReturns the number of LogEntry objects available to the user.
- Returns
- int Number of LogEntry objects viewable in the log
- Throws
ConfigManagerProxyPropertyNotInitializedException
if the requested property is not yet known.
public String toString()Displays the type and UUID of the current object (or the name if it is available). The format is not guaranteed, and therefore should not be parsed programatically.
- Returns
- String Representation of the current object
- Overrides
- toString in class AdministeredObject