com.ibm.broker.connector

Class ContainerServices

  • java.lang.Object
    • com.ibm.broker.connector.ContainerServices


  • public class ContainerServices
    extends java.lang.Object
    ContainerServices gives access to key functions provided by the container, such as tracing and logging.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String copyright 
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String containerName()
      The name of the container running the connectors.
      java.lang.String getFileSeparator() 
      java.lang.String getWorkDirectory() 
      void throwMbRecoverableException(java.lang.Exception e)
      Throws an MbRecoverableException based a normal java exception.
      void throwMbRecoverableException(java.lang.String messageKey, java.lang.String[] inserts)
      Throws an MbRecoverableException based on message key and inserts.
      static void writeServiceTraceData(java.lang.String className, java.lang.String methodName, java.lang.String data)
      Writes a piece of data to service trace.
      static void writeServiceTraceEntry(java.lang.String className, java.lang.String methodName, java.lang.String data)
      Writes an entry message to service trace.
      static void writeServiceTraceExit(java.lang.String className, java.lang.String methodName, java.lang.String data)
      Writes an exit message to service trace.
      void writeSystemLogError(java.lang.String messageKey, java.lang.String[] inserts)
      Writes an error message to the system log.
      void writeSystemLogInformation(java.lang.String messageKey, java.lang.String[] inserts)
      Writes an information message to the system log.
      void writeSystemLogWarning(java.lang.String messageKey, java.lang.String[] inserts)
      Writes a warning message to the system log.
      void writeUserTraceDebug(java.lang.String messageKey, java.lang.String[] inserts)
      Writes a debug level message to the user trace.
      void writeUserTraceNormal(java.lang.String messageKey, java.lang.String[] inserts)
      Writes a normal level message to the user trace.
      • Methods inherited from class java.lang.Object

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

      • containerName

        public final java.lang.String containerName()
                                             throws com.ibm.broker.plugin.MbException
        The name of the container running the connectors.
        Throws:
        com.ibm.broker.plugin.MbException
      • writeSystemLogError

        public final void writeSystemLogError(java.lang.String messageKey,
                                              java.lang.String[] inserts)
                                       throws com.ibm.broker.plugin.MbException
        Writes an error message to the system log.
        Parameters:
        messageKey - Message number in the message catalog
        inserts - Message inserts
        Throws:
        com.ibm.broker.plugin.MbException
      • writeSystemLogWarning

        public final void writeSystemLogWarning(java.lang.String messageKey,
                                                java.lang.String[] inserts)
                                         throws com.ibm.broker.plugin.MbException
        Writes a warning message to the system log.
        Parameters:
        messageKey - Message number in the message catalog
        inserts - Message inserts
        Throws:
        com.ibm.broker.plugin.MbException
      • writeSystemLogInformation

        public final void writeSystemLogInformation(java.lang.String messageKey,
                                                    java.lang.String[] inserts)
                                             throws com.ibm.broker.plugin.MbException
        Writes an information message to the system log.
        Parameters:
        messageKey - Message number in the message catalog
        inserts - Message inserts
        Throws:
        com.ibm.broker.plugin.MbException
      • writeUserTraceNormal

        public final void writeUserTraceNormal(java.lang.String messageKey,
                                               java.lang.String[] inserts)
        Writes a normal level message to the user trace.
        Parameters:
        messageKey - Message number in the message catalog
        inserts - Message inserts
        Throws:
        com.ibm.broker.plugin.MbException
      • writeUserTraceDebug

        public final void writeUserTraceDebug(java.lang.String messageKey,
                                              java.lang.String[] inserts)
        Writes a debug level message to the user trace.
        Parameters:
        messageKey - Message number in the message catalog
        inserts - Message inserts
        Throws:
        com.ibm.broker.plugin.MbException
      • writeServiceTraceEntry

        public static final void writeServiceTraceEntry(java.lang.String className,
                                                        java.lang.String methodName,
                                                        java.lang.String data)
        Writes an entry message to service trace.
        Parameters:
        className - The class name to trace entry for
        methodName - The method name to trace entry for
        Throws:
        com.ibm.broker.plugin.MbException
      • writeServiceTraceExit

        public static final void writeServiceTraceExit(java.lang.String className,
                                                       java.lang.String methodName,
                                                       java.lang.String data)
        Writes an exit message to service trace.
        Parameters:
        className - The class name to trace entry for
        methodName - The method name to trace entry for
        data - The data to write to service trace
        Throws:
        com.ibm.broker.plugin.MbException
      • writeServiceTraceData

        public static final void writeServiceTraceData(java.lang.String className,
                                                       java.lang.String methodName,
                                                       java.lang.String data)
        Writes a piece of data to service trace.
        Parameters:
        className - The class name to trace entry for
        methodName - The method name to trace entry for
        data - The data to write to service trace
        Throws:
        com.ibm.broker.plugin.MbException
      • throwMbRecoverableException

        public final void throwMbRecoverableException(java.lang.String messageKey,
                                                      java.lang.String[] inserts)
                                               throws com.ibm.broker.plugin.MbRecoverableException
        Throws an MbRecoverableException based on message key and inserts.
        Parameters:
        messageKey - Message number in the message catalog
        inserts - Message inserts
        Throws:
        com.ibm.broker.plugin.MbException
        com.ibm.broker.plugin.MbRecoverableException
      • throwMbRecoverableException

        public final void throwMbRecoverableException(java.lang.Exception e)
                                               throws com.ibm.broker.plugin.MbRecoverableException
        Throws an MbRecoverableException based a normal java exception.
        Parameters:
        e - Exception containing information to rethrow
        Throws:
        com.ibm.broker.plugin.MbException
        com.ibm.broker.plugin.MbRecoverableException
      • getWorkDirectory

        public java.lang.String getWorkDirectory()
                                          throws com.ibm.broker.plugin.MbException
        Throws:
        com.ibm.broker.plugin.MbException
      • getFileSeparator

        public java.lang.String getFileSeparator()
                                          throws com.ibm.broker.plugin.MbException
        Throws:
        com.ibm.broker.plugin.MbException
IBM Integration BusTM
JavaTM Connector API