Package org.forgerock.openidm.config.enhanced

Interface EnhancedConfig

All Known Implementing Classes:
JSONEnhancedConfig
public interface EnhancedConfig

  • Method Summary

    Modifier and Type
    Method
    Description
    org.forgerock.json.JsonValue
    getConfiguration(Dictionary<String,Object> dict, String servicePid, boolean decrypt)
    Gets the extended Configuration which allows for nested Maps and Lists
    org.forgerock.json.JsonValue
    getConfiguration(Dictionary<String,Object> dict, org.osgi.framework.BundleContext context, String servicePid)
    Gets the extended Configuration which allows for nested Maps and Lists
    org.forgerock.json.JsonValue
    getConfigurationAsJson(org.osgi.service.component.ComponentContext compContext)
    Gets the extended Configuration which allows for nested Maps and Lists
    String
    getConfigurationFactoryPid(org.osgi.service.component.ComponentContext compContext)
    Gets the service factory pid from the given OSGi component context.
    org.forgerock.json.JsonValue
    getRawConfiguration(Dictionary<String,Object> dict, String servicePid)
    Gets the extended Configuration which allows for nested Maps and Lists.

  • Method Details

    • getConfigurationAsJson

      org.forgerock.json.JsonValue getConfigurationAsJson(org.osgi.service.component.ComponentContext compContext) throws InvalidException, InternalErrorException
      Gets the extended Configuration which allows for nested Maps and Lists
      Parameters:
      compContext - The component context with the configuration to retrieve
      Returns:
      the enhanced configuration with nested maps, list allowed
      Throws:
      InvalidException - if the configuration is invalid
      InternalErrorException - if a failure occurred in retrieving the configuration

    • getConfiguration

      org.forgerock.json.JsonValue getConfiguration(Dictionary<String,Object> dict, org.osgi.framework.BundleContext context, String servicePid) throws InvalidException, InternalErrorException
      Gets the extended Configuration which allows for nested Maps and Lists
      Parameters:
      dict - The standard OSGi configuration properties dictionary
      context - The OSGi bundle context, used to detect other services such as for decryption
      servicePid - the service pid this configuration is for
      Returns:
      the enhanced configuration (with nested maps, list allowed), empty json if no configuration properties exist.
      Throws:
      InvalidException
      InternalErrorException

    • getConfiguration

      org.forgerock.json.JsonValue getConfiguration(Dictionary<String,Object> dict, String servicePid, boolean decrypt) throws InvalidException, InternalErrorException
      Gets the extended Configuration which allows for nested Maps and Lists
      Parameters:
      dict - The standard OSGi configuration properties dictionary
      servicePid - the service pid this configuration is for
      decrypt - true if any encrypted values should be decrypted in the result
      Returns:
      the enhanced configuration (with nested maps, list allowed), empty json if no configuration properties exist.
      Throws:
      InvalidException
      InternalErrorException

    • getRawConfiguration

      org.forgerock.json.JsonValue getRawConfiguration(Dictionary<String,Object> dict, String servicePid) throws InvalidException
      Gets the extended Configuration which allows for nested Maps and Lists. The returned configuration will *not* be decrypted, nor have properties evaluated.
      Parameters:
      dict - The standard OSGi configuration properties dictionary
      servicePid - the service pid this configuration is for
      Returns:
      the enhanced configuration (with nested maps, list allowed), empty json if no configuration properties exist.
      Throws:
      InvalidException

    • getConfigurationFactoryPid

      String getConfigurationFactoryPid(org.osgi.service.component.ComponentContext compContext)
      Gets the service factory pid from the given OSGi component context.
      Parameters:
      compContext - The component context with the configuration to retrieve
      Returns:
      the service factory pid