Class HTMLLayout

java.lang.Object
org.apache.log4j.Layout
org.apache.log4j.HTMLLayout
All Implemented Interfaces:
OptionHandler

public class HTMLLayout extends Layout
This layout outputs events in a HTML table. Appenders using this layout should have their encoding set to UTF-8 or UTF-16, otherwise events containing non ASCII characters could result in corrupted log files.
Author:
Ceki Gülcü
  • Field Details

    • BUF_SIZE

      protected final int BUF_SIZE
      See Also:
    • MAX_CAPACITY

      protected final int MAX_CAPACITY
      See Also:
    • LOCATION_INFO_OPTION

      public static final String LOCATION_INFO_OPTION
      Deprecated.
      Options are now handled using the JavaBeans paradigm. This constant is not longer needed and will be removed in the near term.
      A string constant used in naming the option for setting the the location information flag. Current value of this string constant is LocationInfo.

      Note that all option keys are case sensitive.

      See Also:
    • TITLE_OPTION

      public static final String TITLE_OPTION
      A string constant used in naming the option for setting the the HTML document title. Current value of this string constant is Title.
      See Also:
  • Constructor Details

    • HTMLLayout

      public HTMLLayout()
  • Method Details

    • setLocationInfo

      public void setLocationInfo(boolean flag)
      The LocationInfo option takes a boolean value. By default, it is set to false which means there will be no location information output by this layout. If the the option is set to true, then the file name and line number of the statement at the origin of the log statement will be output.

      If you are embedding this layout within an SMTPAppender then make sure to set the LocationInfo option of that appender as well.

    • getLocationInfo

      public boolean getLocationInfo()
      Returns the current value of the LocationInfo option.
    • setTitle

      public void setTitle(String title)
      The Title option takes a String value. This option sets the document title of the generated HTML document.

      Defaults to 'Log4J Log Messages'.

    • getTitle

      public String getTitle()
      Returns the current value of the Title option.
    • getContentType

      public String getContentType()
      Returns the content type output by this layout, i.e "text/html".
      Overrides:
      getContentType in class Layout
    • activateOptions

      public void activateOptions()
      No options to activate.
    • format

      public String format(LoggingEvent event)
      Description copied from class: Layout
      Implement this method to create your own layout format.
      Specified by:
      format in class Layout
    • getHeader

      public String getHeader()
      Returns appropriate HTML headers.
      Overrides:
      getHeader in class Layout
    • getFooter

      public String getFooter()
      Returns the appropriate HTML footers.
      Overrides:
      getFooter in class Layout
    • ignoresThrowable

      public boolean ignoresThrowable()
      The HTML layout handles the throwable contained in logging events. Hence, this method return false.
      Specified by:
      ignoresThrowable in class Layout