Package org.forgerock.api.annotations

Annotation Type Handler

  • public @interface Handler
    Details of a handler.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      boolean mvccSupported
      Whether MVCC style requests are supported.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      String description
      Service description, for documentation purposes.
      String id
      The service identifier.
      Parameter[] parameters
      Parameters on service paths and/or endpoints.
      Schema resourceSchema
      The schema for all the standard resource operations (CRUDPQ) on this endpoint.
      String title
      Service title, for documentation purposes.

    • Element Detail

      • mvccSupported

        boolean mvccSupported
        Whether MVCC style requests are supported.

      • id

        String id
        The service identifier.
        If a value is provided this indicates to the API Descriptor framework that you intend to reuse the same service definition multiple times, and that it should define the service globally and bind it to paths by reference instead of by value.
        Example: 
        
 "services": {
   "users:1.0": {
     "type": "collection",
     "resourceSchema": {
       "$ref": "#/definitions/user"
     },
     ...
   }
 }
 "paths": {
   "/users": {
     "1.0": {
       "$ref": "#/services/users:1.0"
     },
   }
 }
        Default:
        ""

      • resourceSchema

        Schema resourceSchema
        The schema for all the standard resource operations (CRUDPQ) on this endpoint. Only required if one or more of those operations are supported.
        Default:
        @org.forgerock.api.annotations.Schema

      • title

        String title
        Service title, for documentation purposes.
        Default:
        ""

      • description

        String description
        Service description, for documentation purposes.
        Default:
        ""

      • parameters

        Parameter[] parameters
        Parameters on service paths and/or endpoints.
        Default:
        {}