Package org.apereo.cas.configuration.model.core.audit

Class AuditSlf4jLogProperties

java.lang.Object

org.apereo.cas.configuration.model.core.audit.AuditSlf4jLogProperties

All Implemented Interfaces:

Serializable

@RequiresModule(name="cas-server-core-audit",
                automated=true)
public class AuditSlf4jLogProperties
extends Object
implements Serializable

This is AuditSlf4jLogProperties.

Since:

5.2.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AuditSlf4jLogProperties()

Method Summary

Modifier and Type	Method	Description
String	getAuditableFields()	Control and define fields that can be accepted by the audit log.
String	getSinglelineSeparator()	Character to separate audit fields if single-line audits are used.
boolean	isEnabled()	Decide whether Slf4j audits should be enabled.
boolean	isUseSingleLine()	Indicates whether audit logs should be recorded as a single-line.
AuditSlf4jLogProperties	setAuditableFields(String auditableFields)	Control and define fields that can be accepted by the audit log.
AuditSlf4jLogProperties	setEnabled(boolean enabled)	Decide whether Slf4j audits should be enabled.
AuditSlf4jLogProperties	setSinglelineSeparator(String singlelineSeparator)	Character to separate audit fields if single-line audits are used.
AuditSlf4jLogProperties	setUseSingleLine(boolean useSingleLine)	Indicates whether audit logs should be recorded as a single-line.

Methods inherited from class java.lang.Object

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

Constructor Details

AuditSlf4jLogProperties

public AuditSlf4jLogProperties()

Method Details

isUseSingleLine

public boolean isUseSingleLine()

Indicates whether audit logs should be recorded as a single-line.

By default, audit logs are split into multiple lines where each action and activity takes up a full line. This is a more compact version.

getSinglelineSeparator

public String getSinglelineSeparator()

Character to separate audit fields if single-line audits are used.

getAuditableFields

public String getAuditableFields()

Control and define fields that can be accepted by the audit log. Accepted values are:

• who
• what
• action
• application
• when
• user_agent
• client_ip
• server_ip
• geo_location
• headers

isEnabled

public boolean isEnabled()

Decide whether Slf4j audits should be enabled.

setUseSingleLine

public AuditSlf4jLogProperties setUseSingleLine(boolean useSingleLine)

Indicates whether audit logs should be recorded as a single-line.

By default, audit logs are split into multiple lines where each action and activity takes up a full line. This is a more compact version.

Returns:

this.

setSinglelineSeparator

public AuditSlf4jLogProperties setSinglelineSeparator(String singlelineSeparator)

Character to separate audit fields if single-line audits are used.

Returns:

this.

setAuditableFields

public AuditSlf4jLogProperties setAuditableFields(String auditableFields)

Control and define fields that can be accepted by the audit log. Accepted values are:

• who
• what
• action
• application
• when
• user_agent
• client_ip
• server_ip
• geo_location
• headers

Returns:

this.

setEnabled

public AuditSlf4jLogProperties setEnabled(boolean enabled)

Decide whether Slf4j audits should be enabled.

Returns:

this.