Package org.forgerock.api.annotations

Annotation Type Read

  • @Retention(RUNTIME)
@Target(METHOD)
public @interface Read
    Indicates an CREST read 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.
    If the annotated method is on a collection handler, it must 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.
    • A org.forgerock.json.resource.ReadRequest to be given the request.
    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.

    • Element Detail

      • operationDescription

        Operation operationDescription
        Describe the standard operation details of this action.