Package org.forgerock.openidm.config.manage

Class ConfigObjectService

java.lang.Object
org.forgerock.openidm.config.manage.ConfigObjectService
All Implemented Interfaces:
org.forgerock.json.resource.RequestHandler, ClusterEventListener, org.forgerock.services.descriptor.Describable<org.forgerock.api.models.ApiDescription,org.forgerock.json.resource.Request>
public class ConfigObjectService extends Object implements org.forgerock.json.resource.RequestHandler, ClusterEventListener, org.forgerock.services.descriptor.Describable<org.forgerock.api.models.ApiDescription,org.forgerock.json.resource.Request>
Provides access to OSGi configuration.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.forgerock.services.descriptor.Describable

    org.forgerock.services.descriptor.Describable.Listener

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConfigObjectService()
     
    ConfigObjectService(ConfigAuditEventLogger configAuditEventLogger)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    activate(org.osgi.service.component.ComponentContext context)
     
    void
    addDescriptorListener(org.forgerock.services.descriptor.Describable.Listener listener)
     
    org.forgerock.api.models.ApiDescription
    api(org.forgerock.http.ApiProducer<org.forgerock.api.models.ApiDescription> producer)
     
    void
    bindClusterManagementService(ClusterManagementService clusterManagementService)
     
    protected void
    bindConnectionFactory(IDMConnectionFactory connectionFactory)
     
    protected void
    bindEnhancedConfig(EnhancedConfig enhancedConfig)
     
    void
    bindScriptedPatchValueTransformerFactory(ScriptedPatchValueTransformerFactory scriptedPatchValueTransformerFactory)
     
    org.forgerock.util.promise.Promise<ConfigAuditState,org.forgerock.json.resource.ResourceException>
    create(org.forgerock.json.resource.ResourcePath resourcePath, String id, org.forgerock.json.JsonValue obj, boolean allowExisting)
    Creates a new object in the object set.
    protected void
    deactivate(org.osgi.service.component.ComponentContext context)
     
    org.forgerock.util.promise.Promise<org.forgerock.json.resource.ActionResponse,org.forgerock.json.resource.ResourceException>
    handleAction(org.forgerock.services.context.Context context, org.forgerock.json.resource.ActionRequest request)
     
    org.forgerock.api.models.ApiDescription
    handleApiRequest(org.forgerock.services.context.Context context, org.forgerock.json.resource.Request request)
     
    org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException>
    handleCreate(org.forgerock.services.context.Context context, org.forgerock.json.resource.CreateRequest request)
     
    org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException>
    handleDelete(org.forgerock.services.context.Context context, org.forgerock.json.resource.DeleteRequest request)
     
    boolean
    handleEvent(ClusterEvent event)
    Notifies a listener that a ClusterEvent has fired
    org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException>
    handlePatch(org.forgerock.services.context.Context context, org.forgerock.json.resource.PatchRequest request)
     
    org.forgerock.util.promise.Promise<org.forgerock.json.resource.QueryResponse,org.forgerock.json.resource.ResourceException>
    handleQuery(org.forgerock.services.context.Context context, org.forgerock.json.resource.QueryRequest request, org.forgerock.json.resource.QueryResourceHandler handler)
     
    org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException>
    handleRead(org.forgerock.services.context.Context context, org.forgerock.json.resource.ReadRequest request)
     
    org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException>
    handleUpdate(org.forgerock.services.context.Context context, org.forgerock.json.resource.UpdateRequest request)
     
    void
    removeDescriptorListener(org.forgerock.services.descriptor.Describable.Listener listener)
     
    void
    unbindClusterManagementService(ClusterManagementService clusterManagementService)
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ConfigObjectService

      public ConfigObjectService()

    • ConfigObjectService

      public ConfigObjectService(ConfigAuditEventLogger configAuditEventLogger)

  • Method Details

    • bindScriptedPatchValueTransformerFactory

      public void bindScriptedPatchValueTransformerFactory(ScriptedPatchValueTransformerFactory scriptedPatchValueTransformerFactory)

    • bindClusterManagementService

      public void bindClusterManagementService(ClusterManagementService clusterManagementService)

    • unbindClusterManagementService

      public void unbindClusterManagementService(ClusterManagementService clusterManagementService)

    • bindConnectionFactory

      protected void bindConnectionFactory(IDMConnectionFactory connectionFactory)

    • bindEnhancedConfig

      protected void bindEnhancedConfig(EnhancedConfig enhancedConfig)

    • handleRead

      public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException> handleRead(org.forgerock.services.context.Context context, org.forgerock.json.resource.ReadRequest request)
      Specified by:
      handleRead in interface org.forgerock.json.resource.RequestHandler

    • handleCreate

      public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException> handleCreate(org.forgerock.services.context.Context context, org.forgerock.json.resource.CreateRequest request)
      Specified by:
      handleCreate in interface org.forgerock.json.resource.RequestHandler

    • create

      public org.forgerock.util.promise.Promise<ConfigAuditState,org.forgerock.json.resource.ResourceException> create(org.forgerock.json.resource.ResourcePath resourcePath, String id, org.forgerock.json.JsonValue obj, boolean allowExisting)
      Creates a new object in the object set.

      This method sets the _id property to the assigned identifier for the object, and the _rev property to the revised object version (For optimistic concurrency)

      Parameters:
      resourcePath - for multi-instance config, the factory pid to use
      id - the client-generated identifier to use, or null if server-generated identifier is requested.
      obj - the contents of the object to create in the object set.
      Returns:
      promise with config state populated if successful, otherwise exception promises, ie: NotFoundException: if the specified id could not be resolved. ForbiddenException: if access to the object or object set is forbidden. PreconditionFailedException: if an object with the same ID already exists. BadRequestException: if the passed identifier is invalid

    • handleUpdate

      public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException> handleUpdate(org.forgerock.services.context.Context context, org.forgerock.json.resource.UpdateRequest request)
      Specified by:
      handleUpdate in interface org.forgerock.json.resource.RequestHandler

    • handleDelete

      public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException> handleDelete(org.forgerock.services.context.Context context, org.forgerock.json.resource.DeleteRequest request)
      Specified by:
      handleDelete in interface org.forgerock.json.resource.RequestHandler

    • handlePatch

      public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException> handlePatch(org.forgerock.services.context.Context context, org.forgerock.json.resource.PatchRequest request)
      Specified by:
      handlePatch in interface org.forgerock.json.resource.RequestHandler

    • handleQuery

      public org.forgerock.util.promise.Promise<org.forgerock.json.resource.QueryResponse,org.forgerock.json.resource.ResourceException> handleQuery(org.forgerock.services.context.Context context, org.forgerock.json.resource.QueryRequest request, org.forgerock.json.resource.QueryResourceHandler handler)
      Specified by:
      handleQuery in interface org.forgerock.json.resource.RequestHandler

    • handleAction

      public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ActionResponse,org.forgerock.json.resource.ResourceException> handleAction(org.forgerock.services.context.Context context, org.forgerock.json.resource.ActionRequest request)
      Specified by:
      handleAction in interface org.forgerock.json.resource.RequestHandler

    • activate

      protected void activate(org.osgi.service.component.ComponentContext context)

    • deactivate

      protected void deactivate(org.osgi.service.component.ComponentContext context)

    • handleEvent

      public boolean handleEvent(ClusterEvent event)
      Description copied from interface: ClusterEventListener
      Notifies a listener that a ClusterEvent has fired
      Specified by:
      handleEvent in interface ClusterEventListener
      Parameters:
      event - a ClusterEvent object describing the event
      Returns:
      true if the event processing completed successfully

    • api

      public org.forgerock.api.models.ApiDescription api(org.forgerock.http.ApiProducer<org.forgerock.api.models.ApiDescription> producer)
      Specified by:
      api in interface org.forgerock.services.descriptor.Describable<org.forgerock.api.models.ApiDescription,org.forgerock.json.resource.Request>

    • handleApiRequest

      public org.forgerock.api.models.ApiDescription handleApiRequest(org.forgerock.services.context.Context context, org.forgerock.json.resource.Request request)
      Specified by:
      handleApiRequest in interface org.forgerock.services.descriptor.Describable<org.forgerock.api.models.ApiDescription,org.forgerock.json.resource.Request>

    • addDescriptorListener

      public void addDescriptorListener(org.forgerock.services.descriptor.Describable.Listener listener)
      Specified by:
      addDescriptorListener in interface org.forgerock.services.descriptor.Describable<org.forgerock.api.models.ApiDescription,org.forgerock.json.resource.Request>

    • removeDescriptorListener

      public void removeDescriptorListener(org.forgerock.services.descriptor.Describable.Listener listener)
      Specified by:
      removeDescriptorListener in interface org.forgerock.services.descriptor.Describable<org.forgerock.api.models.ApiDescription,org.forgerock.json.resource.Request>