Note: this component stores cluster-wide configuration data and is mirrored across all servers in the topology within the the same cluster.
Note: changes to cluster-wide configuration objects are immediately and automatically mirrored across all servers within the same cluster, so offline changes are not supported.
Third Party Policy Advice supports Policy Advice implementations created in third-party code using the Server SDK.
↓Parent Component
↓Properties
↓dsconfig Usage
The Third Party Policy Advice component inherits from the Policy Advice
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ advice-id | None |
| ↓ advice-arguments | |
| ↓ evaluation-order-index | |
| ↓ extension-class | |
| ↓ extension-argument |
| Description | A unique identifier for the advice sub-type. |
| Default Value | If no advice-id is specified, the system will generate an Id based on the managed object name of the advice sub-type. |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Contains a list of argument name-value pairs that may be passed into the implementation class of this Third Party Policy Advice. Arguments specified by this property will be evaluated during policy evaluation and therefore may be computed using information retrieved from the policy request context. Each argument must be given in the form 'name=value'. The value portion of each argument is interpreted as a JEXL expression that when evaluated yields the value to be passed to the Third Party Policy Advice implementation. |
| Default Value | If no argument names are specified, no arguments will be passed to the advice implementation. |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
evaluation-order-index (Read-Only)
| Description | If multiple Policy Advice are returned from a single policy request, then this property governs the order in which the Policy Advice will be processed by the Policy Enforcement Point. Policy Advice with a smaller value will be evaluated first. If multiple Policy Advice have the same evaluation-order-index, then their order of evaluation is indeterminate. |
| Default Value | 10 |
| Allowed Values | An integer value. Lower limit is 0. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The fully-qualified name of the Java class providing the logic for the Third Party Policy Advice. |
| Default Value | None |
| Allowed Values | The fully-qualified name of a Java class that extends or implements com.unboundid.directory.sdk.broker.api.PolicyAdvice |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The set of arguments used to customize the behavior for the Third Party Policy Advice. Each configuration property should be given in the form 'name=value'. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Policy Advice:
dsconfig list-policy-advice
[--property {propertyName}] ...
To view the configuration for an existing Policy Advice:
dsconfig get-policy-advice-prop
--advice-name {name}
--rule-name {name}
--policy-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Policy Advice:
dsconfig set-policy-advice-prop
--advice-name {name}
--rule-name {name}
--policy-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Third Party Policy Advice:
dsconfig create-policy-advice
--advice-name {name}
--rule-name {name}
--policy-name {name}
--type third-party
--set extension-class:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Policy Advice:
dsconfig delete-policy-advice
--advice-name {name}
--rule-name {name}
--policy-name {name}