Package org.forgerock.openam.http.annotations

This package contains annotations that can be used to declare HTTP methods for being handled by methods on a class. The Endpoints class provides a method that will convert an object with methods with these annotations on them into a Handler that can be bound to a router or returned as the application handler.

Since:

13.0.0

Interface Summary

Interface	Description
PayloadTranslator<T>	Translates from the input Reader to the type.

Class Summary

Class	Description
AnnotatedMethod	A method annotated with one of Get, Post, Put or Delete.
Endpoints	Convenience class for creating Handlers from classes that contain annotated methods that handle requests.

Annotation Types Summary

Annotation Type	Description
Consumes	The content type that is consumed by the method annotated with Post or Put.
Contextual	Mark a method parameter as provided from the http-framework context.
Delete	Specify a DELETE HTTP method endpoint.
ExceptionHandler	Mark a method that handles exceptions thrown by a service method and turns them into a response.
Get	Specify a GET HTTP method endpoint.
Path	Allows the declaration of a sub path for all methods in a class.
Payload	Mark a method parameter as the payload for Post and Put requests.
Post	Specify a POST HTTP method endpoint.
Produces	The content type of the response.
Put	Specify a PUT HTTP method endpoint.