cn.bestwu.framework.rest.support

类 HtmlLayout

java.lang.Object

org.apache.logging.log4j.core.layout.AbstractLayout<java.lang.String>

org.apache.logging.log4j.core.layout.AbstractStringLayout

cn.bestwu.framework.rest.support.HtmlLayout

所有已实现的接口:

org.apache.logging.log4j.core.Layout<java.lang.String>, org.apache.logging.log4j.core.layout.Encoder<org.apache.logging.log4j.core.LogEvent>, org.apache.logging.log4j.core.StringLayout

@Plugin(name="WHtmlLayout",
        category="Core",
        elementType="layout",
        printObject=true)
public final class HtmlLayout
extends org.apache.logging.log4j.core.layout.AbstractStringLayout

自定义Log4j2 日志HtmlLayout

作者:

Peter Wu

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	HtmlLayout.Builder
static class	HtmlLayout.FontSize Possible font sizes

从类继承的嵌套类/接口 org.apache.logging.log4j.core.layout.AbstractStringLayout

org.apache.logging.log4j.core.layout.AbstractStringLayout.Serializer, org.apache.logging.log4j.core.layout.AbstractStringLayout.Serializer2

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	DEFAULT_FONT_FAMILY Default font family: "arial,sans-serif".

从类继承的字段 org.apache.logging.log4j.core.layout.AbstractStringLayout

DEFAULT_STRING_BUILDER_SIZE, MAX_STRING_BUILDER_SIZE

从类继承的字段 org.apache.logging.log4j.core.layout.AbstractLayout

configuration, eventCount, footer, header, LOGGER

从接口继承的字段 org.apache.logging.log4j.core.Layout

ELEMENT_TYPE

方法概要

限定符和类型	方法和说明
static HtmlLayout	createDefaultLayout() Creates an HTML Layout using the default settings.
static HtmlLayout	createLayout(boolean locationInfo, java.lang.String title, java.lang.String contentType, java.nio.charset.Charset charset, java.lang.String fontSize, java.lang.String font) Create an HTML Layout.
java.lang.String	getContentType()
byte[]	getFooter() Returns the appropriate HTML footers.
byte[]	getHeader() Returns appropriate HTML headers.
static HtmlLayout.Builder	newBuilder()
java.lang.String	toSerializable(org.apache.logging.log4j.core.LogEvent event) Format as a String.

从类继承的方法 org.apache.logging.log4j.core.layout.AbstractStringLayout

getBytes, getCharset, getFooterSerializer, getHeaderSerializer, getStringBuilder, getStringBuilderEncoder, serializeToBytes, serializeToString, toByteArray, trimToMaxSize

从类继承的方法 org.apache.logging.log4j.core.layout.AbstractLayout

encode, getConfiguration, getContentFormat, markEvent, writeTo

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.apache.logging.log4j.core.Layout

getContentFormat

从接口继承的方法 org.apache.logging.log4j.core.layout.Encoder

encode

字段详细资料

DEFAULT_FONT_FAMILY

public static final java.lang.String DEFAULT_FONT_FAMILY

Default font family: "arial,sans-serif".

另请参阅:

常量字段值

方法详细资料

toSerializable

public java.lang.String toSerializable(org.apache.logging.log4j.core.LogEvent event)

Format as a String.

参数:

event - The Logging Event.

返回:

A String containing the LogEvent as HTML.

getContentType

public java.lang.String getContentType()

指定者:

getContentType 在接口中 org.apache.logging.log4j.core.Layout<java.lang.String>

覆盖:

getContentType 在类中 org.apache.logging.log4j.core.layout.AbstractStringLayout

getHeader

public byte[] getHeader()

Returns appropriate HTML headers.

指定者:

getHeader 在接口中 org.apache.logging.log4j.core.Layout<java.lang.String>

覆盖:

getHeader 在类中 org.apache.logging.log4j.core.layout.AbstractStringLayout

返回:

The header as a byte array.

getFooter

public byte[] getFooter()

Returns the appropriate HTML footers.

指定者:

getFooter 在接口中 org.apache.logging.log4j.core.Layout<java.lang.String>

覆盖:

getFooter 在类中 org.apache.logging.log4j.core.layout.AbstractStringLayout

返回:

the footer as a byet array.

createLayout

@PluginFactory
public static HtmlLayout createLayout(@PluginAttribute(value="locationInfo")
                                                      boolean locationInfo,
                                                      @PluginAttribute(value="title",defaultString="Log4j Log Messages")
                                                      java.lang.String title,
                                                      @PluginAttribute(value="contentType")
                                                      java.lang.String contentType,
                                                      @PluginAttribute(value="charset",defaultString="UTF-8")
                                                      java.nio.charset.Charset charset,
                                                      @PluginAttribute(value="fontSize")
                                                      java.lang.String fontSize,
                                                      @PluginAttribute(value="fontName",defaultString="arial,sans-serif")
                                                      java.lang.String font)

Create an HTML Layout.

参数:

locationInfo - If "true", location information will be included. The default is false.

title - The title to include in the file header. If none is specified the default title will be used.

contentType - The content type. Defaults to "text/html".

charset - The character set to use. If not specified, the default will be used.

fontSize - The font size of the text.

font - The font to use for the text.

返回:

An HTML Layout.

createDefaultLayout

public static HtmlLayout createDefaultLayout()

Creates an HTML Layout using the default settings.

返回:

an HTML Layout.

newBuilder

@PluginBuilderFactory
public static HtmlLayout.Builder newBuilder()