CommonAuditAccessLogPublisherCfgClient (OpenDJ Public API Javadoc 7.4.3-20241015115352-209ff3c0000cb208c40a9a5f707924f0af03b332 Documentation)

All Superinterfaces:

AccessLogPublisherCfgClient, ConfigurationClient, LogPublisherCfgClient

All Known Subinterfaces:

CsvFileAccessLogPublisherCfgClient, 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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`ManagedObjectDefinition<? extends CommonAuditAccessLogPublisherCfgClient,? extends CommonAuditAccessLogPublisherCfg>`	`definition()`	Get the configuration definition associated with this Common Audit Access Log Publisher.
`ValueOrExpression<Boolean>`	`isLogControls()`	Gets the "log-controls" property.
`void`	`setLogControls(ValueOrExpression<Boolean> value)`	Sets the "log-controls" 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 Detail
  - 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.
  - 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.