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.
RestCallLogger	Interface class used for logging HTTP requests to the log file.
RestCallLogger.Null	Represents no RestLogger.
RestConverter	REST method response converter.
RestInfoProvider	REST resource information provider.
RestInfoProvider.Null	Represents no RestInfoProvider.
RestLogger	Deprecated Use RestCallLogger
RestLogger.Null	Represents no RestLogger.
RestResourceResolver	Class used to resolve Class objects to instances.
RestResourceResolver.Null	Represents no RestResourceResolver.

Class Summary

Class	Description
BasicRest	Identical to BasicRestServlet but doesn't extend from HttpServlet.
BasicRestCallHandler	Default implementation of RestCallHandler.
BasicRestCallLogger	Default implementation of the RestCallLogger interface.
BasicRestGroup	Identical to BasicRestServletGroup but doesn't extend from HttpServlet.
BasicRestInfoProvider	Default implementation of RestInfoProvider.
BasicRestJena	Identical to BasicRestServletJena but doesn't extend from HttpServlet
BasicRestJenaGroup	Identical to BasicRestServletJenaGroup but doesn't extend from HttpServlet
BasicRestLogger	Deprecated Use BasicRestCallLogger
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.
BasicRestServletJena	Resource servlet with additional RDF support.
BasicRestServletJenaGroup	Resource group with additional RDF support.
ClientVersionMatcher	Specialized matcher for matching client versions.
HtmlDocBuilder	Deprecated Use HtmlDocConfig
Inherit	Dummy class that indicates that serializers, parsers, or transforms should be inherited from parent-class-to-class or class-to-method.
MessageBundleLocation	Message bundle location.
None	Dummy class that indicates that serializers, parsers, or transforms for a Java class or method should not be inherited.
NoOpRestLogger	Deprecated Use RestCallLogger
RequestAttributes	Represents the attributes in an HTTP request.
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.
RequestPath	Contains information about the matched path on the HTTP request.
RequestProperties	Deprecated Use RequestAttributes
RequestQuery	Represents the query parameters in an HTTP request.
ResponsePartMeta	Represents the information needed to serialize a response part such as a response header or body.
RestCall	A wrapper around a single HttpServletRequest/HttpServletResponse pair.
RestCallLoggerConfig	Represents a set of logging rules for how to handle logging of HTTP requests/responses.
RestCallLoggerConfig.Builder	Builder for RestCallLoggerConfig objects.
RestCallLoggerRule	Represents a logging rule used for determine how detailed requests should be logged at.
RestCallLoggerRule.Builder	Builder class for this object.
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 @Rest annotated object.
RestContextProperties	Encapsulates class-level properties.
RestGuard	REST method guard.
RestMatcher	Class used for defining method-level matchers using the @RestMethod(matchers) annotation.
RestMethodContext	Represents a single Java servlet/resource method annotated with @RestMethod.
RestMethodContextBuilder	Builder class for RestMethodContext objects.
RestMethodParam	REST java method parameter resolver.
RestMethodProperties	Deprecated Use RequestAttributes
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.
StaticFileMapping	Static file mapping.

Enum Summary

Enum	Description
Enablement	Represents the enablement settings of a feature.
RestCallLoggingDetail	Represents the amount of detail to include in a log entry for HTTP requests and responses.
RestParamType	Represents the possible parameter types as defined by the Swagger 2.0 specification.

Exception Summary

Exception	Description
HttpRuntimeException	A RuntimeException meant to wrap a non-RuntimeException.
RestException	Deprecated Use HttpException.
RestServletException	General exception thrown from RestServlet during construction or initialization.

Package org.apache.juneau.rest Description

REST Server API