java.lang.Object com.ibm.broker.config.proxy.LogEntry
public class LogEntry
extends Object
The LogEntry class represents an entry in the broker message log table.
com.ibm.broker.config.proxy.LogEntry
|
|
Responsibilities | Represents a single read-only entry from the Log table. |
Internal Collaborators | None |
Change Activity: -------- ----------- ------------- ------------------------------------ Reason: Date: Originator: Comments: -------- ----------- ------------- ------------------------------------ 25103.1 2004-03-22 HDMPL v6 Release
Method | Description |
---|---|
String getDetail() | Returns the detail field for the current log entry |
String getInsert(int) | Returns the insert with the supplied number. |
int getInsertsSize() | Returns the number of available inserts for the current log entry. |
LogEntry getLogEntryFromString(String) | Returns a new LogEntry object that contains the information described in the encoded String. |
String getMessage() | Returns the message field for the current log entry |
int getMessageNumber() | Returns the BIP message number for the current log entry. |
String getSource() | Returns the source field for the current log entry |
Date getTimestamp() | Returns the timestamp for the current log entry |
boolean isErrorMessage() | Returns true if and only if the BIP message number indicates an error (that is, if the 8th character in the detail field is 'E' or 'S'). |
void setMessageCatalogEclipsePluginName(String) | Asks the Configuration Manager Proxy to attempt to load the message catalog from the Eclipse plugin with the supplied name. |
void setMessageCatalogName(String) | Sets the name of the message catalog from which localized BIP messages are loaded. |
String toString() | Displays information on the log entry (for trace) |
public String getDetail()Returns the detail field for the current log entry
- Returns
- String - detail field
public String getInsert(int elementNumber)Returns the insert with the supplied number. The first element is element 0.
- Parameters
- elementNumber -
- Returns
- String The insert at the supplied position, or null if the insert could not be found.
public int getInsertsSize()Returns the number of available inserts for the current log entry.
- Returns
- int the number of available inserts.
public static LogEntry getLogEntryFromString(String encodedData)Returns a new LogEntry object that contains the information described in the encoded String. If the encodedData does not represent a valid log message, null is returned.
- Parameters
- encodedData - String as stored in the relevant attribute of the LogProxy.
public String getMessage()Returns the message field for the current log entry
- Returns
- String - message field
public int getMessageNumber()Returns the BIP message number for the current log entry. If the message number is not available, -1 is returned.
- Returns
- int BIP message number
public String getSource()Returns the source field for the current log entry
- Returns
- String - source field
public Date getTimestamp()Returns the timestamp for the current log entry
- Returns
- Date the timestamp if it is available for this LogEntry. If the timestamp is not available, the returned value will be null.
public boolean isErrorMessage()Returns true if and only if the BIP message number indicates an error (that is, if the 8th character in the detail field is 'E' or 'S').
- Returns
- boolean true if the message indicates an error
public static void setMessageCatalogEclipsePluginName(String pluginName)Asks the Configuration Manager Proxy to attempt to load the message catalog from the Eclipse plugin with the supplied name. Called outside of an Eclipse plugin environment (that is, if the org.eclipse.core.runtime.Platform class is not available), this method will have no effect. If the message catalogs could not be loaded from the supplied plugin, then the Configuration Manager Proxy will attempt to load the message catalog from the CLASSPATH instead (following the standard rules for loading ResourceBundle objects). After calling this method, the catalog will be loaded the next time message text is required.
- Parameters
- pluginName - Name of the plugin that contains the message catalog. The default is "com.ibm.etools.mft.config".
public static void setMessageCatalogName(String catalogName)Sets the name of the message catalog from which localized BIP messages are loaded. After calling this method, the catalog will be reloaded the next time message text is required.
- Parameters
- catalogName - Name of the message catalog to use. The default is "BIPv600".
public String toString()Displays information on the log entry (for trace)