Package org.forgerock.opendj.server.config.client

Interface CommonAuditAccessLogPublisherCfgClient

All Superinterfaces:

AccessLogPublisherCfgClient, ConfigurationClient, LogPublisherCfgClient

All Known Subinterfaces:

ExternalAccessLogPublisherCfgClient, JsonFileAccessLogPublisherCfgClient

public interface CommonAuditAccessLogPublisherCfgClient
extends AccessLogPublisherCfgClient

A client-side interface for reading and modifying Common Audit Access Log Publisher settings.

Common Audit Access Log Publishers publish access events to commons audit.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends CommonAuditAccessLogPublisherCfgClient,? extends CommonAuditAccessLogPublisherCfg>	definition()	Get the configuration definition associated with this Common Audit Access Log Publisher.
SortedSet<ValueOrExpression<AttributeType>>	getExcludeValuesOfAttributes()	Gets the "exclude-values-of-attributes" property.
SortedSet<ValueOrExpression<AttributeType>>	getIncludeValuesOfAttributes()	Gets the "include-values-of-attributes" property.
ValueOrExpression<Boolean>	isLogControls()	Gets the "log-controls" property.
ValueOrExpression<Boolean>	isLogModifiedAttributeValues()	Gets the "log-modified-attribute-values" property.
void	setExcludeValuesOfAttributes(Collection<ValueOrExpression<AttributeType>> values)	Sets the "exclude-values-of-attributes" property.
void	setIncludeValuesOfAttributes(Collection<ValueOrExpression<AttributeType>> values)	Sets the "include-values-of-attributes" property.
void	setLogControls(ValueOrExpression<Boolean> value)	Sets the "log-controls" property.
void	setLogModifiedAttributeValues(ValueOrExpression<Boolean> value)	Sets the "log-modified-attribute-values" property.

Methods inherited from interface org.forgerock.opendj.server.config.client.AccessLogPublisherCfgClient

createAccessLogFilteringCriteria, getAccessLogFilteringCriteria, getFilteringPolicy, getJavaClass, isSuppressInternalOperations, isSuppressSynchronizationOperations, listAccessLogFilteringCriteria, removeAccessLogFilteringCriteria, setFilteringPolicy, setJavaClass, setSuppressInternalOperations, setSuppressSynchronizationOperations

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Methods inherited from interface org.forgerock.opendj.server.config.client.LogPublisherCfgClient

isEnabled, setEnabled

Method Details

definition

ManagedObjectDefinition<? extends CommonAuditAccessLogPublisherCfgClient,? extends CommonAuditAccessLogPublisherCfg> definition()

Get the configuration definition associated with this Common Audit Access Log Publisher.

Specified by:

definition in interface AccessLogPublisherCfgClient

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface LogPublisherCfgClient

Returns:

Returns the configuration definition associated with this Common Audit Access Log Publisher.

getExcludeValuesOfAttributes

SortedSet<ValueOrExpression<AttributeType>> getExcludeValuesOfAttributes()

Gets the "exclude-values-of-attributes" property.

Attributes types targeted by a modify operation for which the modified values should be omitted from the access log.

Default value is undefined

Returns:

Returns the values of the "exclude-values-of-attributes" property.

setExcludeValuesOfAttributes

void setExcludeValuesOfAttributes(Collection<ValueOrExpression<AttributeType>> values)
                           throws PropertyException

Sets the "exclude-values-of-attributes" property.

Attributes types targeted by a modify operation for which the modified values should be omitted from the access log.

Parameters:

values - The values of the "exclude-values-of-attributes" property.

Throws:

PropertyException - If one or more of the new values are invalid.

getIncludeValuesOfAttributes

SortedSet<ValueOrExpression<AttributeType>> getIncludeValuesOfAttributes()

Gets the "include-values-of-attributes" property.

Attributes types targeted by a modify operation for which the modified values should be included in the access log.

Default value is undefined

Returns:

Returns the values of the "include-values-of-attributes" property.

setIncludeValuesOfAttributes

void setIncludeValuesOfAttributes(Collection<ValueOrExpression<AttributeType>> values)
                           throws PropertyException

Sets the "include-values-of-attributes" property.

Attributes types targeted by a modify operation for which the modified values should be included in the access log.

Parameters:

values - The values of the "include-values-of-attributes" property.

Throws:

PropertyException - If one or more of the new values are invalid.

isLogControls

ValueOrExpression<Boolean> isLogControls()

Gets the "log-controls" property.

Specifies whether controls with criticality and values will be included in operation log records.

Default value: true

Returns:

Returns the value of the "log-controls" property.

setLogControls

void setLogControls(ValueOrExpression<Boolean> value)
             throws PropertyException

Sets the "log-controls" property.

Specifies whether controls with criticality and values will be included in operation log records.

Parameters:

value - The value of the "log-controls" property.

Throws:

PropertyException - If the new value is invalid.

isLogModifiedAttributeValues

ValueOrExpression<Boolean> isLogModifiedAttributeValues()

Gets the "log-modified-attribute-values" property.

The access log contains the values of attributes targeted by a modify operation.

Default value: false

Returns:

Returns the value of the "log-modified-attribute-values" property.

setLogModifiedAttributeValues

void setLogModifiedAttributeValues(ValueOrExpression<Boolean> value)
                            throws PropertyException

Sets the "log-modified-attribute-values" property.

The access log contains the values of attributes targeted by a modify operation.

Parameters:

value - The value of the "log-modified-attribute-values" property.

Throws:

PropertyException - If the new value is invalid.