Package com.unboundid.directory.sdk.sync.api

Class SCIM2AttributeMapping

  • All Implemented Interfaces:
    Configurable, ExampleUsageProvider, Reconfigurable<SCIM2AttributeMappingConfig>, UnboundIDExtension
    @Extensible
@SynchronizationServerExtension(appliesToLocalContent=false,
                                appliesToSynchronizedContent=true)
@ThreadSafety(level=INTERFACE_THREADSAFE)
public abstract class SCIM2AttributeMapping
extends java.lang.Object
implements UnboundIDExtension, Reconfigurable<SCIM2AttributeMappingConfig>, ExampleUsageProvider
    This class defines an API that must be implemented by extensions that may be used to convert attributes between the mapped LDAP representation of an entry and the SCIM 2.0 representation of that entry. A SCIM 2.0 mapped attribute will exist as a single attribute in a SCIM entry, and it may correlate to zero, one or multiple attributes in the corresponding source entry. That is, the SCIM attribute may directly correlate to a single source attribute, it may be generated from multiple attributes in the source entry, or it may be generated without using any content from the source entry.

    Configuring SCIM2 Attribute Mappings

    In order to configure a SCIM2 attribute mapping created using this API, use a command like: 
          dsconfig create-scim2-attribute-mapping \
           --sync-mapping-name "{name}" \
           --type third-party \
           --set "extension-class:{class-name}" \
           --set "extension-argument:{name=value}"
    where "{name}" is the name to use for the SCIM2 attribute mapping instance, "{class-name}" is the fully-qualified name of the Java class that extends com.unboundid.directory.sdk.sync.api.SCIM2AttributeMapping, and "{name=value}" represents name-value pairs for any arguments to provide to the attribute mapping. If multiple arguments should be provided to extension, then the "--set extension-argument:{name=value}" option should be provided multiple times.

    • Method Detail

      • getExtensionDescription

        public abstract java.lang.String[] getExtensionDescription()
        Retrieves a human-readable description for this extension. Each element of the array that is returned will be considered a separate paragraph in generated documentation.
        Specified by:
        getExtensionDescription in interface UnboundIDExtension
        Returns:
        A human-readable description for this extension, or null or an empty array if no description should be available.

      • getExamplesArgumentSets

        public java.util.Map<java.util.List<java.lang.String>,​java.lang.String> getExamplesArgumentSets()
        Retrieves a map containing examples of configurations that may be used for this extension. The map key should be a list of sample arguments, and the corresponding value should be a description of the behavior that will be exhibited by the extension when used with that configuration.
        Specified by:
        getExamplesArgumentSets in interface ExampleUsageProvider
        Returns:
        A map containing examples of configurations that may be used for this extension. It may be null or empty if there should not be any example argument sets.

      • defineConfigArguments

        public void defineConfigArguments​(ArgumentParser parser)
                           throws ArgumentException
        Updates the provided argument parser to define any configuration arguments which may be used by this extension. The argument parser may also be updated to define relationships between arguments (e.g., to specify required, exclusive, or dependent argument sets).
        Specified by:
        defineConfigArguments in interface Configurable
        Parameters:
        parser - The argument parser to be updated with the configuration arguments which may be used by this extension.
        Throws:
        ArgumentException - If a problem is encountered while updating the provided argument parser.

      • initializeAttributeMapping

        public void initializeAttributeMapping​(SyncServerContext serverContext,
                                       SCIM2AttributeMappingConfig config,
                                       ArgumentParser parser)
                                throws LDAPException
        Performs any necessary initialization for this SCIM2 attribute mapping.
        Parameters:
        serverContext - A handle to the server context for the server in which this extension is running. Extensions should typically store this in a class member.
        config - The general configuration for this object.
        parser - The argument parser which has been initialized from the configuration for this SCIM2 attribute mapping.
        Throws:
        LDAPException - If a problem occurs while initializing this SCIM2 attribute mapping.

      • isConfigurationAcceptable

        public boolean isConfigurationAcceptable​(SCIM2AttributeMappingConfig config,
                                         ArgumentParser parser,
                                         java.util.List<java.lang.String> unacceptableReasons)
        Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension. The parser will have been used to parse any configuration available for this extension, and any automatic validation will have been performed. This method may be used to perform any more complex validation which cannot be performed automatically by the argument parser.
        Specified by:
        isConfigurationAcceptable in interface Reconfigurable<SCIM2AttributeMappingConfig>
        Parameters:
        config - The general configuration for this extension.
        parser - The argument parser that has been used to parse the proposed configuration for this extension.
        unacceptableReasons - A list to which messages may be added to provide additional information about why the provided configuration is not acceptable.
        Returns:
        true if the configuration in the provided argument parser appears to be acceptable, or false if not.

      • applyConfiguration

        public ResultCode applyConfiguration​(SCIM2AttributeMappingConfig config,
                                     ArgumentParser parser,
                                     java.util.List<java.lang.String> adminActionsRequired,
                                     java.util.List<java.lang.String> messages)
        Attempts to apply the configuration from the provided argument parser to this extension.
        Specified by:
        applyConfiguration in interface Reconfigurable<SCIM2AttributeMappingConfig>
        Parameters:
        config - The general configuration for this extension.
        parser - The argument parser that has been used to parse the new configuration for this extension.
        adminActionsRequired - A list to which messages may be added to provide additional information about any additional administrative actions that may be required to apply some of the configuration changes.
        messages - A list to which messages may be added to provide additional information about the processing performed by this method.
        Returns:
        A result code providing information about the result of applying the configuration change. A result of SUCCESS should be used to indicate that all processing completed successfully. Any other result will indicate that a problem occurred during processing.

      • finalizeAttributeMapping

        public void finalizeAttributeMapping()
        Performs any necessary cleanup work when this attribute mapping is taken out of service.

      • isSingleValued

        public abstract boolean isSingleValued()
        Indicates whether this SCIM2 attribute mapping targets a single-valued SCIM 2.0 attribute.
        Returns:
        true if this SCIM2 attribute mapping targets a single-valued SCIM 2.0 attribute, or false if it targets an attribute that may have multiple values or is defined as multivalued in the schema.

      • createSCIM2Representation

        public abstract JSONField createSCIM2Representation​(Entry mappedLDAPEntry)
                                             throws LDAPException
        Constructs the SCIM2 representation of an attribute from the information in the provided mapped LDAP representation of an entry as created by a sync class.
        Parameters:
        mappedLDAPEntry - The mapped LDAP representation of an entry as created by a sync class. It must not be null.
        Returns:
        A JSON field that represents the SCIM 2.0 representation of the attribute. It may be null if the provided entry does not contain enough information to create the SCIM2 attribute (e.g., if the associated LDAP attribute does not exist in the entry).
        Throws:
        LDAPException - If a problem occurs while attempting to create the SCIM 2.0 representation of the attribute from the provided LDAP entry.

      • createLDAPRepresentation

        public abstract void createLDAPRepresentation​(java.lang.String scim2EntryID,
                                              JSONObject scim2Entry,
                                              Entry updatableLDAPEntry)
                                       throws LDAPException
        Updates the provided LDAP entry with information from the given JSON object containing the SCIM 2.0 representation of the entry.
        Parameters:
        scim2EntryID - The identifier for the SCIM2 entry.
        scim2Entry - A JSON object containing the SCIM2 representation of the entry.
        updatableLDAPEntry - An LDAP entry that may be updated with content obtained from the SCIM2 representation of the entry.
        Throws:
        LDAPException - If a problem occurs while attempting to create the LDAP representation of the attribute from the provided JSON object.