Package org.forgerock.openidm.provisioner

Interface ConnectorConfigurationHelper

All Known Implementing Classes:
ConnectorInfoProviderService
public interface ConnectorConfigurationHelper
Helper methods which assist with generating connector configuration. These methods can be called to validate connector configurations as well as check which connectors are available for configuration. After each phase of generated configuration the user can customize the properties generated and have them validated.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CONFIGURATION_PROPERTIES
    configuration property that holds the actual connector configuration (passed to the connector)
    static final String
    CONNECTOR_NAME
    the connector name (within connectorRef)
    static final String
    CONNECTOR_REF
    configuration property that describes the connector's meta-data
    static final String
    OBJECT_TYPES
    configuration property that holds the connector object type detail

  • Method Summary

    Modifier and Type
    Method
    Description
    org.forgerock.json.JsonValue
    generateConnectorCoreConfig(org.forgerock.json.JsonValue params)
    Generate the core configuration The implementer of this method must ensure proper encryption/decryption of private properties according to the schema definition.
    org.forgerock.json.JsonValue
    generateConnectorFullConfig(org.forgerock.json.JsonValue params)
    Generate the full configuration The implementer of this method must ensure proper encryption/decryption of private properties according to the schema definition.
    org.forgerock.json.JsonValue
    getAvailableConnectors()
    Get available connectors from an installation
    String
    getProvisionerType()
    Return the provisioner type that is used to manage configuration/connectors created by this configuration helper.
    Map<String,Object>
    test(org.forgerock.json.JsonValue params)
    Test the given configuration.

  • Field Details

    • CONNECTOR_REF

      static final String CONNECTOR_REF
      configuration property that describes the connector's meta-data
      See Also:

    • CONFIGURATION_PROPERTIES

      static final String CONFIGURATION_PROPERTIES
      configuration property that holds the actual connector configuration (passed to the connector)
      See Also:

    • CONNECTOR_NAME

      static final String CONNECTOR_NAME
      the connector name (within connectorRef)
      See Also:

    • OBJECT_TYPES

      static final String OBJECT_TYPES
      configuration property that holds the connector object type detail
      See Also:

  • Method Details

    • getProvisionerType

      String getProvisionerType()
      Return the provisioner type that is used to manage configuration/connectors created by this configuration helper.
      Returns:
      the configuration system type.

    • test

      Map<String,Object> test(org.forgerock.json.JsonValue params) throws org.forgerock.json.resource.ResourceException
      Test the given configuration.
      Parameters:
      params - the configuration to test
      Throws:
      org.forgerock.json.resource.ResourceException - when the test fails the ResourceException.getDetail() contains the detailed information.

    • getAvailableConnectors

      org.forgerock.json.JsonValue getAvailableConnectors() throws org.forgerock.json.resource.ResourceException
      Get available connectors from an installation
      Returns:
      JsonValue containing all available connectors
      Throws:
      org.forgerock.json.resource.ResourceException

    • generateConnectorCoreConfig

      org.forgerock.json.JsonValue generateConnectorCoreConfig(org.forgerock.json.JsonValue params) throws org.forgerock.json.resource.ResourceException
      Generate the core configuration The implementer of this method must ensure proper encryption/decryption of private properties according to the schema definition.
      Parameters:
      params - connector configuration
      Returns:
      core connector configuration
      Throws:
      org.forgerock.json.resource.ResourceException

    • generateConnectorFullConfig

      org.forgerock.json.JsonValue generateConnectorFullConfig(org.forgerock.json.JsonValue params) throws org.forgerock.json.resource.ResourceException
      Generate the full configuration The implementer of this method must ensure proper encryption/decryption of private properties according to the schema definition.
      Parameters:
      params - connector configuration
      Returns:
      full connector configuration
      Throws:
      org.forgerock.json.resource.ResourceException