Class Hierarchy All Classes All Fields and Methods

Class com.ibm.broker.config.proxy.LogEntry

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 Index
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)

Methods

getDetail

public String getDetail() 

Returns the detail field for the current log entry

getInsert

public String getInsert(int elementNumber) 

Returns the insert with the supplied number. The first element is element 0.

getInsertsSize

public int getInsertsSize() 

Returns the number of available inserts for the current log entry.

getLogEntryFromString

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.

getMessage

public String getMessage() 

Returns the message field for the current log entry

getMessageNumber

public int getMessageNumber() 

Returns the BIP message number for the current log entry. If the message number is not available, -1 is returned.

getSource

public String getSource() 

Returns the source field for the current log entry

getTimestamp

public Date getTimestamp() 

Returns the timestamp for the current log entry

isErrorMessage

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').

setMessageCatalogEclipsePluginName

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.

setMessageCatalogName

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.

toString

public String toString() 

Displays information on the log entry (for trace)

Class Hierarchy All Classes All Fields and Methods