Package com.pnfsoftware.jeb.util.logging

Class StructuredLogger

java.lang.Object
com.pnfsoftware.jeb.util.logging.StructuredLogger
All Implemented Interfaces:
ILogger
public class StructuredLogger extends Object implements ILogger
The structured logger can generate HTML formatted log.

  • Constructor Details

    • StructuredLogger

      public StructuredLogger(String name)
      Create a structured logger with structured and regular logging enabled.
      Parameters:
      name - the logger's name

    • StructuredLogger

      public StructuredLogger(String name, boolean slEnabled, boolean rlEnabled)
      Create a structured logger.
      Parameters:
      name - the logger's name
      slEnabled - true to enable structured logging; when logging is complete, the structured log may be dumped to HTML using a StructuredLoggerHtmlGenerator
      rlEnabled - true to enable regular logging (eg, to console) as well

  • Method Details

    • isStructuredLoggingEnabled

      public boolean isStructuredLoggingEnabled()
      Determine whether structured logging is enabled.
      Returns:
      true if structured entries are recorded

    • isRegularLoggingEnabled

      public boolean isRegularLoggingEnabled()
      Determine whether regular logging is enabled.
      Returns:
      true if log entries are forwarded to the regular global logger

    • hasStructuredContents

      public boolean hasStructuredContents()
      Determine whether structured entries have been recorded.
      Returns:
      true if at least one structured entry exists

    • beginSection

      public void beginSection(String name, boolean defaultOpen)
      Start a structured log section.
      Parameters:
      name - section name
      defaultOpen - true if the generated HTML section should be initially open

    • beginSection

      public void beginSection(String name)
      Start a closed structured log section.
      Parameters:
      name - section name

    • closeSection

      public void closeSection()
      Close the current structured log section.

    • generateHtml

      public String generateHtml()
      Generate an HTML representation of the structured log.
      Returns:
      the generated HTML

    • generateHtml

      public void generateHtml(FileOutputStream out, Charset charset)
      Same as generateHtml but per blocks. To use if result is too large.
      Parameters:
      out - output stream
      charset - output charset

    • getName

      public String getName()
      Description copied from interface: ILogger
      Get the logger name.
      Specified by:
      getName in interface ILogger
      Returns:
      the logger name, or null for an anonymous logger

    • setName

      public void setName(String name)
      Set the logger name.
      Parameters:
      name - logger name

    • setEnabledLevel

      public void setEnabledLevel(int level)
      Description copied from interface: ILogger
      Set the cut-off level for a logger.
      Specified by:
      setEnabledLevel in interface ILogger
      Parameters:
      level - the cut-off level: all logging calls with a level equal to or above the cut-off will be displayed

    • getEnabledLevel

      public int getEnabledLevel()
      Description copied from interface: ILogger
      Retrieve the cut-off level for that logger.
      Specified by:
      getEnabledLevel in interface ILogger
      Returns:
      the level, a number between 0 and GlobalLog.LEVEL_CATCHING

    • log

      public void log(int level, boolean raw, String format, Object... params)
      Description copied from interface: ILogger
      Log a string message.
      Specified by:
      log in interface ILogger
      Parameters:
      level - log level
      raw - true to bypass standard prefixes and newline suffixes
      format - format string if parameters are provided, else plain message
      params - optional format parameters

    • log

      public void log(int importance, int level, boolean raw, String format, Object... params)
      Log a structured message with an explicit display importance.
      Parameters:
      importance - structured display importance
      level - log level
      raw - true to bypass regular log prefixes and newline suffixes
      format - format string if parameters are provided, else plain message
      params - optional format parameters

    • i

      public void i(String format, Object... params)
      Description copied from interface: ILogger
      Reserved for internal logging. In Release builds, calling this method does nothing.
      Specified by:
      i in interface ILogger
      Parameters:
      format - format string if parameters are provided, else standard string
      params - parameters

    • iH

      public void iH(String format, Object... params)
      Log an internal highlighted message.
      Parameters:
      format - format string if parameters are provided, else plain message
      params - optional format parameters

    • iHH

      public void iHH(String format, Object... params)
      Log an internal section-level highlighted message.
      Parameters:
      format - format string if parameters are provided, else plain message
      params - optional format parameters

    • iHHH

      public void iHHH(String format, Object... params)
      Log an internal subtitle-level highlighted message.
      Parameters:
      format - format string if parameters are provided, else plain message
      params - optional format parameters

    • iHHHH

      public void iHHHH(String format, Object... params)
      Log an internal title-level highlighted message.
      Parameters:
      format - format string if parameters are provided, else plain message
      params - optional format parameters

    • iHHHHH

      public void iHHHHH(String format, Object... params)
      Log an internal chapter-level highlighted message.
      Parameters:
      format - format string if parameters are provided, else plain message
      params - optional format parameters

    • iL

      public void iL(String format, Object... params)
      Log an internal low-importance message.
      Parameters:
      format - format string if parameters are provided, else plain message
      params - optional format parameters

    • i

      public void i(int importance, String format, Object... params)
      Log an internal message with an explicit structured display importance.
      Parameters:
      importance - structured display importance
      format - format string if parameters are provided, else plain message
      params - optional format parameters

    • iBreak

      public void iBreak()
      Insert one visual break in the structured log.

    • iBreak

      public void iBreak(int cnt)
      Insert visual breaks in the structured log.
      Parameters:
      cnt - number of breaks to insert

    • iSeparator

      public void iSeparator()
      Insert a visual separator in the structured log.

    • trace

      public void trace(String format, Object... params)
      Description copied from interface: ILogger
      Log a trace message.
      Specified by:
      trace in interface ILogger
      Parameters:
      format - format string if parameters are provided, else standard string
      params - parameters

    • fine

      public void fine(String format, Object... params)
      Description copied from interface: ILogger
      Alias for trace(). Log a trace message.
      Specified by:
      fine in interface ILogger
      Parameters:
      format - format string if parameters are provided, else standard string
      params - parameters

    • debug

      public void debug(String format, Object... params)
      Description copied from interface: ILogger
      Log a debug message.
      Specified by:
      debug in interface ILogger
      Parameters:
      format - format string if parameters are provided, else standard string
      params - parameters

    • info

      public void info(String format, Object... params)
      Description copied from interface: ILogger
      Log an information message.
      Specified by:
      info in interface ILogger
      Parameters:
      format - format string if parameters are provided, else standard string
      params - parameters

    • warn

      public void warn(String format, Object... params)
      Description copied from interface: ILogger
      Log a warning message.
      Specified by:
      warn in interface ILogger
      Parameters:
      format - format string if parameters are provided, else standard string
      params - parameters

    • warning

      public void warning(String format, Object... params)
      Description copied from interface: ILogger
      Alias for warn(). Log a warning message.
      Specified by:
      warning in interface ILogger
      Parameters:
      format - format string if parameters are provided, else standard string
      params - parameters

    • error

      public void error(String format, Object... params)
      Description copied from interface: ILogger
      Log an error message.
      Specified by:
      error in interface ILogger
      Parameters:
      format - format string if parameters are provided, else standard string
      params - parameters

    • severe

      public void severe(String format, Object... params)
      Description copied from interface: ILogger
      Alias for error(). Log an error message.
      Specified by:
      severe in interface ILogger
      Parameters:
      format - format string if parameters are provided, else standard string
      params - parameters

    • catching

      public void catching(Throwable t)
      Description copied from interface: ILogger
      Log an exception's stack trace.
      Specified by:
      catching in interface ILogger
      Parameters:
      t - the throwable

    • catching

      public void catching(Throwable t, String message)
      Description copied from interface: ILogger
      Log an exception's stack trace, prefixed by an optional message.
      Specified by:
      catching in interface ILogger
      Parameters:
      t - the throwable
      message - optional message prefixing stack trace

    • catching

      public void catching(Throwable t, String format, Object... params)
      Description copied from interface: ILogger
      Log an exception's stack trace, prefixed by an optional message.
      Specified by:
      catching in interface ILogger
      Parameters:
      t - the throwable
      format - format string for the optional message
      params - format parameters

    • catchingSilent

      public void catchingSilent(Throwable t)
      Description copied from interface: ILogger
      Log an exception at the debug level.
      Specified by:
      catchingSilent in interface ILogger
      Parameters:
      t - the throwable

    • status

      public void status(String format, Object... params)
      Description copied from interface: ILogger
      Log a transient status message (STATUS). Status messages are not directed to the regular output destinations; instead, they are directed to the status sinks. Only the newest message is stored in the sink.
      Specified by:
      status in interface ILogger
      Parameters:
      format - format string if parameters are provided, else standard string
      params - parameters