Package org.forgerock.opendj.rest2ldap

Class DescribableRequestHandler

java.lang.Object
org.forgerock.opendj.rest2ldap.DescribableRequestHandler
All Implemented Interfaces:
org.forgerock.json.resource.RequestHandler, org.forgerock.services.descriptor.Describable<org.forgerock.api.models.ApiDescription,org.forgerock.json.resource.Request>
public class DescribableRequestHandler extends Object implements org.forgerock.json.resource.RequestHandler, org.forgerock.services.descriptor.Describable<org.forgerock.api.models.ApiDescription,org.forgerock.json.resource.Request>
Decorator for a request handler that can return an api descriptor of the underlying handler.

  • 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
    DescribableRequestHandler(org.forgerock.json.resource.RequestHandler handler)
    Builds an object decorating the provided handler.

  • Method Summary

    Modifier and Type
    Method
    Description
    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)
     
    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)
     
    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)
     
    protected org.forgerock.services.context.Context
    wrap(org.forgerock.services.context.Context context)
    Allows sub classes to wrap the provided context and return the wrapping context.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DescribableRequestHandler

      public DescribableRequestHandler(org.forgerock.json.resource.RequestHandler handler)
      Builds an object decorating the provided handler.
      Parameters:
      handler - the handler to decorate.

  • Method Details

    • 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

    • 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

    • 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

    • 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

    • 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

    • wrap

      protected org.forgerock.services.context.Context wrap(org.forgerock.services.context.Context context)
      Allows sub classes to wrap the provided context and return the wrapping context.
      Parameters:
      context - the context to wrap
      Returns:
      the wrapping context that should be used

    • 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>