Third Party Store Adapters provide custom 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 | ↓ modifies-as-creates |
| ↓ correlation-attribute-urn | |
| ↓ 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 | Specifies the SCIM attribute to use as the correlation between resources when multiple Store Adapters are configured in a DataView. The attribute defined here MUST be a primary key for the resources exposed by this Store Adapter (i.e. there can only be one and only one resource with a given value for this attribute). Furthermore, the value must exactly match the value of the correlation attributes for other Store Adapters defined within the same DataView. This is how the DataView aggregates resources from multiple Store Adapters during a search operation. For example, an LDAP Store Adapter might specify the 'uid' attribute here, (i.e. "urn:unboundid:schemas:scim:ldap:1.0:uid"), and a Third Party Store Adapter might specify its "acmeID" attribute (i.e. "urn:acme:schemas:scim:1.0:acmeID"). This implies that 'uid' and 'acmeID' are equivalent and are able to uniquely identify a single resource on their respective Store Adapters. It is not required that the correlation attribute actually be persisted. For LDAP Store Adapters, it may be derived via a virtual attribute. Likewise for Third Party Store Adapters, it may be constructed via a transformation or using any information available in the Server SDK extension. However, it is required that this attribute is always available, so if it depends on another attribute created by a different Store Adapter, then pay careful attention to the order you define the Store Adapters in the DataView. |
| Default Value | urn:scim:schemas:core:1.0:id |
| Allowed Values | A SCIM attribute URN (using the standard attribute dot notation). This may reference a sub-attribute. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | The Third Party Store Adapter must be disabled and re-enabled for changes to this setting to take effect. Changes to this property will not take effect until the associated DataView is disabled and then re-enabled, or until the server is restarted. |
| 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 Third Party Store Adapter must be disabled and re-enabled for changes to this setting to take effect. Changes to this property will not take effect until the associated DataView is disabled and then re-enabled, or until the server is restarted. |
modifies-as-creates (Advanced Property)
| Description | If set to true, this property allows this Store Adapter to process a modify operation as a create operation if the target resource does not exist. This setting can be useful for lazily creating resources in one or more Store Adapters, or filling in where resources are missing. For example, if you have existing users in one data store and would like to store the Identity Broker user metadata (i.e. consents, tokens, etc) in a separate data store without having to manually copy all the user entries over to that separate store, you could use this option to have the Identity Broker create them for you on the fly. Note that this option only applies when there is enough information between the modify request and the data in other Store Adapters to create the new resource on this Store Adapter. This also depends which attributes are marked as 'required' in the native schema for this adapter, and the attribute mappings for those required attributes. |
| Default Value | false |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | The Third Party Store Adapter must be disabled and re-enabled for changes to this setting to take effect. Changes to this property will not take effect until the associated DataView is disabled and then re-enabled, or until the server is restarted. |
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 extension-class:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Store Adapter:
dsconfig delete-store-adapter
--adapter-name {name}