Package org.forgerock.json.resource

Class DescribedSyncRequestHandlerAdapter

java.lang.Object
org.forgerock.json.resource.DescribedSyncRequestHandlerAdapter
All Implemented Interfaces:
RequestHandler, Describable<org.forgerock.api.models.ApiDescription,Request>
public class DescribedSyncRequestHandlerAdapter extends Object implements Describable<org.forgerock.api.models.ApiDescription,Request>
Version of SynchronousRequestHandlerAdapter that exposes a described handler.

  • Method Details

    • api

      public org.forgerock.api.models.ApiDescription api(ApiProducer<org.forgerock.api.models.ApiDescription> producer)
      Description copied from interface: Describable
      Provide the API description for the component. This method should perform the heavy-lifting of computing the API descriptor, and should be expected to be called rarely. Upstream handlers should call this method in order to compose all of their downstream API Descriptors into a single descriptor.
      Specified by:
      api in interface Describable<org.forgerock.api.models.ApiDescription,Request>
      Parameters:
      producer - The API producer that provides general information to be built into the descriptor.
      Returns:
      The description object.

    • handleApiRequest

      public org.forgerock.api.models.ApiDescription handleApiRequest(Context context, Request request)
      Description copied from interface: Describable
      Handle a request for the API Descriptor. This method should not do any computation, but should return the already computed descriptor.
      Specified by:
      handleApiRequest in interface Describable<org.forgerock.api.models.ApiDescription,Request>
      Parameters:
      context - The request context.
      request - The request.
      Returns:
      The descriptor.

    • addDescriptorListener

      public void addDescriptorListener(Describable.Listener listener)
      Description copied from interface: Describable
      Add a listener for API Descriptor changes. The described object should call all the listeners.
      Specified by:
      addDescriptorListener in interface Describable<org.forgerock.api.models.ApiDescription,Request>
      Parameters:
      listener - The listener.

    • removeDescriptorListener

      public void removeDescriptorListener(Describable.Listener listener)
      Description copied from interface: Describable
      Remove a listener from API Descriptor changes.
      Specified by:
      removeDescriptorListener in interface Describable<org.forgerock.api.models.ApiDescription,Request>
      Parameters:
      listener - The listener.

    • handleUpdate

      public Promise<ResourceResponse,ResourceException> handleUpdate(Context context, UpdateRequest request)
      Description copied from interface: RequestHandler
      Updates a JSON resource by replacing its existing content with new content, returning a Promise that will be completed when the resource has been updated.

      Update expects failure the following failure exceptions:

      • ForbiddenException if access to the resource is forbidden
      • NotSupportedException if the requested functionality is not implemented/supported
      • PreconditionRequiredException if version is required, but is null
      • PreconditionFailedException if version did not match the existing resource
      • BadRequestException if the passed identifier or filter is invalid
      • NotFoundException if the specified resource could not be found.
      Specified by:
      handleUpdate in interface RequestHandler
      Parameters:
      context - The request server context, such as associated principal.
      request - The update request.
      Returns:
      A Promise containing the result of the operation.

    • handleRead

      public Promise<ResourceResponse,ResourceException> handleRead(Context context, ReadRequest request)
      Description copied from interface: RequestHandler
      Reads a JSON resource, returning a Promise that will be completed when the resource has been read.

      Read expects failure exceptions as follows:

      • ForbiddenException if access to the resource is forbidden.
      • NotSupportedException if the requested functionality is not implemented/supported
      • BadRequestException if the passed identifier or filter is invalid
      • NotFoundException if the specified resource could not be found.
      Specified by:
      handleRead in interface RequestHandler
      Parameters:
      context - The request server context, such as associated principal.
      request - The read request.
      Returns:
      A Promise containing the result of the operation.

    • handleQuery

      public Promise<QueryResponse,ResourceException> handleQuery(Context context, QueryRequest request, QueryResourceHandler handler)
      Description copied from interface: RequestHandler
      Searches for all JSON resources matching a user specified set of criteria, returning a Promise that will be completed when the search has completed.

      Implementations must invoke QueryResourceHandler.handleResource(ResourceResponse) for each resource which matches the query criteria. Once all matching resources have been returned implementations are required to return either a QueryResponse if the query has completed successfully, or ResourceException if the query did not complete successfully (even if some matching resources were returned).

      Query expects failure exceptions as follows:

      • ForbiddenException if access to the resource is forbidden
      • NotSupportedException if the requested functionality is not implemented/supported
      • BadRequestException if the passed identifier, parameters or filter is invalid
      • NotFoundException if the specified resource could not be found
      Specified by:
      handleQuery in interface RequestHandler
      Parameters:
      context - The request server context, such as associated principal.
      request - The query request.
      handler - The query resource handler to be notified for each matching resource.
      Returns:
      A Promise containing the result of the operation.

    • handlePatch

      public Promise<ResourceResponse,ResourceException> handlePatch(Context context, PatchRequest request)
      Description copied from interface: RequestHandler
      Updates a JSON resource by applying a set of changes to its existing content, returning a Promise that will be completed when the resource has been updated.

      Patch expects failure exceptions as follows:

      • ForbiddenException if access to the resource is forbidden
      • NotSupportedException if the requested functionality is not implemented/supported
      • PreconditionRequiredException if version is required, but is null
      • PreconditionFailedException if version did not match the existing resource
      • BadRequestException if the passed identifier or filter is invalid
      • NotFoundException if the specified resource could not be found
      • ConflictException if patch could not be applied for the given resource state.
      Specified by:
      handlePatch in interface RequestHandler
      Parameters:
      context - The request server context, such as associated principal.
      request - The patch request.
      Returns:
      A Promise containing the result of the operation.

    • handleDelete

      public Promise<ResourceResponse,ResourceException> handleDelete(Context context, DeleteRequest request)
      Description copied from interface: RequestHandler
      Deletes a JSON resource, returning a Promise that will be completed when the resource has been deleted.

      Delete expects failure exceptions as follows:

      • ForbiddenException if access to the resource is forbidden
      • NotSupportedException if the requested functionality is not implemented/supported
      • BadRequestException if the passed identifier is invalid
      • NotFoundException if the specified resource could not be found
      • PreconditionRequiredException if version is required, but is null
      • PreconditionFailedException if version did not match the existing resource.
      Specified by:
      handleDelete in interface RequestHandler
      Parameters:
      context - The request server context, such as associated principal.
      request - The delete request.
      Returns:
      A Promise containing the result of the operation.

    • handleCreate

      public Promise<ResourceResponse,ResourceException> handleCreate(Context context, CreateRequest request)
      Description copied from interface: RequestHandler
      Adds a new JSON resource, returning a Promise that will be completed when the resource has been added.

      Create expects failure exceptions as follows:

      • CreateNotSupportedException if create is not implemented or supported by the RequestHandler.
      • ForbiddenException if access to the resource is forbidden.
      • NotSupportedException if the requested functionality is not implemented/supported
      • PreconditionFailedException if a resource with the same ID already exists
      • BadRequestException if the passed identifier or value is invalid
      • NotFoundException if the specified id could not be resolved, for example when an intermediate resource in the hierarchy does not exist.
      Specified by:
      handleCreate in interface RequestHandler
      Parameters:
      context - The request server context, such as associated principal.
      request - The create request.
      Returns:
      A Promise containing the result of the operation.

    • handleAction

      public Promise<ActionResponse,ResourceException> handleAction(Context context, ActionRequest request)
      Description copied from interface: RequestHandler
      Handles performing an action on a resource, and optionally returns an associated result. The execution of an action is allowed to incur side effects.

      Actions are parametric; a set of named parameters is provided as input to the action. The action result is a JSON object structure composed of basic Java types; its overall structure is defined by a specific implementation.

      On completion, the action result (or null) must be used to complete the returned Promise. On failure, the returned Promise must be completed with the exception.

      Action expects failure exceptions as follows: ForbiddenException if access to the resource is forbidden. NotSupportedException if the requested functionality is not implemented/supported BadRequestException if the passed identifier, parameters or filter is invalid NotFoundException if the specified resource could not be found.

      Specified by:
      handleAction in interface RequestHandler
      Parameters:
      context - The request server context, such as associated principal.
      request - The action request.
      Returns:
      A Promise containing the result of the operation.