Package org.apache.juneau.rest.server
package org.apache.juneau.rest.server
REST Server API
-
ClassDescriptionAbstractRestBuilder<R,
SELF extends AbstractRestBuilder<R, SELF>> Shared abstract base for theRestBuilderflavor builders (RestServlet.Builder,RestResource.Builder,RestMixin.Builder).REST request attribute annotation.Host-side setting seed for the@Rest(childrenDefs=...)attribute.Utility classes and methods for the@Childannotation.Builder class.Internal utility for recognizing failures caused by the client disconnecting before the response completed.Dummy class that indicates that serializers, parsers, or transforms should be inherited from parent-class-to-class or class-to-method.Annotation that can be applied to a parameter of a@RestOpannotated method to identify it as the HTTP method.Which HTTP methods are safe, and the startup check that an operation declaredMutatingis not bound to one of them.Rich mixin definition for the@Rest(mixinDefs=...)attribute.Utility classes and methods for the@Mixinannotation.Builder class.Declares that a REST operation changes state, so that binding it to an HTTP method defined as safe becomes a startup failure instead of a silent mistake.Dummy class that indicates that serializers, parsers, or transforms for a Java class or method should not be inherited.Extended annotation forRestOp.swagger().Utility classes and methods for the@OpSwaggerannotation.Builder class.Configuration for the always-on request-id correlation resolver run atRestSessionbuild time.Builder forRequestIdSettings.A supplier of a REST resource bean.Used to denote that a class is a REST resource and to associate metadata on it.Utility classes and methods for the@Restannotation.Builder class.RestBuilder<SELF extends RestBuilder<SELF>>Public, fluent, self-typed configuration surface for programmatically configuring a@Restresource, child resource, or mixin instead of (or in addition to) the@Restannotation.Represents a matchedRest-annotated child on an HTTP request.Implements the child resources of aRest-annotated class.Builder class.Defines the initial configuration of aRestServlet or@Rest annotated object.Bootstrap arguments forRestContext.The build-time kind of aRestContext— which of the three construction flavors produced it.A routed child resource (mounted viaRest.children()/Rest.childrenDefs()); isolated resolution, with an optional host-seeded@Childpayload injected at the least-derived slot of its own annotation chain (see the class javadoc above).A per-mixin sub-context (composed viaRest.mixins()/Rest.mixinDefs()); inherits the host chain.A top-level (host) resource, mock context, or servlet-mounted resource.Normalized carrier for a routed child, produced by discovery from either a bareRest.children()class or a rich@Childdeclaration — the exact structural analog ofRestContext.ResolvedMixin.The discovery-time normalized declaration of a single mixin.The env-drivenRestContext.*default properties for a resource, resolved as a single bound object.Identifies a REST DELETE operation Java method on aRestServletimplementation class.Utility classes and methods for the@RestDeleteannotation.Builder class.Identifies a method that gets called during servlet destroy.Utility classes and methods for the@RestDestroyannotation.Builder class.Identifies a method that gets called right before we exit the servlet service method.Utility classes and methods for the@RestEndCallannotation.Builder class.Identifies a REST GET operation Java method on aRestServletimplementation class.Utility classes and methods for the@RestGetannotation.Builder class.Identifies a method that gets called during servlet initialization.Utility classes and methods for the@RestInitannotation.Builder class.Identifies a REST operation Java method on aRestServletimplementation class.Utility classes and methods for the@RestOpannotation.Builder class.Represents a single Java servlet/resource method annotated with@RestOp.Builder class.A specialized invoker for methods that are called during a servlet request.A session for a single HTTP request.Builder class.Identifies a REST OPTIONS operation Java method on aRestServletimplementation class.Utility classes and methods for the@RestOptionsannotation.Builder class.Identifies a REST PATH operation Java method on aRestServletimplementation class.Utility classes and methods for the@RestPatchannotation.Builder class.Identifies a REST POST operation Java method on aRestServletimplementation class.Utility classes and methods for the@RestPostannotation.Builder class.Identifies a method that gets called immediately after the@RestOp annotated method gets called.Utility classes and methods for the@RestPostCallannotation.Builder class.Identifies a method that gets called immediately after servlet initialization.Utility classes and methods for the@RestPostInitannotation.Builder class.Identifies a method that gets called immediately before the@RestOp annotated method gets called.Utility classes and methods for the@RestPreCallannotation.Builder class.Identifies a REST PUT operation Java method on aRestServletimplementation class.Utility classes and methods for the@RestPutannotation.Builder class.Represents an HTTP request for a REST resource.Represents an HTTP response for a REST resource.Represents a single HTTP request.Builder class.Identifies a method that is called immediately after theHttpServlet.service(HttpServletRequest, HttpServletResponse) method is called.Utility classes and methods for the@RestStartCallannotation.Builder class.Extended annotation for@Rest(swagger).Utility classes and methods for the@Swaggerannotation.Builder class.