Package org.forgerock.api.annotations

Annotation Type Patch

  • @Retention(RUNTIME)
@Target(METHOD)
public @interface Patch
    Indicates an CREST patch method on an annotated POJO. This annotation can be used on methods in both singleton and collection resource request handlers.

    The annotated method's return type must be:

    • A Promise<Resource, ? extends ResourceException> promise.
    The method must take the following parameters:
    • A org.forgerock.json.resource.PatchRequest to be given the request.
    If the annotated method is on a collection handler, it must also take the following parameters:
    • A string parameter for the instance identifier.
    The method may also take the following parameters:
    • A Context to be given the context.
    See Also:
    RequestHandler, SingletonProvider, CollectionProvider

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      Operation operationDescription
      Describe the standard operation details of this action.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      PatchOperation[] operations
      The set of patch operations supported by this request handler.

    • Element Detail

      • operationDescription

        Operation operationDescription
        Describe the standard operation details of this action.

      • operations

        PatchOperation[] operations
        The set of patch operations supported by this request handler. By default, all are supported.
        Default:
        {org.forgerock.api.enums.PatchOperation.ADD, org.forgerock.api.enums.PatchOperation.REMOVE, org.forgerock.api.enums.PatchOperation.REPLACE, org.forgerock.api.enums.PatchOperation.INCREMENT, org.forgerock.api.enums.PatchOperation.MOVE, org.forgerock.api.enums.PatchOperation.COPY, org.forgerock.api.enums.PatchOperation.TRANSFORM}