Class TraceComponent

  • All Implemented Interfaces:
    FFDCSelfIntrospectable

    public class TraceComponent
    extends java.lang.Object
    implements FFDCSelfIntrospectable
    A TraceComponent represents a single component registered for logging. The scoping of the component is arbitrary in that it may represent a single class or it could be shared by several classes.

    A TraceComponent should be registered with Tr using a class to assist in finding the associated ResourceBundle for messages. It may have an additional name and one or more groups. The log level for any given component is controlled by a match in the trace specification for the class (including package), name, or trace group.

    • Method Detail

      • isAnyTracingEnabled

        public static boolean isAnyTracingEnabled()
      • getTraceClass

        public java.lang.Class<?> getTraceClass()
      • getLogger

        public java.util.logging.Logger getLogger()
      • getResourceBundleName

        public final java.lang.String getResourceBundleName()
      • getName

        public final java.lang.String getName()
      • isDumpEnabled

        public final boolean isDumpEnabled()
      • isDebugEnabled

        public final boolean isDebugEnabled()
      • isEntryEnabled

        public final boolean isEntryEnabled()
      • isEventEnabled

        public final boolean isEventEnabled()
      • isDetailEnabled

        public final boolean isDetailEnabled()
      • isConfigEnabled

        public final boolean isConfigEnabled()
      • isInfoEnabled

        public final boolean isInfoEnabled()
      • isAuditEnabled

        public final boolean isAuditEnabled()
      • isWarningEnabled

        public final boolean isWarningEnabled()
      • isErrorEnabled

        public final boolean isErrorEnabled()
      • isFatalEnabled

        public final boolean isFatalEnabled()
      • isServiceEnabled

        public final boolean isServiceEnabled()
      • getLoggerLevel

        public final java.util.logging.Level getLoggerLevel()
      • introspectSelf

        public java.lang.String[] introspectSelf()
        Description copied from interface: FFDCSelfIntrospectable
        Returns an array of Strings representing the object's state.

        Do not return any sensitive information in the FFDC dump

        If the object implements this interface, normal introspection dump will be skipped. Ensure that all information that you want captured in the FFDC is included in the return of this method.

        The Strings can take the following format:

        • name=value
        • name=
        • value
        • null

        Example implementation:

        
         public String[] introspectSelf() {
         StringBuffer introspectBuffer = new StringBuffer();
         String[] returnValue = new String[2];
         introspectBuffer.append("variableName1 = ");
         introspectBuffer.append(variableName1);
         returnValue[0] = new String(introspectBuffer);
         introspectBuffer.setLength(0);
         introspectBuffer.append("variableName2 = ");
         introspectBuffer.append(variableName2);
         returnValue[1] = new String(introspectBuffer);
         return returnValue;
         }
         

        Specified by:
        introspectSelf in interface FFDCSelfIntrospectable
        Returns:
        an array of Strings representing the instance variables of this object that do not contain sensitive data.
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object