Package org.forgerock.api.annotations

Annotation Interface CollectionProvider

@Retention(RUNTIME) @Target(TYPE) public @interface CollectionProvider
A marker annotation to indicate that the annotated class should be interpreted as an annotated CREST collection provider resource.

Individual operations can then be supported by either annotating a method with the relevant annotation, or by naming the method according to the following convention:

  • create for create methods.
  • read for read methods.
  • update for update methods.
  • delete for delete methods.
  • patch for patch methods.
  • query for generic query methods.
Note that action methods do not have a convention and MUST be annotated using the Action annotation.
See Also:

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    Handler
    details
    The details of the handler.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Parameter
    pathParam
    The name of the path parameter to use in the path descriptors.

  • Element Details

    • pathParam

      Parameter pathParam
      The name of the path parameter to use in the path descriptors.
      Default:
      @org.forgerock.api.annotations.Parameter(name="id", type="string")