Package org.apache.juneau.rest

REST Server API

See: Description

Interface Summary

Interface	Description
BasicRestConfig	Basic configuration for a REST resource.
ResponseHandler	Defines the interface for handlers that convert POJOs to appropriate HTTP responses.
RestCallHandler	Class that handles the basic lifecycle of an HTTP REST call.
RestCallHandler.Null	Represents no RestCallHandler.
RestConverter	REST method response converter.
RestInfoProvider	REST resource information provider.
RestInfoProvider.Null	Represents no RestInfoProvider.
RestLogger	Logging utility class.
RestLogger.Null	Represents no RestLogger.
RestResourceResolver	Class used to resolve Class objects to instances.
RestResourceResolver.Null	Represents no RestResourceResolver.

Class Summary

Class	Description
BasicRestCallHandler	Default implementation of RestCallHandler.
BasicRestInfoProvider	Default implementation of RestInfoProvider.
BasicRestLogger	Logging utility class.
BasicRestResourceResolver	Denotes the default resolver for child resources.
BasicRestServlet	Subclass of RestServlet with default serializers and parsers defined.
BasicRestServletGroup	Specialized subclass of BasicRestServlet for showing "group" pages.
ClientVersionMatcher	Specialized matcher for matching client versions.
FinishablePrintWriter	A wrapped PrintWriter with an added finish() method.
FinishableServletOutputStream	A wrapped ServletOutputStream with an added finish() method.
HtmlDocBuilder	Programmatic interface for setting properties used by the HtmlDoc serializer.
MessageBundleLocation	Message bundle location.
NoOpRestLogger	Logging utility class.
ReaderResource	Represents the contents of a text file with convenience methods for resolving SVL variables and adding HTTP response headers.
ReaderResourceBuilder	Builder class for constructing ReaderResource objects.
Redirect	REST methods can return this object as a shortcut for performing HTTP 302 redirects.
RequestBody	Contains the body of the HTTP request.
RequestFormData	Represents the parsed form-data parameters in an HTTP request.
RequestHeaders	Represents the headers in an HTTP request.
RequestPathMatch	Contains information about the matched path on the HTTP request.
RequestProperties	Encapsulates request-level properties.
RequestQuery	Represents the query parameters in an HTTP request.
RestCallRouter	Represents a group of CallMethods on a REST resource that handle the same HTTP Method name but with different paths/matchers/guards/etc...
RestChild	Represents a simple child REST resource / path mapping.
RestContext	Contains all the configuration on a REST resource and the entry points for handling REST calls.
RestContextBuilder	Defines the initial configuration of a RestServlet or @RestResource annotated object.
RestContextProperties	Encapsulates class-level properties.
RestGuard	REST method guard.
RestJavaMethod	Represents a single Java servlet/resource method annotated with @RestMethod.
RestMatcher	Class used for defining method-level matchers using the @RestMethod.matchers() annotation.
RestMethodProperties	Encapsulates java-method-level properties.
RestParam	REST java method parameter resolver.
RestRequest	Represents an HTTP request for a REST resource.
RestResponse	Represents an HTTP response for a REST resource.
RestServlet	Servlet implementation of a REST resource.
RestUtils	Various reusable utility methods.
StaticFileMapping	Static file mapping.
StreamResource	Represents the contents of a byte stream file with convenience methods for adding HTTP response headers.
StreamResourceBuilder	Builder class for constructing StreamResource objects.
UrlPathPattern	A parsed path pattern constructed from a @RestMethod.path() value.

Enum Summary

Enum	Description
RestParamType	Represents the possible parameter types as defined by the Swagger 2.0 specification.

Exception Summary

Exception	Description
RestException	Exception thrown to trigger an error HTTP status.
RestServletException	General exception thrown from RestServlet during construction or initialization.

Package org.apache.juneau.rest Description

REST Server API