All Classes

Class	Description
ApiResponse	Describes a response code and description for an API method, for documentation purposes.
ApiResponses	Describes multiple response codes and descriptions for an API method, for documentation purposes.
AsyncHandle	A class to handle the request and response handling when using asynchronous request handling.
AsyncSsePublisher	An interface for sending Server-Sent Events (SSE) to a client with async callbacks.
Authorizer	A class that can check if a principle is in a given role.
BareDirectoryRequestAction	An action to take for a request to a directory where the path does not have a trailing slash.
BaseWebSocket	A base class for server-side web sockets, that takes care of capturing the web socket session, responding to pings, and closure events.
BasicAuthSecurityFilter	A filter that can handle Basic Authentication
CallbackObject
CallbackObjectBuilder	A map of possible out-of band callbacks related to the parent operation.
ClientDisconnectedException	Thrown when a client non-gracefully disconnects.
CollectionParameterStrategy	Specifies how to handle lists or sets in querystring parameters
ComponentsObject
ComponentsObjectBuilder	Holds a set of reusable objects for different aspects of the OAS.
ContactObject
ContactObjectBuilder	Contact information for the exposed API.
ContentTypes	String constants for content-types
ContextHandler	A handler that wraps a list of other handlers and serves them at a certain path prefix (or context).
ContextHandlerBuilder	Use this to serve a list of handlers from a base path.
Cookie	A cookie that is sent from the server to the client.
CookieBuilder	A builder to create cookies that will be sent on a Response with MuResponse.addCookie(Cookie)
CORSConfig	CORS configuration for REST resources.
CORSConfigBuilder	A builder to set configuration for CORS requests.
CORSHandler	A handler that adds CORS headers to responses.
CORSHandlerBuilder	Used to create a handler that puts appropriate CORS headers on requests.
Description	Provides a description of a class, method, or parameter for use in documentation.
DiscriminatorObject
DiscriminatorObjectBuilder	When request bodies or response payloads may be one of a number of different schemas, a discriminator object can be used to aid in serialization, deserialization, and validation.
DoneCallback	A callback for async operations that calls when an operation completes.
EncodingObject
EncodingObjectBuilder	A single encoding definition applied to a single schema property.
ExampleObject
ExampleObjectBuilder	A builder for ExampleObject objects
ExternalDocumentationObject
ExternalDocumentationObjectBuilder	Allows referencing an external resource for extended documentation.
ForwardedHeader	Represents a Forwarded header as described by RFC-7239.
HeaderNames	Standard HTTP header names.
HeaderObject
HeaderObjectBuilder	A builder for HeaderObject objects
Headers	HTTP headers
HeaderValues	Standard HTTP header values.
Http2Config	Configuration settings for HTTP2
Http2ConfigBuilder	Configuration builder for enabling HTTP2 by passing the config to MuServerBuilder.withHttp2Config(Http2ConfigBuilder)
HttpConnection	A connection between a server and a client.
HttpsConfigBuilder	A builder for specifying HTTPS config.
HttpsRedirector	Sends any HTTP requests to the same HTTPS address at the supplied port and optionally enables Strict-Transport-Security (HSTS)
HttpsRedirectorBuilder	A builder for a handler that sends any HTTP requests to the same HTTPS address at the supplied port and optionally enables Strict-Transport-Security (HSTS)
InfoObject
InfoObjectBuilder	The object provides metadata about the API.
LicenseObject
LicenseObjectBuilder	License information for the exposed API.
LinkObject
LinkObjectBuilder	The Link object represents a possible design-time link for a response.
MediaTypeObject
MediaTypeObjectBuilder	Each Media Type Object provides schema and examples for the media type identified by its key.
MediaTypeParser	A utility class to parse Media Type or Content Type values such as text/plain and text/plain; charset=UTF-8 etc
Method	An HTTP Method
MuException	A generic exception raised by mu-server
MuHandler	An HTTP request handler.
MuHandlerBuilder<T extends MuHandler>	A builder for MuHandler objects
MuRequest	An HTTP request from a client.
MuResponse	A response sent to a client.
MuRuntimeDelegate	The JAX-RS runtime delegate for mu-server.
MuServer	A web server handler.
MuServerBuilder	A builder for creating a web server.
MuStats	Various statistics about the current instance of a Mu Server.
Mutils	Utility methods
MuWebSocket	An interface defining the callbacks received on a websocket which is returned by MuWebSocketFactory.create(MuRequest, Headers).
MuWebSocketFactory	A factory that can convert an upgrade request into a web socket.
MuWebSocketSession	A web socket session used to send messages and events to a web socket client.
OAuthFlowObject
OAuthFlowObjectBuilder	Configuration details for a supported OAuth Flow
OAuthFlowsObject
OAuthFlowsObjectBuilder	Allows configuration of the supported OAuth Flows.
OpenAPIObject
OpenAPIObjectBuilder	This is the root document object of the OpenAPI document.
OperationObject
OperationObjectBuilder	Describes a single API operation on a path.
ParameterizedHeader	A utility class to parse headers that are of the format param1, param2=value, param3="quoted string" such as Cache-Control etc.
ParameterizedHeaderWithValue	A utility class to parse headers that are of the format name; param1=value; param2="quoted string" such as Content-Type, Accepts, Content-Disposition etc.
ParameterObject
ParameterObjectBuilder	Describes a single operation parameter.
PathItemObject
PathItemObjectBuilder	Describes the operations available on a single path.
PathMatch	The result of matching a template URI against a real request URI.
PathsObject
PathsObjectBuilder	Holds the relative paths to the individual endpoints and their operations.
ProxiedConnectionInfo	Information about the connection provided by an intermediate proxy using the HA Proxy Protocol.
RateLimit	Specifies the limits allowed for a single value, such as an IP address.
RateLimitBuilder	A builder to create RateLimit objects.
RateLimiter	A rate limiter.
RateLimitRejectionAction	Specifies what to do when a rate limit is exceeded
RateLimitSelector	A function that controls how rate limits are applied.
RequestBodyListener	Callbacks for reading request body data asynchronously.
RequestBodyObject
RequestBodyObjectBuilder	Describes a single request body.
RequestParameters	Provides access to QueryString or Form values.
Required	Specifies that a parameter in a rest method is required
ResourceCustomizer	A hook to change responses for static resources.
ResourceHandler	A handler to serve static content.
ResourceHandlerBuilder	Used to create a ResourceHandler for serving static files.
ResourceType	Used by the ResourceHandler to specify a mapping between file name extensions and mime types, and whether they should be gzipped or not.
ResponseCompleteListener	A callback for listening to response completion events.
ResponseHeader	Describes an HTTP Header that is returned by a rest method.
ResponseInfo	Information about a request and response.
ResponseObject
ResponseObjectBuilder	Describes a single response from an API Operation, including design-time, static links to operations based on the response.
ResponsesObject
ResponsesObjectBuilder	A container for the expected responses of an operation.
ResponseState	The state of a response
RestHandler	A handler that serves JAX-RS resources.
RestHandlerBuilder	Used to create a RestHandler for handling JAX-RS REST resources.
RouteHandler	A handler for a Route created with MuServerBuilder.addHandler(Method, String, RouteHandler) or Routes.route(Method, String, RouteHandler)
Routes	A helper class to create a handler for a specific URL.
SchemaObject
SchemaObjectBuilder	The Schema Object allows the definition of input and output data types.
SchemaObjectCustomizer	A class that can customize the SchemaObjects generated in OpenAPI documents for JAX-RS resources.
SchemaObjectCustomizerContext	Provides the context that a SchemaObject is in when customizing the schema in a SchemaObjectCustomizer
SchemaObjectCustomizerTarget	The aspect of the API that a SchemaObject refers to
SecurityRequirementObject
SecurityRequirementObjectBuilder	Lists the required security schemes to execute this operation.
SecuritySchemeObject
SecuritySchemeObjectBuilder	Defines a security scheme that can be used by the operations.
ServerObject
ServerObjectBuilder	An object representing a Server.
ServerVariableObject
ServerVariableObjectBuilder	An object representing a Server Variable for server URL template substitution.
SsePublisher	An interface for sending Server-Sent Events (SSE) to a client.
SSLCipherFilter	A filter allowing the selection of SSL certificates
SSLInfo	Information about the SSL settings being used by the server
TagObject
TagObjectBuilder	Adds metadata to a single tag that is used by the OperationObject.
Toggles	Temporary features that might be removed without notice.
UnhandledExceptionHandler	A handler for exceptions that have been thrown by other handlers which allows for custom error pages.
UploadedFile	A file uploaded by the user, for example with an <input type="file" name="name"> input field in a multipart form.
UriPattern	A pattern representing a URI template, such as /fruit or /fruit/{name} etc.
UserPassAuthenticator	An authenticator used by BasicAuthSecurityFilter which can look up a user based on a username and password.
WebSocketHandler	A handler that can establish a web socket based on web socket upgrade requests.
WebSocketHandlerBuilder	Used to create handlers for web sockets.
WebsocketSessionState	The state of a websocket session
XmlObject
XmlObjectBuilder	A metadata object that allows for more fine-tuned XML model definitions.