org.beiter.michael.eaudit4j.processors.slf4j

Class Slf4jProperties

java.lang.Object

org.beiter.michael.eaudit4j.processors.slf4j.Slf4jProperties

public class Slf4jProperties
extends Object

This class specifies properties specific to the slf4j Processor.

Constructor Summary

Constructors

Constructor and Description
Slf4jProperties() Constructs an empty set of slf4j properties, with most values being set to null, 0, or empty (depending on the type of the property).
Slf4jProperties(Slf4jProperties properties) Creates a set of slf4j properties from an existing set of slf4j properties, making a defensive copy.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getAdditionalProperties()
String	getAuditStreamFieldName()
String	getMarker()
String	getMdcFieldNameSeparator()
String	getMdcFields()
String	getMdcFieldSeparator()
String	getSerializedEventFieldName()
String	getStringEncoding()
void	setAdditionalProperties(Map<String,String> additionalProperties) Any additional properties which have not been parsed, and for which no getter/setter exists, but are to be stored in this object nevertheless.
void	setAuditStreamFieldName(String auditStreamFieldName) Set the name to use for the audit stream field in the MDC
void	setMarker(String marker) Set the marker to identify serialized audit events in slf4j.
void	setMdcFieldNameSeparator(String mdcFieldNameSeparator) Set the field name separator character used in setMdcFields(String)} to separate field names in the MDC from the event field name.
void	setMdcFields(String mdcFields) Set the fields to be included in the MDC, if the underlying logger supports MDC.
void	setMdcFieldSeparator(String mdcFieldSeparator) Set the MDC field separator character used in setMdcFields(String)}.
void	setSerializedEventFieldName(String serializedEventFieldName) Set the name to use for the serialized event field in the MDC
void	setStringEncoding(String stringEncoding) Set the String encoding to use when converting bytes to a String

Methods inherited from class java.lang.Object

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

Constructor Detail

Slf4jProperties

public Slf4jProperties()

Constructs an empty set of slf4j properties, with most values being set to null, 0, or empty (depending on the type of the property). Usually this constructor is used if this configuration POJO is populated in an automated fashion (e.g. injection). If you need to build them manually (possibly with defaults), use or create a properties builder.

You can change the defaults with the setters.

See Also:

MapBasedCommonPropsBuilder, MapBasedCommonPropsBuilder

Slf4jProperties

public Slf4jProperties(Slf4jProperties properties)

Creates a set of slf4j properties from an existing set of slf4j properties, making a defensive copy.

Parameters:

properties - The set of properties to copy

Throws:

NullPointerException - When properties is null

See Also:

()

Method Detail

getMarker

public final String getMarker()

Returns:

The marker

See Also:

setMarker(String)

setMarker

public final void setMarker(String marker)

Set the marker to identify serialized audit events in slf4j.

The marker is used as a prefix that will be added to all events logged to slf4j.

Parameters:

marker - The marker used to mark audit message in slf4j

Throws:

NullPointerException - When the marker is null

IllegalArgumentException - When the marker is empty

getStringEncoding

public final String getStringEncoding()

Returns:

The String encoding

See Also:

setStringEncoding(String)

setStringEncoding

public final void setStringEncoding(String stringEncoding)

Set the String encoding to use when converting bytes to a String

Parameters:

stringEncoding - The String encoding to use

Throws:

NullPointerException - When the stringEncoding is null

IllegalArgumentException - When the stringEncoding is empty

getAuditStreamFieldName

public final String getAuditStreamFieldName()

Returns:

The name to use for the audit stream field in the MDC

See Also:

setAuditStreamFieldName(String)

setAuditStreamFieldName

public final void setAuditStreamFieldName(String auditStreamFieldName)

Set the name to use for the audit stream field in the MDC

Parameters:

auditStreamFieldName - The name of the audit stream field

Throws:

NullPointerException - When the stringEncoding is null

IllegalArgumentException - When the stringEncoding is empty

getSerializedEventFieldName

public final String getSerializedEventFieldName()

Returns:

The name to use for the serialized event field in the MDC

See Also:

setSerializedEventFieldName(String)

setSerializedEventFieldName

public final void setSerializedEventFieldName(String serializedEventFieldName)

Set the name to use for the serialized event field in the MDC

Parameters:

serializedEventFieldName - The name of the serialized event field

Throws:

NullPointerException - When the stringEncoding is null

IllegalArgumentException - When the stringEncoding is empty

getMdcFields

public final String getMdcFields()

Returns:

The fields to be included in the MDC. May be null or empty if no MDC fields have been configured

See Also:

setMdcFields(String)

setMdcFields

public final void setMdcFields(String mdcFields)

Set the fields to be included in the MDC, if the underlying logger supports MDC.

Provide a list of fields that is separated with the separation character specified in setMdcFieldSeparator(java.lang.String). Define a mapping of Event field names to MDC field names (i.e. names under which the provided Event field will be made known to the MDC) as shown in the example below, using the character specified in the setMdcFieldNameSeparator(java.lang.String).

Note that the mapping of an event field name to an MDC field name is optional. If no MDC field names separator is used for a specific field, then the event field name is used to store the field in the MDC.

Set this to null or empty if none of the event fields should be included in the MDC.

This example uses , as the MDC fields separator, and : as the MDC field names separator.

Example: eventActor:mdcActor,eventSubject,eventObject:mdcObject

Parameters:

mdcFields - The list of fields to be included in the MDC

getMdcFieldSeparator

public final String getMdcFieldSeparator()

Returns:

The MDC field separator

See Also:

setMdcFieldSeparator(String)

setMdcFieldSeparator

public final void setMdcFieldSeparator(String mdcFieldSeparator)

Set the MDC field separator character used in setMdcFields(String)}.

The length of this parameter must be equal to 1.

Parameters:

mdcFieldSeparator - The character used to separate fields

Throws:

NullPointerException - When the mdcFieldSeparator is null

IllegalArgumentException - When the mdcFieldSeparator is empty or its length is not 1

getMdcFieldNameSeparator

public final String getMdcFieldNameSeparator()

Returns:

The MDC field name separator

See Also:

setMdcFieldNameSeparator(String)

setMdcFieldNameSeparator

public final void setMdcFieldNameSeparator(String mdcFieldNameSeparator)

Set the field name separator character used in setMdcFields(String)} to separate field names in the MDC from the event field name. This allows using a different field name in the MDC than in the event.

The length of this parameter must be equal to 1.

Parameters:

mdcFieldNameSeparator - The character used to separate field names in the MDC from the event field name

Throws:

NullPointerException - When the mdcFieldSeparator is null

IllegalArgumentException - When the mdcFieldSeparator is empty or its length is not 1

getAdditionalProperties

public final Map<String,String> getAdditionalProperties()

Returns:

Any additional properties stored in this object that have not explicitly been parsed

See Also:

setAdditionalProperties(Map)

setAdditionalProperties

public final void setAdditionalProperties(Map<String,String> additionalProperties)

Any additional properties which have not been parsed, and for which no getter/setter exists, but are to be stored in this object nevertheless.

This property is commonly used to preserve original properties from upstream components that are to be passed on to downstream components unchanged. This properties set may or may not include properties that have been extracted from the map, and been made available through this POJO.

Note that these additional properties may be null or empty, even in a fully populated POJO where other properties commonly have values assigned to.

Parameters:

additionalProperties - The additional properties to store