Data Governance Server Documentation Index
Configuration Reference Home

Store Adapter

Note: this is an abstract component that cannot be instantiated.

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.

A Store Adapter is a native adapter for interfacing with a backend data store.

A Store Adapter can read and write JSON data to a native data store and optionally provide password management functionality. Multiple Store Adapters can be aggregated behind a SCIM Resource Type, which maps the data into a common schema.

A Store Adapter is specific to a single data type. For example, an LDAP Store Adapter would expose a single structural objectclass, and a SCIM Store Adapter would expose a single SCIM resource type.

↓Direct Subcomponents
↓Relations from This Component
↓Relations to This Component
↓Properties
↓dsconfig Usage

Direct Subcomponents

The following Store Adapters are available in the server :

These Store Adapters inherit from the properties described below.

Relations from This Component

The following components have a direct aggregation relation from Store Adapters:

Relations to This Component

The following components have a direct aggregation relation to Store Adapters:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description ↓ plugin
↓ name
↓ enabled

Basic Properties

description

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

name (Read-Only)

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

enabled

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


Advanced Properties

plugin (Advanced Property)

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


dsconfig Usage

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 delete an existing Store Adapter:

dsconfig delete-store-adapter
     --adapter-name {name}