PingAuthorize Server Documentation Index
Configuration Reference Home

Groovy Scripted Access Log Publisher

Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.

Groovy Scripted Access Log Publisher provide access log publisher implementations defined in a dynamically-loaded Groovy script which implements the ScriptedAccessLogger class defined in the UnboundID server SDK.

Parent Component
Properties
dsconfig Usage

Parent Component

The Groovy Scripted Access Log Publisher component inherits from the Scripted Access Log Publisher

Properties

The properties supported by this managed object are as follows:


General Configuration Basic Properties: Advanced Properties:
↓ description  None
↓ enabled
↓ logging-error-behavior
Custom Extension Configuration Basic Properties: Advanced Properties:
↓ script-argument  None
↓ script-class
Log Messages To Include Basic Properties: Advanced Properties:
↓ log-connects  None
↓ log-disconnects
↓ log-security-negotiation
↓ log-client-certificates
↓ log-requests
↓ log-results
↓ log-search-entries
↓ log-search-references
↓ log-intermediate-responses
↓ suppress-internal-operations
↓ suppress-replication-operations
↓ correlate-requests-and-results

Basic Properties

description

Property Group
General Configuration
Description
A description for this Log Publisher
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

enabled

Property Group
General Configuration
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. Modification requires no further action

logging-error-behavior

Property Group
General Configuration
Description
Specifies the behavior that the server should exhibit if an error occurs during logging processing.
Default Value
standard-error
Allowed Values
standard-error - Write a message to standard error in the event of a logging failure.

lockdown-mode - Place the server in lockdown mode in the event of a logging failure.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

script-argument

Property Group
Custom Extension Configuration
Description
The set of arguments used to customize the behavior for the Scripted Access Log Publisher. Each configuration property should be given in the form 'name=value'.
Default Value
None
Allowed Values
An argument in the form 'name=value'. Argument names are allowed to contain only ASCII alphabetic characters, numeric digits, dashes, and underscores.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

script-class

Property Group
Custom Extension Configuration
Description
The fully-qualified name of the Groovy class providing the logic for the Groovy Scripted Access Log Publisher.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

log-connects

Property Group
Log Messages To Include
Description
Indicates whether to log information about connections established to the server.
Default Value
true
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

log-disconnects

Property Group
Log Messages To Include
Description
Indicates whether to log information about connections that have been closed by the client or terminated by the server.
Default Value
true
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

log-security-negotiation

Property Group
Log Messages To Include
Description
Indicates whether to log information about the result of any security negotiation (e.g., SSL handshake) processing that has been performed.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

log-client-certificates

Property Group
Log Messages To Include
Description
Indicates whether to log information about any client certificates presented to the server.
Default Value
true
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

log-requests

Property Group
Log Messages To Include
Description
Indicates whether to log information about requests received from clients.
Default Value
true
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

log-results

Property Group
Log Messages To Include
Description
Indicates whether to log information about the results of client requests.
Default Value
true
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

log-search-entries

Property Group
Log Messages To Include
Description
Indicates whether to log information about search result entries sent to the client.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

log-search-references

Property Group
Log Messages To Include
Description
Indicates whether to log information about search result references sent to the client.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

log-intermediate-responses

Property Group
Log Messages To Include
Description
Indicates whether to log information about intermediate responses sent to the client.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

suppress-internal-operations

Property Group
Log Messages To Include
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. Modification requires no further action

suppress-replication-operations

Property Group
Log Messages To Include
Description
Indicates whether access messages that are generated by replication operations should be suppressed.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

correlate-requests-and-results

Property Group
Log Messages To Include
Description
Indicates whether to automatically log result messages for any operation in which the corresponding request was logged. In such cases, the result, entry, and reference criteria will be ignored, although the log-responses, log-search-entries, and log-search-references properties will be honored.
Default Value
true
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Log Publishers:

dsconfig list-log-publishers
     [--property {propertyName}] ...

To view the configuration for an existing Log Publisher:

dsconfig get-log-publisher-prop
     --publisher-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Log Publisher:

dsconfig set-log-publisher-prop
     --publisher-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Groovy Scripted Access Log Publisher:

dsconfig create-log-publisher
     --publisher-name {name}
     --type groovy
     --set enabled:{propertyValue}
     --set script-class:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Log Publisher:

dsconfig delete-log-publisher
     --publisher-name {name}