public class LogEntry
extends java.lang.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 47371 2007-07-30 HDMPL v6.1 Release: Updated to use V6.1 catalog Missing catalog now reports correct BIP rather than BIP9304/BIP9305 51619.8 2008-12-16 HDMPL v7 Release: Updated to use new catalog
Modifier and Type | Field and Description |
---|---|
protected static java.lang.String |
ATTR_BIPNUMBER
When supplied as an attribute name in a Response,
this states that the associated value is the log entry's message.
|
protected static java.lang.String |
ATTR_INSERT
When supplied as an attribute name in a Response,
this states that the associated value is an insert.
|
protected static java.lang.String |
ATTR_LAST_INSERT
When supplied as an attribute name in a Response,
this states that the associated value is the number of inserts that
have been supplied.
|
protected static java.lang.String |
ATTR_SOURCE
When supplied as an attribute name in a Response,
this states that the associated value is the log entry's source.
|
protected static java.lang.String |
ATTR_TIMESTAMP
When supplied as an attribute name in a Response,
this states that the associated value is the log entry's timestamp.
|
protected static java.lang.String |
copyright
IBM Copyright
|
protected static java.lang.String |
messageCatalogName
The name of the resource bundle that contains the BIP messages.
|
protected static java.lang.String |
sccsid
Version information
|
Modifier | Constructor and Description |
---|---|
protected |
LogEntry(java.lang.String bip,
java.util.Vector<java.lang.String> inserts,
java.lang.String source,
java.lang.String timestamp)
The LogEntry class is only ever instantiated by the LogProxy.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getDetail()
Returns the detail field for the current log entry
|
java.lang.String |
getInsert(int elementNumber)
Returns the insert with the supplied number.
|
int |
getInsertsSize()
Returns the number of available inserts for
the current log entry.
|
static LogEntry |
getLogEntryFromString(java.lang.String encodedData)
Returns a new LogEntry object that contains the
information described in the encoded String.
|
java.lang.String |
getMessage()
Returns the message field for the current log entry
|
int |
getMessageNumber()
Returns the BIP message number for the current log entry.
|
java.lang.String |
getSource()
Returns the source field for the current log entry
|
java.util.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').
|
static void |
setMessageCatalogEclipsePluginName(java.lang.String pluginName)
Asks the IBM Integration API (CMP) to attempt to load the
message catalog from the Eclipse plugin with the supplied
name.
|
static void |
setMessageCatalogName(java.lang.String catalogName)
Sets the name of the message catalog from which localized
BIP messages are loaded.
|
java.lang.String |
toString()
Displays information on the log entry (for trace)
|
protected static final java.lang.String copyright
protected static final java.lang.String sccsid
protected static final java.lang.String ATTR_BIPNUMBER
protected static final java.lang.String ATTR_INSERT
protected static final java.lang.String ATTR_LAST_INSERT
protected static final java.lang.String ATTR_SOURCE
protected static final java.lang.String ATTR_TIMESTAMP
protected static java.lang.String messageCatalogName
protected LogEntry(java.lang.String bip, java.util.Vector<java.lang.String> inserts, java.lang.String source, java.lang.String timestamp)
bip
- String containing the BIP number (e.g. "1214")inserts
- Strings to be inserted into the translated entry.source
- of the log entry.timestamp
- of the log entry.public java.lang.String getMessage()
public int getMessageNumber()
public boolean isErrorMessage()
public java.lang.String getDetail()
public java.lang.String getSource()
public java.util.Date getTimestamp()
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getInsert(int elementNumber)
elementNumber
- public int getInsertsSize()
public static LogEntry getLogEntryFromString(java.lang.String encodedData)
encodedData
- String as stored in the
relevant attribute of the LogProxy.public static void setMessageCatalogEclipsePluginName(java.lang.String pluginName)
pluginName
- Name of the plugin that contains
the message catalog. The default is "com.ibm.etools.mft.config".public static void setMessageCatalogName(java.lang.String catalogName)
catalogName
- Name of the message catalog to use. The
default is "BIPmsgs".