com.ibm.broker.config.proxy

Class ActivityLogEntry

  • java.lang.Object
    • com.ibm.broker.config.proxy.ActivityLogEntry


  • public class ActivityLogEntry
    extends java.lang.Object

    The ActivityLogEntry class represents an entry in a broker activity log.

    com.ibm.broker.config.proxy.ActivityLogEntry

    Responsibilities Represents a single read-only entry from an Activity Log.
    Internal Collaborators None
    
     Change Activity:
     -------- ----------- -------------   ------------------------------------
     Reason:  Date:       Originator:     Comments:
     -------- ----------- -------------   ------------------------------------
     80006.2  2011-04-15  HDCAB           v8 Release
     
     
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      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 ActivityLogEntry getLogEntryFromString(java.lang.String encodedData)
      Returns a new ActivityLogEntry 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.Enumeration<java.lang.String> getTagNames()
      Returns an enumeration of the tag names for the current log entry.
      int getTagsSize()
      Returns the number of available tags for the current log entry.
      java.lang.String getTagValue(java.lang.String tagName)
      Returns the value of a specific tag.
      java.lang.String getThreadIdentifier()
      Returns the thread identifier field for the current log entry
      java.lang.String getThreadSequenceNumber()
      Returns the thread sequence number 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.
      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)
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Method Detail

      • getMessage

        public java.lang.String getMessage()
        Returns the message field for the current log entry
        Returns:
        String message field
      • getMessageNumber

        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
      • isErrorMessage

        public boolean isErrorMessage()
        Returns true if and only if the BIP message number indicates an error.
        Returns:
        boolean true if the message indicates an error
      • getDetail

        public java.lang.String getDetail()
        Returns the detail field for the current log entry
        Returns:
        String - detail field
      • getSource

        public java.lang.String getSource()
        Returns the source field for the current log entry
        Returns:
        String - source field
      • getThreadIdentifier

        public java.lang.String getThreadIdentifier()
        Returns the thread identifier field for the current log entry
        Returns:
        String - threadId field
      • getThreadSequenceNumber

        public java.lang.String getThreadSequenceNumber()
        Returns the thread sequence number field for the current log entry
        Returns:
        String - threadSequenceNumber field
      • getTimestamp

        public java.util.Date getTimestamp()
        Returns the timestamp for the current log entry. The returned Date object describes the date and time that the entry was written to the log, according to the clock on the broker machine.
        Returns:
        Date the timestamp if it is available for this ActivityLogEntry. If the timestamp is not available, the returned value will be null.
      • toString

        public java.lang.String toString()
        Displays information on the log entry (for trace)
        Overrides:
        toString in class java.lang.Object
      • getInsert

        public java.lang.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.
      • getInsertsSize

        public int getInsertsSize()
        Returns the number of available inserts for the current log entry.
        Returns:
        int the number of available inserts.
      • getTagsSize

        public int getTagsSize()
        Returns the number of available tags for the current log entry.
        Returns:
        int the number of available tags.
      • getTagNames

        public java.util.Enumeration<java.lang.String> getTagNames()
        Returns an enumeration of the tag names for the current log entry.
        Returns:
        Enumeration an Enumeration of the tag names
      • getTagValue

        public java.lang.String getTagValue(java.lang.String tagName)
        Returns the value of a specific tag.
        Returns:
        String the value of a specific tag.
      • getLogEntryFromString

        public static ActivityLogEntry getLogEntryFromString(java.lang.String encodedData)
        Returns a new ActivityLogEntry object that contains the information described in the encoded String. If the encodedData does not represent a valid activity log message, null is returned.
        Parameters:
        encodedData - String as stored in the relevant attribute of the ActivityLogProxy.
      • setMessageCatalogEclipsePluginName

        public 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. 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 IBM Integration API (CMP) 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".
      • setMessageCatalogName

        public static void setMessageCatalogName(java.lang.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 "BIPmsgs".