Package io.muserver

This package contains the main API of mu-server, for example the server builders, request and response objects.

For more documentation, see the overview page.

See Also:

MuServerBuilder, MuRequest, MuResponse

Interface Summary

Interface	Description
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.
DoneCallback	A callback for async operations that calls when an operation completes.
Headers	HTTP headers
HttpConnection	A connection between a server and a client.
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.
MuServer	A web server handler.
MuStats	Various statistics about the current instance of a Mu Server.
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.
ProxiedConnectionInfo	Information about the connection provided by an intermediate proxy using the HA Proxy Protocol.
RateLimiter	A rate limiter.
RateLimitSelector	A function that controls how rate limits are applied.
RequestBodyListener	Callbacks for reading request body data asynchronously.
RequestParameters	Provides access to QueryString or Form values.
ResponseCompleteListener	A callback for listening to response completion events.
ResponseInfo	Information about a request and response.
RouteHandler	A handler for a Route created with MuServerBuilder.addHandler(Method, String, RouteHandler) or Routes.route(Method, String, RouteHandler)
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
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.

Class Summary

Class	Description
BaseWebSocket	A base class for server-side web sockets, that takes care of capturing the web socket session, responding to pings, and closure events.
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)
ForwardedHeader	Represents a Forwarded header as described by RFC-7239.
HeaderNames	Standard HTTP header names.
HeaderValues	Standard HTTP header values.
Http2Config	Configuration settings for HTTP2
Http2ConfigBuilder	Configuration builder for enabling HTTP2 by passing the config to MuServerBuilder.withHttp2Config(Http2ConfigBuilder)
HttpsConfigBuilder	A builder for specifying HTTPS config.
MediaTypeParser	A utility class to parse Media Type or Content Type values such as text/plain and text/plain; charset=UTF-8 etc
MuServerBuilder	A builder for creating a web server.
Mutils	Utility methods
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.
RateLimit	Specifies the limits allowed for a single value, such as an IP address.
RateLimitBuilder	A builder to create RateLimit objects.
Routes	A helper class to create a handler for a specific URL.
Toggles	Temporary features that might be removed without notice.
WebSocketHandler	A handler that can establish a web socket based on web socket upgrade requests.
WebSocketHandlerBuilder	Used to create handlers for web sockets.

Enum Summary

Enum	Description
Method	An HTTP Method
RateLimitRejectionAction	Specifies what to do when a rate limit is exceeded
ResponseState	The state of a response
WebsocketSessionState	The state of a websocket session

Exception Summary

Exception	Description
ClientDisconnectedException	Thrown when a client non-gracefully disconnects.
MuException	A generic exception raised by mu-server