Configuration Reference Home
OpenDJ Server - External Access Log Publisher

External Access Log Publisher

External Access Log Publishers publish access messages to an external handler.

Parent Component

The External Access Log Publisher component inherits from the Access Log Publisher

Properties

A description of each property follows.


Basic Properties: Advanced Properties:
↓ config-file ↓ java-class
↓ enabled ↓ suppress-internal-operations
↓ filtering-policy ↓ suppress-synchronization-operations
↓ log-control-oids

Basic Properties

config-file

Description
The JSON configuration file that defines the External Access Log Publisher. The content of the JSON configuration file depends on the type of external audit event handler. The path to the file is relative to the server root.
Default Value
None
Allowed Values
A path to an existing file that is readable by the server.
Multi-valued
No
Required
Yes
Admin Action Required
The External Access Log Publisher must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
No
Read-only
No

enabled

Description
Indicates whether the Log Publisher is enabled for use.
Default Value
None
Allowed Values
true
false
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No

filtering-policy

Description
Specifies how filtering criteria should be applied to log records.
Default Value
no-filtering
Allowed Values
exclusive - Records must not match any of the filtering criteria in order to be logged.

inclusive - Records must match at least one of the filtering criteria in order to be logged.

no-filtering - No filtering will be performed, and all records will be logged.


Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

log-control-oids

Description
Specifies whether control OIDs will be included in operation log records.
Default Value
false
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No


Advanced Properties

java-class

Description
The fully-qualified name of the Java class that provides the External Access Log Publisher implementation.
Default Value
org.opends.server.loggers.ExternalAccessLogPublisher
Allowed Values
A java class that implements or extends the class(es) :
org.opends.server.loggers.LogPublisher
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
Yes
Read-only
No

suppress-internal-operations

Description
Indicates whether internal operations (for example, operations that are initiated by plugins) should be logged along with the operations that are requested by users.
Default Value
true
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No

suppress-synchronization-operations

Description
Indicates whether access messages that are generated by synchronization operations should be suppressed.
Default Value
false
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No