Package org.forgerock.api.annotations

Annotation Type RequestHandler

  • @Retention(RUNTIME)
@Target(TYPE)
public @interface RequestHandler
    A marker annotation to indicate that the annotated class should be interpreted as an annotated CREST request handler.

    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 query methods.
    Note that action methods do not have a convention and MUST be annotated using the Action annotation.
    See Also:
    Create, Read, Update, Delete, Patch, Action, Query, Queries

    • Required Element Summary

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

    • Element Detail

      • value

        Handler value
        The details of the handler.