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 Store Adapters provide custom Store Adapter implementations created in third-party code using the UnboundID server SDK.
↓Parent Component
↓Properties
↓dsconfig Usage
The Third Party Store Adapter component inherits from the Store Adapter
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | ↓ plugin |
| ↓ name | |
| ↓ enabled | |
| ↓ extension-class | |
| ↓ extension-argument |
| Description | A description for this Store Adapter |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The name of the Store Adapter. The name must be valid as a component of a URN. |
| Default Value | None |
| Allowed Values | A name that can be used as a component of a URN. Letters, digits, and characters in '()+,-.=@;$_!*' are allowed. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether the Store Adapter is enabled. |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| 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 Store Adapter. |
| Default Value | None |
| Allowed Values | The fully-qualified name of a Java class that extends or implements com.unboundid.directory.sdk.broker.api.StoreAdapter |
| 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 Store Adapter. 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 | The Data Governance Server must be restarted for changes to this setting to take effect. Changes to this property will not take effect until the server is restarted. |
| Description | Specifies Store Adapter plugins that should be applied to operations that are handled by this Store Adapter. If multiple plugins are provided, then they will be invoked in the order they are specified. |
| Default Value | None |
| Allowed Values | The DN of any Store Adapter Plugin. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Store Adapters:
dsconfig list-store-adapters
[--property {propertyName}] ...
To view the configuration for an existing Store Adapter:
dsconfig get-store-adapter-prop
--adapter-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Store Adapter:
dsconfig set-store-adapter-prop
--adapter-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Third Party Store Adapter:
dsconfig create-store-adapter
--adapter-name {name}
--type third-party
--set enabled:{propertyValue}
--set extension-class:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Store Adapter:
dsconfig delete-store-adapter
--adapter-name {name}