com.ibm.commerce.giftregistry.ras

Class GiftRegistryTraceLogger

  • java.lang.Object
    • com.ibm.commerce.giftregistry.ras.GiftRegistryTraceLogger


  • public class GiftRegistryTraceLogger
    extends java.lang.Object
    Utility class to handling the logging for trace messages for the WC_GIFTREGISTRY component. The full component name is com.ibm.websphere.commerce.WC_GIFTREGISTRY. A method that is being traced should make a call to entry() at the top of the method and exit() at the bottom. To create additional tracing the trace() method can be called.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COMPONENT_NAME
      The component name of the logging component.
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
      static java.lang.String LOGGER_NAME
      The logger name of the logging component.
      static java.lang.String ORGANIZATION_NAME
      The organization name for the logging component.
      static java.lang.String PRODUCT_NAME
      The product name of the logging component.
      static java.lang.String RESOURCE_BUNDLE
      The resource bundle used by the logging component.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method and Description
      static void entry(java.lang.Object tracedObject, java.lang.String methodName)
      Entry trace statement for the logging component.
      static void entry(java.lang.Object tracedObject, java.lang.String methodName, java.lang.Object[] params)
      Entry trace statement for the logging component.
      static void entry(java.lang.String classname, java.lang.String methodName)
      Entry trace statement for the logging component.
      static void entry(java.lang.String classname, java.lang.String methodName, java.lang.Object[] params)
      Entry trace statement for the logging component.
      static void exit(java.lang.Object tracedObject, java.lang.String methodName)
      The exit trace statement for the logging component.
      static void exit(java.lang.Object tracedObject, java.lang.String methodName, java.lang.Object returned)
      The exit trace statement for the logging component.
      static void exit(java.lang.String classname, java.lang.String methodName)
      The exit trace statement for the logging component.
      static void exit(java.lang.String classname, java.lang.String methodName, java.lang.Object returned)
      The exit trace statement for the logging component.
      static com.ibm.ras.RASTraceLogger getLogger()
      Returns the logger.
      static boolean isLoggable(long event)
      Indicates whether the specified logging event is traceable.
      static boolean isLoggableEntryExit()
      Indicates whether the entry/exit trace is traceable.
      static boolean isLoggableTrace()
      Indicates whether the API trace is traceable.
      static void trace(java.lang.Object tracedObject, java.lang.String methodName, java.lang.String text)
      An API trace statement for the logging component.
      static void trace(java.lang.String classname, java.lang.String methodName, java.lang.String text)
      An API trace statement for the logging component.
      • Methods inherited from class java.lang.Object

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

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values
      • ORGANIZATION_NAME

        public static java.lang.String ORGANIZATION_NAME
        The organization name for the logging component.
      • PRODUCT_NAME

        public static java.lang.String PRODUCT_NAME
        The product name of the logging component.
      • COMPONENT_NAME

        public static java.lang.String COMPONENT_NAME
        The component name of the logging component.
      • LOGGER_NAME

        public static java.lang.String LOGGER_NAME
        The logger name of the logging component.
      • RESOURCE_BUNDLE

        public static java.lang.String RESOURCE_BUNDLE
        The resource bundle used by the logging component.
    • Constructor Detail

      • GiftRegistryTraceLogger

        public GiftRegistryTraceLogger()
    • Method Detail

      • getLogger

        public static com.ibm.ras.RASTraceLogger getLogger()
        Returns the logger.
        Returns:
        The logger for this tracing component.
      • isLoggable

        public static final boolean isLoggable(long event)
        Indicates whether the specified logging event is traceable.
        Parameters:
        event - the event to test.
        Returns:
        Whether the tracing event is traceable.
      • isLoggableEntryExit

        public static final boolean isLoggableEntryExit()
        Indicates whether the entry/exit trace is traceable.
        Returns:
        Whether entry/exit trace for the logging component is enabled.
      • isLoggableTrace

        public static final boolean isLoggableTrace()
        Indicates whether the API trace is traceable.
        Returns:
        Wether the API trace for the logging component is enabled.
      • entry

        public static final void entry(java.lang.Object tracedObject,
                                       java.lang.String methodName)
        Entry trace statement for the logging component.
        Parameters:
        tracedObject - the object being traced.
        methodName - the method name being traced.
      • entry

        public static final void entry(java.lang.Object tracedObject,
                                       java.lang.String methodName,
                                       java.lang.Object[] params)
        Entry trace statement for the logging component.
        Parameters:
        tracedObject - the object being traced.
        methodName - the method name being traced.
        params - the input parameters of the method.
      • entry

        public static final void entry(java.lang.String classname,
                                       java.lang.String methodName)
        Entry trace statement for the logging component.
        Parameters:
        classname - the object being traced.
        methodName - the method name being traced.
      • entry

        public static final void entry(java.lang.String classname,
                                       java.lang.String methodName,
                                       java.lang.Object[] params)
        Entry trace statement for the logging component.
        Parameters:
        classname - the object being traced.
        methodName - the method name being traced.
        params - the input parameters of the method.
      • exit

        public static final void exit(java.lang.Object tracedObject,
                                      java.lang.String methodName)
        The exit trace statement for the logging component.
        Parameters:
        tracedObject - the object being traced.
        methodName - the method name being traced.
      • exit

        public static final void exit(java.lang.Object tracedObject,
                                      java.lang.String methodName,
                                      java.lang.Object returned)
        The exit trace statement for the logging component.
        Parameters:
        tracedObject - the object being traced.
        methodName - the method name being traced.
        returned - the object being returned by the method.
      • exit

        public static final void exit(java.lang.String classname,
                                      java.lang.String methodName)
        The exit trace statement for the logging component.
        Parameters:
        classname - the object being traced.
        methodName - the method name being traced.
      • exit

        public static final void exit(java.lang.String classname,
                                      java.lang.String methodName,
                                      java.lang.Object returned)
        The exit trace statement for the logging component.
        Parameters:
        classname - the object being traced.
        methodName - the method name being traced.
        returned - the object being returned by the method.
      • trace

        public static final void trace(java.lang.Object tracedObject,
                                       java.lang.String methodName,
                                       java.lang.String text)
        An API trace statement for the logging component.
        Parameters:
        tracedObject - the object being traced.
        methodName - the name of the method being traced.
        text - the text message of the trace statement.
      • trace

        public static final void trace(java.lang.String classname,
                                       java.lang.String methodName,
                                       java.lang.String text)
        An API trace statement for the logging component.
        Parameters:
        classname - the object being traced.
        methodName - the name of the method being traced.
        text - the text message of the trace statement.