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

Class AuditJdbcProperties

java.lang.Object

org.apereo.cas.configuration.model.support.jpa.AbstractJpaProperties

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

All Implemented Interfaces:

Serializable, CasFeatureModule

@RequiresModule(name="cas-server-support-audit-jdbc")
public class AuditJdbcProperties
extends AbstractJpaProperties

This is AuditJdbcProperties.

Since:

5.2.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apereo.cas.configuration.features.CasFeatureModule

CasFeatureModule.FeatureCatalog

Constructor Summary

Constructors

Constructor	Description
AuditJdbcProperties()

Method Summary

Modifier and Type	Method	Description
int	getColumnLength()	Allows one to trim the audit data by the specified length.
String	getDateFormatterFunction()	A formatter function that receives the formatted date value and the date pattern as the first and second argument.
String	getDateFormatterPattern()	Indicate the date formatter pattern used to fetch audit records from the database based on the record date.
int	getMaxAgeDays()	Indicates how long audit records should be kept in the database.
SchedulingProperties	getSchedule()	Scheduler settings to indicate how often the cleaner is reloaded.
String	getSelectSqlQueryTemplate()	SQL query that provides a template to fetch audit records.
boolean	isAsynchronous()	Execute the recording of audit records in async manner.
AuditJdbcProperties	setAsynchronous(boolean asynchronous)	Execute the recording of audit records in async manner.
AuditJdbcProperties	setColumnLength(int columnLength)	Allows one to trim the audit data by the specified length.
AuditJdbcProperties	setDateFormatterFunction(String dateFormatterFunction)	A formatter function that receives the formatted date value and the date pattern as the first and second argument.
AuditJdbcProperties	setDateFormatterPattern(String dateFormatterPattern)	Indicate the date formatter pattern used to fetch audit records from the database based on the record date.
AuditJdbcProperties	setMaxAgeDays(int maxAgeDays)	Indicates how long audit records should be kept in the database.
AuditJdbcProperties	setSchedule(SchedulingProperties schedule)	Scheduler settings to indicate how often the cleaner is reloaded.
AuditJdbcProperties	setSelectSqlQueryTemplate(String selectSqlQueryTemplate)	SQL query that provides a template to fetch audit records.

Methods inherited from class org.apereo.cas.configuration.model.support.jpa.AbstractJpaProperties

getBatchSize, getDataSourceName, getDdlAuto, getDefaultCatalog, getDefaultSchema, getDialect, getDriverClass, getFailFastTimeout, getFetchSize, getHealthQuery, getIdleTimeout, getIsolationLevelName, getLeakThreshold, getPassword, getPhysicalNamingStrategyClassName, getPool, getPropagationBehaviorName, getProperties, getUrl, getUser, isAutocommit, isGenerateStatistics, isIsolateInternalQueries, isReadOnly, setAutocommit, setBatchSize, setDataSourceName, setDdlAuto, setDefaultCatalog, setDefaultSchema, setDialect, setDriverClass, setFailFastTimeout, setFetchSize, setGenerateStatistics, setHealthQuery, setIdleTimeout, setIsolateInternalQueries, setIsolationLevelName, setLeakThreshold, setPassword, setPhysicalNamingStrategyClassName, setPool, setPropagationBehaviorName, setProperties, setReadOnly, setUrl, setUser

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apereo.cas.configuration.features.CasFeatureModule

isDefined, isUndefined

Constructor Details

AuditJdbcProperties

public AuditJdbcProperties()

Method Details

isAsynchronous

public boolean isAsynchronous()

Execute the recording of audit records in async manner. This setting must almost always be set to true.

getMaxAgeDays

public int getMaxAgeDays()

Indicates how long audit records should be kept in the database. This is used by the clean-up criteria to clean up after stale audit records.

getColumnLength

public int getColumnLength()

Allows one to trim the audit data by the specified length. A negative value disables the trimming process where the audit functionality no longer substrings the audit record.

getSelectSqlQueryTemplate

public String getSelectSqlQueryTemplate()

SQL query that provides a template to fetch audit records. Accepts two parameters using %s for table name and audit date.

getDateFormatterPattern

public String getDateFormatterPattern()

Indicate the date formatter pattern used to fetch audit records from the database based on the record date. Default value is yyyy-MM-dd 00:00:00.000000.

getDateFormatterFunction

public String getDateFormatterFunction()

A formatter function that receives the formatted date value and the date pattern as the first and second argument. Example: TO_DATE('%s', '%s').

getSchedule

public SchedulingProperties getSchedule()

Scheduler settings to indicate how often the cleaner is reloaded.

setAsynchronous

public AuditJdbcProperties setAsynchronous(boolean asynchronous)

Execute the recording of audit records in async manner. This setting must almost always be set to true.

Returns:

this.

setMaxAgeDays

public AuditJdbcProperties setMaxAgeDays(int maxAgeDays)

Indicates how long audit records should be kept in the database. This is used by the clean-up criteria to clean up after stale audit records.

Returns:

this.

setColumnLength

public AuditJdbcProperties setColumnLength(int columnLength)

Allows one to trim the audit data by the specified length. A negative value disables the trimming process where the audit functionality no longer substrings the audit record.

Returns:

this.

setSelectSqlQueryTemplate

public AuditJdbcProperties setSelectSqlQueryTemplate(String selectSqlQueryTemplate)

SQL query that provides a template to fetch audit records. Accepts two parameters using %s for table name and audit date.

Returns:

this.

setDateFormatterPattern

public AuditJdbcProperties setDateFormatterPattern(String dateFormatterPattern)

Indicate the date formatter pattern used to fetch audit records from the database based on the record date. Default value is yyyy-MM-dd 00:00:00.000000.

Returns:

this.

setDateFormatterFunction

public AuditJdbcProperties setDateFormatterFunction(String dateFormatterFunction)

A formatter function that receives the formatted date value and the date pattern as the first and second argument. Example: TO_DATE('%s', '%s').

Returns:

this.

setSchedule

public AuditJdbcProperties setSchedule(SchedulingProperties schedule)

Scheduler settings to indicate how often the cleaner is reloaded.

Returns:

this.