io.jenkins.plugins.audit.plugins

Class CustomHTMLLayout

java.lang.Object

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

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

io.jenkins.plugins.audit.plugins.CustomHTMLLayout

All Implemented Interfaces:

org.apache.logging.log4j.core.impl.LocationAware, org.apache.logging.log4j.core.Layout<String>, org.apache.logging.log4j.core.layout.Encoder<org.apache.logging.log4j.core.LogEvent>, org.apache.logging.log4j.core.StringLayout

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

Outputs events as rows in an HTML table on an HTML page.

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CustomHTMLLayout.Builder
static class	CustomHTMLLayout.FontSize Possible font sizes

Nested classes/interfaces inherited from class org.apache.logging.log4j.core.layout.AbstractStringLayout

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_FONT_FAMILY Default font family: "arial,sans-serif".

Fields inherited from class org.apache.logging.log4j.core.layout.AbstractStringLayout

DEFAULT_STRING_BUILDER_SIZE, MAX_STRING_BUILDER_SIZE

Fields inherited from class org.apache.logging.log4j.core.layout.AbstractLayout

configuration, eventCount, footer, header, LOGGER

Fields inherited from interface org.apache.logging.log4j.core.Layout

ELEMENT_TYPE

Method Summary

Modifier and Type	Method and Description
static CustomHTMLLayout	createDefaultLayout() Creates an HTML Layout using the default settings.
String	getContentType()
byte[]	getFooter() Returns the appropriate HTML footers.
byte[]	getHeader() Returns appropriate HTML headers.
String	getTitle() For testing purposes.
boolean	isLocationInfo() For testing purposes.
static CustomHTMLLayout.Builder	newBuilder()
boolean	requiresLocation()
String	toSerializable(org.apache.logging.log4j.core.LogEvent event) Formats as a String.

Methods inherited from class org.apache.logging.log4j.core.layout.AbstractStringLayout

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

Methods inherited from class org.apache.logging.log4j.core.layout.AbstractLayout

encode, getConfiguration, getContentFormat, markEvent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.logging.log4j.core.Layout

getContentFormat

Methods inherited from interface org.apache.logging.log4j.core.layout.Encoder

encode

Field Detail

DEFAULT_FONT_FAMILY

public static final String DEFAULT_FONT_FAMILY

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

See Also:

Constant Field Values

Method Detail

getTitle

public String getTitle()

For testing purposes.

isLocationInfo

public boolean isLocationInfo()

For testing purposes.

requiresLocation

public boolean requiresLocation()

Specified by:

requiresLocation in interface org.apache.logging.log4j.core.impl.LocationAware

Overrides:

requiresLocation in class org.apache.logging.log4j.core.layout.AbstractStringLayout

toSerializable

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

Formats as a String.

Parameters:

event - The Logging Event.

Returns:

A String containing the LogEvent as HTML.

getContentType

public String getContentType()

Specified by:

getContentType in interface org.apache.logging.log4j.core.Layout<String>

Overrides:

getContentType in class org.apache.logging.log4j.core.layout.AbstractStringLayout

getHeader

public byte[] getHeader()

Returns appropriate HTML headers.

Specified by:

getHeader in interface org.apache.logging.log4j.core.Layout<String>

Overrides:

getHeader in class org.apache.logging.log4j.core.layout.AbstractStringLayout

Returns:

The header as a byte array.

getFooter

public byte[] getFooter()

Returns the appropriate HTML footers.

Specified by:

getFooter in interface org.apache.logging.log4j.core.Layout<String>

Overrides:

getFooter in class org.apache.logging.log4j.core.layout.AbstractStringLayout

Returns:

the footer as a byte array.

createDefaultLayout

public static CustomHTMLLayout createDefaultLayout()

Creates an HTML Layout using the default settings.

Returns:

an HTML Layout.

newBuilder

@PluginBuilderFactory
public static CustomHTMLLayout.Builder newBuilder()