A B C D E F G H I J K L M N O P Q R S T U V W X Z
All Classes All Packages

A

accept() - Method in interface io.muserver.Headers

Gets the Accept-Charset header value.

ACCEPT - Static variable in class io.muserver.HeaderNames

"accept"

ACCEPT_CHARSET - Static variable in class io.muserver.HeaderNames

"accept-charset"

ACCEPT_ENCODING - Static variable in class io.muserver.HeaderNames

"accept-encoding"

ACCEPT_LANGUAGE - Static variable in class io.muserver.HeaderNames

"accept-language"

ACCEPT_PATCH - Static variable in class io.muserver.HeaderNames

"accept-patch"

ACCEPT_RANGES - Static variable in class io.muserver.HeaderNames

"accept-ranges"

acceptCharset() - Method in interface io.muserver.Headers

Gets the Accept header value.

acceptEncoding() - Method in interface io.muserver.Headers

Gets the Accept-Encoding header value.

acceptLanguage() - Method in interface io.muserver.Headers

Gets the Accept-Language header value.

ACCESS_CONTROL_ALLOW_CREDENTIALS - Static variable in class io.muserver.HeaderNames

"access-control-allow-credentials"

ACCESS_CONTROL_ALLOW_HEADERS - Static variable in class io.muserver.HeaderNames

"access-control-allow-headers"

ACCESS_CONTROL_ALLOW_METHODS - Static variable in class io.muserver.HeaderNames

"access-control-allow-methods"

ACCESS_CONTROL_ALLOW_ORIGIN - Static variable in class io.muserver.HeaderNames

"access-control-allow-origin"

ACCESS_CONTROL_EXPOSE_HEADERS - Static variable in class io.muserver.HeaderNames

"access-control-expose-headers"

ACCESS_CONTROL_MAX_AGE - Static variable in class io.muserver.HeaderNames

"access-control-max-age"

ACCESS_CONTROL_REQUEST_HEADERS - Static variable in class io.muserver.HeaderNames

"access-control-request-headers"

ACCESS_CONTROL_REQUEST_METHOD - Static variable in class io.muserver.HeaderNames

"access-control-request-method"

activeConnections() - Method in interface io.muserver.MuServer

activeConnections() - Method in interface io.muserver.MuStats

activeRequests() - Method in interface io.muserver.HttpConnection

activeRequests() - Method in interface io.muserver.MuStats

activeWebsockets() - Method in interface io.muserver.HttpConnection

The websockets on this connection.

add(Headers) - Method in interface io.muserver.Headers

Adds all headers from another headers object to this

add(CharSequence, Iterable<?>) - Method in interface io.muserver.Headers

Adds an item to these headers.

add(CharSequence, Object) - Method in interface io.muserver.Headers

Adds an item to these headers.

add(String, Iterable<?>) - Method in interface io.muserver.Headers

Adds an item to these headers.

add(String, Object) - Method in interface io.muserver.Headers

Adds an item to these headers.

addAsyncHandler(AsyncMuHandler) - Method in class io.muserver.MuServerBuilder

Deprecated.

For async handling, add a normal MuHandler and call MuRequest.handleAsync()

addCookie(Cookie) - Method in interface io.muserver.MuResponse

Sends a cookie to the client.

addCustomParamConverter(Class<P>, ParamConverter<P>) - Method in class io.muserver.rest.RestHandlerBuilder

Registers a parameter converter class that convert strings to and from a custom class.

addCustomParamConverterProvider(ParamConverterProvider) - Method in class io.muserver.rest.RestHandlerBuilder

Registers an object that can convert rest method parameters (e.g.

addCustomReader(MessageBodyReader<T>) - Method in class io.muserver.rest.RestHandlerBuilder

Registers an object that can deserialise request bodies into custom classes.

addCustomSchema(Class<?>, SchemaObject) - Method in class io.muserver.rest.RestHandlerBuilder

Registers a custom OpenAPI schema description for the given class.

addCustomWriter(MessageBodyWriter<T>) - Method in class io.muserver.rest.RestHandlerBuilder

Registers an object that can write custom classes to responses.

addExceptionMapper(Class<T>, ExceptionMapper<T>) - Method in class io.muserver.rest.RestHandlerBuilder

Adds a mapper that converts an exception to a response.

addHandler(Method, String, RouteHandler) - Method in class io.muserver.ContextHandlerBuilder

Registers a new handler that will only be called if it matches the given route info (relative to the current context).

addHandler(Method, String, RouteHandler) - Method in class io.muserver.MuServerBuilder

Registers a new handler that will only be called if it matches the given route info

addHandler(MuHandler) - Method in class io.muserver.ContextHandlerBuilder

Adds a request handler relative to the context of this builder.

addHandler(MuHandler) - Method in class io.muserver.MuServerBuilder

Adds a request handler.

addHandler(MuHandlerBuilder) - Method in class io.muserver.ContextHandlerBuilder

Adds a request handler relative to the context of this builder.

addHandler(MuHandlerBuilder) - Method in class io.muserver.MuServerBuilder

Adds a request handler.

addInt(CharSequence, int) - Method in interface io.muserver.Headers

Adds an integer value

additionalProperties - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.additionalProperties() instead

additionalProperties() - Method in class io.muserver.openapi.SchemaObject

additionalProperties() - Method in class io.muserver.openapi.SchemaObjectBuilder

addReaderInterceptor(ReaderInterceptor) - Method in class io.muserver.rest.RestHandlerBuilder

Registers a reader interceptor allowing for inspection and alteration of request bodies.

addRequestFilter(ContainerRequestFilter) - Method in class io.muserver.rest.RestHandlerBuilder

Registers a request filter, which is run before a rest method is executed.

addResource(Object...) - Method in class io.muserver.rest.RestHandlerBuilder

Adds one or more rest resources to this handler

addResponseCompleteHandler(ResponseCompleteListener) - Method in interface io.muserver.AsyncHandle

Add a listener for when request processing is complete.

addResponseCompleteListener(ResponseCompleteListener) - Method in class io.muserver.MuServerBuilder

Adds a listener that is notified when each response completes

addResponseFilter(ContainerResponseFilter) - Method in class io.muserver.rest.RestHandlerBuilder

Registers a response filter, which is called after execution of a method takes place.

address() - Method in interface io.muserver.MuServer

addSchemaObjectCustomizer(SchemaObjectCustomizer) - Method in class io.muserver.rest.RestHandlerBuilder

Registers an object that is able to customize SchemaObjects generated by this rest handler for OpenAPI documentation.

addShort(CharSequence, short) - Method in interface io.muserver.Headers

Deprecated.

use an alternative such as Headers.addInt(CharSequence, int)

addShutdownHook(boolean) - Method in class io.muserver.MuServerBuilder

addWriterInterceptor(WriterInterceptor) - Method in class io.muserver.rest.RestHandlerBuilder

Registers a writer interceptor allowing for inspection and alteration of response bodies.

AGE - Static variable in class io.muserver.HeaderNames

"age"

all() - Method in interface io.muserver.RequestParameters

Gets all the parameters as a map

allOf - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.allOf() instead

allOf() - Method in class io.muserver.openapi.SchemaObject

allOf() - Method in class io.muserver.openapi.SchemaObjectBuilder

ALLOW - Static variable in class io.muserver.HeaderNames

"allow"

allowCredentials - Variable in class io.muserver.rest.CORSConfig

Deprecated.

use CORSConfig.allowCredentials() instead

allowCredentials() - Method in class io.muserver.rest.CORSConfig

allowedHeaders - Variable in class io.muserver.rest.CORSConfig

Deprecated.

use CORSConfig.allowedHeaders() instead

allowedHeaders() - Method in class io.muserver.rest.CORSConfig

allowedIns() - Static method in class io.muserver.openapi.ParameterObject

allowedOriginRegex - Variable in class io.muserver.rest.CORSConfig

Deprecated.

use CORSConfig.allowedOriginRegex() instead

allowedOriginRegex() - Method in class io.muserver.rest.CORSConfig

allowedOrigins - Variable in class io.muserver.rest.CORSConfig

Deprecated.

use CORSConfig.allowedOrigins() instead

allowedOrigins() - Method in class io.muserver.rest.CORSConfig

allowedStyles() - Static method in class io.muserver.openapi.ParameterObject

allowEmptyValue - Variable in class io.muserver.openapi.ParameterObject

Deprecated.

allowEmptyValue() - Method in class io.muserver.openapi.ParameterObject

allowReserved - Variable in class io.muserver.openapi.EncodingObject

Deprecated.

Use EncodingObject.allowReserved() instead

allowReserved - Variable in class io.muserver.openapi.ParameterObject

Deprecated.

allowReserved() - Method in class io.muserver.openapi.EncodingObject

allowReserved() - Method in class io.muserver.openapi.ParameterObject

anyOf - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.anyOf() instead

anyOf() - Method in class io.muserver.openapi.SchemaObject

anyOf() - Method in class io.muserver.openapi.SchemaObjectBuilder

Apache2_0() - Static method in class io.muserver.openapi.LicenseObjectBuilder

ApiResponse - Annotation Type in io.muserver.rest

Describes a response code and description for an API method, for documentation purposes.

ApiResponses - Annotation Type in io.muserver.rest

Describes multiple response codes and descriptions for an API method, for documentation purposes.

APPLICATION_EPUB_ZIP - Static variable in class io.muserver.ContentTypes

Electronic publication (EPUB): "application/epub+zip"

APPLICATION_EPUB_ZIP - Static variable in class io.muserver.handlers.ResourceType

application/epub-zip

APPLICATION_GZIP - Static variable in class io.muserver.ContentTypes

GZIP (.gz): "application/gzip"

APPLICATION_GZIP - Static variable in class io.muserver.handlers.ResourceType

application/gzip

APPLICATION_JAVA_ARCHIVE - Static variable in class io.muserver.ContentTypes

Java Archive (JAR): "application/java-archive"

APPLICATION_JAVA_ARCHIVE - Static variable in class io.muserver.handlers.ResourceType

application/java-archive

APPLICATION_JAVASCRIPT - Static variable in class io.muserver.ContentTypes

JavaScript (ECMAScript): "application/javascript"

APPLICATION_JAVASCRIPT - Static variable in class io.muserver.handlers.ResourceType

application/javascript

APPLICATION_JSON - Static variable in class io.muserver.ContentTypes

JSON format: "application/json"

APPLICATION_JSON - Static variable in class io.muserver.handlers.ResourceType

application/json

APPLICATION_MSWORD - Static variable in class io.muserver.ContentTypes

Microsoft Word: "application/msword"

APPLICATION_MSWORD - Static variable in class io.muserver.handlers.ResourceType

application/msword

APPLICATION_OCTET_STREAM - Static variable in class io.muserver.ContentTypes

Any kind of binary data: "application/octet-stream"

APPLICATION_OCTET_STREAM - Static variable in class io.muserver.handlers.ResourceType

application/octet-stream

APPLICATION_OGG - Static variable in class io.muserver.ContentTypes

OGG: "application/ogg"

APPLICATION_OGG - Static variable in class io.muserver.handlers.ResourceType

application/ogg

APPLICATION_PDF - Static variable in class io.muserver.ContentTypes

Adobe Portable Document Format (PDF): "application/pdf"

APPLICATION_PDF - Static variable in class io.muserver.handlers.ResourceType

application/pdf

APPLICATION_RTF - Static variable in class io.muserver.ContentTypes

Rich Text Format (RTF): "application/rtf"

APPLICATION_RTF - Static variable in class io.muserver.handlers.ResourceType

application/rtf

APPLICATION_TYPESCRIPT - Static variable in class io.muserver.ContentTypes

Typescript file: "application/typescript"

APPLICATION_TYPESCRIPT - Static variable in class io.muserver.handlers.ResourceType

application/typescript

APPLICATION_VND_AMAZON_EBOOK - Static variable in class io.muserver.ContentTypes

Amazon Kindle eBook format: "application/vnd.amazon.ebook"

APPLICATION_VND_AMAZON_EBOOK - Static variable in class io.muserver.handlers.ResourceType

application/vnd-amazon-ebook

APPLICATION_VND_APPLE_INSTALLER_XML - Static variable in class io.muserver.ContentTypes

Apple Installer Package: "application/vnd.apple.installer+xml"

APPLICATION_VND_APPLE_INSTALLER_XML - Static variable in class io.muserver.handlers.ResourceType

application/vnd-apple-installer-xml

APPLICATION_VND_MOZILLA_XUL_XML - Static variable in class io.muserver.ContentTypes

XUL: "application/vnd.mozilla.xul+xml"

APPLICATION_VND_MOZILLA_XUL_XML - Static variable in class io.muserver.handlers.ResourceType

application/vnd-mozilla-xul-xml

APPLICATION_VND_MS_EXCEL - Static variable in class io.muserver.ContentTypes

Microsoft Excel: "application/vnd.ms-excel"

APPLICATION_VND_MS_EXCEL - Static variable in class io.muserver.handlers.ResourceType

application/vnd-ms-excel

APPLICATION_VND_MS_FONTOBJECT - Static variable in class io.muserver.ContentTypes

MS Embedded OpenType fonts: "application/vnd.ms-fontobject"

APPLICATION_VND_MS_FONTOBJECT - Static variable in class io.muserver.handlers.ResourceType

application/vnd-ms-fontobject

APPLICATION_VND_MS_POWERPOINT - Static variable in class io.muserver.ContentTypes

Microsoft PowerPoint: "application/vnd.ms-powerpoint"

APPLICATION_VND_MS_POWERPOINT - Static variable in class io.muserver.handlers.ResourceType

application/vnd-ms-powerpoint

APPLICATION_VND_OASIS_OPENDOCUMENT_PRESENTATION - Static variable in class io.muserver.ContentTypes

OpenDocument presentation document: "application/vnd.oasis.opendocument.presentation"

APPLICATION_VND_OASIS_OPENDOCUMENT_PRESENTATION - Static variable in class io.muserver.handlers.ResourceType

application/vnd-oasis-opendocument-presentation

APPLICATION_VND_OASIS_OPENDOCUMENT_SPREADSHEET - Static variable in class io.muserver.ContentTypes

OpenDocument spreadsheet document: "application/vnd.oasis.opendocument.spreadsheet"

APPLICATION_VND_OASIS_OPENDOCUMENT_SPREADSHEET - Static variable in class io.muserver.handlers.ResourceType

application/vnd-oasis-opendocument-spreadsheet

APPLICATION_VND_OASIS_OPENDOCUMENT_TEXT - Static variable in class io.muserver.ContentTypes

OpenDocument text document: "application/vnd.oasis.opendocument.text"

APPLICATION_VND_OASIS_OPENDOCUMENT_TEXT - Static variable in class io.muserver.handlers.ResourceType

application/vnd-oasis-opendocument-text

APPLICATION_VND_VISIO - Static variable in class io.muserver.ContentTypes

Microsoft Visio: "application/vnd.visio"

APPLICATION_VND_VISIO - Static variable in class io.muserver.handlers.ResourceType

application/vnd-visio

APPLICATION_X_7Z_COMPRESSED - Static variable in class io.muserver.ContentTypes

7-zip archive: "application/x-7z-compressed"

APPLICATION_X_7Z_COMPRESSED - Static variable in class io.muserver.handlers.ResourceType

application/x-7z-compressed

APPLICATION_X_ABIWORD - Static variable in class io.muserver.ContentTypes

AbiWord document: "application/x-abiword"

APPLICATION_X_ABIWORD - Static variable in class io.muserver.handlers.ResourceType

application/x-abiword

APPLICATION_X_BZIP - Static variable in class io.muserver.ContentTypes

BZip archive: "application/x-bzip"

APPLICATION_X_BZIP - Static variable in class io.muserver.handlers.ResourceType

application/x-bzip

APPLICATION_X_BZIP2 - Static variable in class io.muserver.ContentTypes

BZip2 archive: "application/x-bzip2"

APPLICATION_X_BZIP2 - Static variable in class io.muserver.handlers.ResourceType

application/x-bzip2

APPLICATION_X_CSH - Static variable in class io.muserver.ContentTypes

C-Shell script: "application/x-csh"

APPLICATION_X_CSH - Static variable in class io.muserver.handlers.ResourceType

application/x-csh

APPLICATION_X_RAR_COMPRESSED - Static variable in class io.muserver.ContentTypes

RAR archive: "application/x-rar-compressed"

APPLICATION_X_RAR_COMPRESSED - Static variable in class io.muserver.handlers.ResourceType

application/x-rar-compressed

APPLICATION_X_SH - Static variable in class io.muserver.ContentTypes

Bourne shell script: "application/x-sh"

APPLICATION_X_SH - Static variable in class io.muserver.handlers.ResourceType

application/x-sh

APPLICATION_X_SHOCKWAVE_FLASH - Static variable in class io.muserver.ContentTypes

Small web format (SWF) or Adobe Flash document: "application/x-shockwave-flash"

APPLICATION_X_SHOCKWAVE_FLASH - Static variable in class io.muserver.handlers.ResourceType

application/x-shockwave-flash

APPLICATION_X_TAR - Static variable in class io.muserver.ContentTypes

Tape Archive (TAR): "application/x-tar"

APPLICATION_X_TAR - Static variable in class io.muserver.handlers.ResourceType

application/x-tar

APPLICATION_XHTML_XML - Static variable in class io.muserver.ContentTypes

XHTML: "application/xhtml+xml"

APPLICATION_XHTML_XML - Static variable in class io.muserver.handlers.ResourceType

application/xhtml-xml

APPLICATION_XML - Static variable in class io.muserver.ContentTypes

XML: "application/xml"

APPLICATION_XML - Static variable in class io.muserver.handlers.ResourceType

application/xml

APPLICATION_ZIP - Static variable in class io.muserver.ContentTypes

ZIP archive: "application/zip"

APPLICATION_ZIP - Static variable in class io.muserver.handlers.ResourceType

application/zip

artifactVersion() - Static method in interface io.muserver.MuServer

asBytes() - Method in interface io.muserver.UploadedFile

Gets the file contents as a byte array.

asFile() - Method in interface io.muserver.UploadedFile

Gets a copy of the file.

asStream() - Method in interface io.muserver.UploadedFile

Gets the uploaded file as a stream.

asString() - Method in interface io.muserver.UploadedFile

Returns the contents of the file as a String, decoded using UTF-8

AsyncContext - Class in io.muserver

Deprecated.

This interface is no longer used. Instead call MuRequest.handleAsync() from a standard Mu Handler.

AsyncContext() - Constructor for class io.muserver.AsyncContext

Deprecated.

AsyncHandle - Interface in io.muserver

A class to handle the request and response handling when using asynchronous request handling.

AsyncHandle.ResponseCompletedListener - Interface in io.muserver

Deprecated.

AsyncMuHandler - Interface in io.muserver

Deprecated.

This interface is no longer used. Instead call MuRequest.handleAsync() from a standard Mu Handler.

AsyncSsePublisher - Interface in io.muserver

An interface for sending Server-Sent Events (SSE) to a client with async callbacks.

ATTACHMENT - Static variable in class io.muserver.HeaderValues

"attachment" See HeaderNames.CONTENT_DISPOSITION

attribute - Variable in class io.muserver.openapi.XmlObject

Deprecated.

use XmlObject.attribute() instead

attribute() - Method in class io.muserver.openapi.XmlObject

attribute(String) - Method in interface io.muserver.MuRequest

Gets request-specific state that was added with MuRequest.attribute(String, Object).

attribute(String, Object) - Method in interface io.muserver.MuRequest

Sets the given object as state associated with the given key that is bound to this request which any subsequent handlers can access.

attributes() - Method in interface io.muserver.MuRequest

Returns the map containing all the attributes.

AUDIO_AAC - Static variable in class io.muserver.ContentTypes

AAC audio file: "audio/aac"

AUDIO_AAC - Static variable in class io.muserver.handlers.ResourceType

audio/aac

AUDIO_MIDI - Static variable in class io.muserver.ContentTypes

Musical Instrument Digital Interface (MIDI): "audio/midi"

AUDIO_MIDI - Static variable in class io.muserver.handlers.ResourceType

audio/midi

AUDIO_OGG - Static variable in class io.muserver.ContentTypes

OGG audio: "audio/ogg"

AUDIO_OGG - Static variable in class io.muserver.handlers.ResourceType

audio/ogg

AUDIO_WEBM - Static variable in class io.muserver.ContentTypes

WEBM audio: "audio/webm"

AUDIO_WEBM - Static variable in class io.muserver.handlers.ResourceType

audio/webm

AUDIO_X_WAV - Static variable in class io.muserver.ContentTypes

Waveform Audio Format: "audio/x-wav"

AUDIO_X_WAV - Static variable in class io.muserver.handlers.ResourceType

audio/x-wav

authenticate(String, String) - Method in interface io.muserver.rest.UserPassAuthenticator

Looks up a user.

AUTHORIZATION - Static variable in class io.muserver.HeaderNames

"authorization"

authorizationCode - Variable in class io.muserver.openapi.OAuthFlowsObject

Deprecated.

use OAuthFlowsObject.authorizationCode() instead

authorizationCode() - Method in class io.muserver.openapi.OAuthFlowsObject

authorizationUrl - Variable in class io.muserver.openapi.OAuthFlowObject

Deprecated.

use OAuthFlowObject.authorizationUrl() instead

authorizationUrl() - Method in class io.muserver.openapi.OAuthFlowObject

Authorizer - Interface in io.muserver.rest

A class that can check if a principle is in a given role.

B

BASE64 - Static variable in class io.muserver.HeaderValues

"base64"

BaseWebSocket - Class in io.muserver

A base class for server-side web sockets, that takes care of capturing the web socket session, responding to pings, and closure events.

BaseWebSocket() - Constructor for class io.muserver.BaseWebSocket

BasicAuthSecurityFilter - Class in io.muserver.rest

A filter that can handle Basic Authentication

BasicAuthSecurityFilter(String, UserPassAuthenticator, Authorizer) - Constructor for class io.muserver.rest.BasicAuthSecurityFilter

Creates a new Basic Auth Security Filter

bearerFormat - Variable in class io.muserver.openapi.SecuritySchemeObject

Deprecated.

use SecuritySchemeObject.bearerFormat() instead

bearerFormat() - Method in class io.muserver.openapi.SecuritySchemeObject

beforeHeadersSent(MuRequest, Headers) - Method in interface io.muserver.handlers.ResourceCustomizer

Called after the default headers have been set, just before they are sent to the client.

BINARY - Static variable in class io.muserver.HeaderValues

"binary"

BOUNDARY - Static variable in class io.muserver.HeaderValues

"boundary"

build() - Method in class io.muserver.ContextHandlerBuilder

build() - Method in class io.muserver.CookieBuilder

build() - Method in class io.muserver.handlers.CORSHandlerBuilder

build() - Method in class io.muserver.handlers.HttpsRedirectorBuilder

build() - Method in class io.muserver.handlers.ResourceHandler.Builder

Deprecated.

Creates the handler

build() - Method in class io.muserver.handlers.ResourceHandlerBuilder

Creates the handler

build() - Method in class io.muserver.Http2ConfigBuilder

Creates the HTTP2 settings object

build() - Method in interface io.muserver.MuHandlerBuilder

build() - Method in class io.muserver.openapi.CallbackObjectBuilder

Creates the object

build() - Method in class io.muserver.openapi.ComponentsObjectBuilder

build() - Method in class io.muserver.openapi.ContactObjectBuilder

build() - Method in class io.muserver.openapi.DiscriminatorObjectBuilder

build() - Method in class io.muserver.openapi.EncodingObjectBuilder

build() - Method in class io.muserver.openapi.ExampleObjectBuilder

build() - Method in class io.muserver.openapi.ExternalDocumentationObjectBuilder

build() - Method in class io.muserver.openapi.HeaderObjectBuilder

build() - Method in class io.muserver.openapi.InfoObjectBuilder

build() - Method in class io.muserver.openapi.LicenseObjectBuilder

build() - Method in class io.muserver.openapi.LinkObjectBuilder

build() - Method in class io.muserver.openapi.MediaTypeObjectBuilder

build() - Method in class io.muserver.openapi.OAuthFlowObjectBuilder

build() - Method in class io.muserver.openapi.OAuthFlowsObjectBuilder

build() - Method in class io.muserver.openapi.OpenAPIObjectBuilder

build() - Method in class io.muserver.openapi.OperationObjectBuilder

build() - Method in class io.muserver.openapi.ParameterObjectBuilder

build() - Method in class io.muserver.openapi.PathItemObjectBuilder

build() - Method in class io.muserver.openapi.PathsObjectBuilder

build() - Method in class io.muserver.openapi.RequestBodyObjectBuilder

build() - Method in class io.muserver.openapi.ResponseObjectBuilder

build() - Method in class io.muserver.openapi.ResponsesObjectBuilder

build() - Method in class io.muserver.openapi.SchemaObjectBuilder

build() - Method in class io.muserver.openapi.SecurityRequirementObjectBuilder

build() - Method in class io.muserver.openapi.SecuritySchemeObjectBuilder

build() - Method in class io.muserver.openapi.ServerObjectBuilder

build() - Method in class io.muserver.openapi.ServerVariableObjectBuilder

build() - Method in class io.muserver.openapi.TagObjectBuilder

build() - Method in class io.muserver.openapi.XmlObjectBuilder

build() - Method in class io.muserver.RateLimitBuilder

Creates the rate limit from the builder

build() - Method in class io.muserver.rest.CORSConfigBuilder

Builds CORS configuration from a builder

build() - Method in class io.muserver.rest.RestHandlerBuilder

build() - Method in class io.muserver.SSLContextBuilder

Deprecated.

Pass this builder itself to the HttpsConfig rather than building an SSLContext

build() - Method in class io.muserver.WebSocketHandlerBuilder

Creates the websocket handler.

builder() - Static method in class io.muserver.Cookie

Creates a new cookie builder with secure, Strict SameSite and httpOnly selected.

builder() - Static method in class io.muserver.RateLimit

Creates a new rate limit builder

Builder() - Constructor for class io.muserver.handlers.HttpsRedirector.Builder

Deprecated.

Builder() - Constructor for class io.muserver.handlers.ResourceHandler.Builder

Deprecated.

builderFrom(OperationObject) - Static method in class io.muserver.openapi.OperationObjectBuilder

Creates a builder from the given operation object

by() - Method in class io.muserver.ForwardedHeader

BYTES - Static variable in class io.muserver.HeaderValues

"bytes"

bytesRead() - Method in interface io.muserver.MuStats

bytesSent() - Method in interface io.muserver.MuStats

C

CACHE_CONTROL - Static variable in class io.muserver.HeaderNames

"cache-control"

cacheControl() - Method in interface io.muserver.Headers

Gets the Cache-Control header value.

callbackObject() - Static method in class io.muserver.openapi.CallbackObjectBuilder

Creates a builder for a CallbackObject

CallbackObject - Class in io.muserver.openapi

CallbackObjectBuilder - Class in io.muserver.openapi

A map of possible out-of band callbacks related to the parent operation.

CallbackObjectBuilder() - Constructor for class io.muserver.openapi.CallbackObjectBuilder

callbacks - Variable in class io.muserver.openapi.ComponentsObject

Deprecated.

callbacks - Variable in class io.muserver.openapi.OperationObject

Deprecated.

use OperationObject.callbacks() instead

callbacks() - Method in class io.muserver.openapi.CallbackObject

callbacks() - Method in class io.muserver.openapi.ComponentsObject

callbacks() - Method in class io.muserver.openapi.OperationObject

certificates() - Method in interface io.muserver.SSLInfo

Gets the server certificates that are in use.

changeHttpsConfig(HttpsConfigBuilder) - Method in interface io.muserver.MuServer

Changes the HTTPS certificate.

changeSSLContext(SSLContextBuilder) - Method in interface io.muserver.MuServer

Deprecated.

Use MuServer.changeHttpsConfig(HttpsConfigBuilder) instead

changeSSLContext(SSLContext) - Method in interface io.muserver.MuServer

Deprecated.

Use MuServer.changeSSLContext(SSLContextBuilder) instead.

CHARSET - Static variable in class io.muserver.HeaderValues

"charset"

CHUNKED - Static variable in class io.muserver.HeaderValues

"chunked"

cipher() - Method in interface io.muserver.HttpConnection

ciphers() - Method in interface io.muserver.SSLInfo

classpathHandler(String) - Static method in class io.muserver.handlers.ResourceHandler

Deprecated.

Use ResourceHandlerBuilder.classpathHandler(String)

classpathHandler(String) - Static method in class io.muserver.handlers.ResourceHandlerBuilder

Creates a handler that serves files from the classpath..

clear() - Method in interface io.muserver.Headers

CLIENT_CLOSED - io.muserver.WebsocketSessionState

The session has ended as a result of the client sending a close frame

CLIENT_CLOSING - io.muserver.WebsocketSessionState

The client has sent a close frame.

CLIENT_DISCONNECTED - io.muserver.ResponseState

The client disconnected before the full request and response was completed.

clientCredentials - Variable in class io.muserver.openapi.OAuthFlowsObject

Deprecated.

use OAuthFlowsObject.clientCredentials() instead

clientCredentials() - Method in class io.muserver.openapi.OAuthFlowsObject

ClientDisconnectedException - Exception in io.muserver

Thrown when a client non-gracefully disconnects.

ClientDisconnectedException() - Constructor for exception io.muserver.ClientDisconnectedException

clientIP() - Method in interface io.muserver.MuRequest

Makes a best-effort guess at the client's IP address, taking into account any Forwarded or X-Forwarded-* headers.

close() - Method in interface io.muserver.AsyncSsePublisher

Stops the event stream.

close() - Method in interface io.muserver.MuWebSocketSession

Initiates a graceful shutdown with the client.

close() - Method in interface io.muserver.SsePublisher

Stops the event stream.

close(int, String) - Method in interface io.muserver.MuWebSocketSession

Initiates a graceful shutdown with the client.

CLOSE - Static variable in class io.muserver.HeaderValues

"close"

closing() - Method in enum io.muserver.WebsocketSessionState

coalesce(T...) - Static method in class io.muserver.Mutils

Returns the first non-null value from the given values (or null if all values are null)

code() - Method in annotation type io.muserver.rest.ApiResponse

The HTTP status code of the response.

CollectionParameterStrategy - Enum in io.muserver.rest

Specifies how to handle lists or sets in querystring parameters

complete() - Method in interface io.muserver.AsyncHandle

Call this to indicate that the response is complete.

complete(boolean) - Method in class io.muserver.AsyncContext

Deprecated.

complete(Throwable) - Method in interface io.muserver.AsyncHandle

Call this to indicate that the response is complete.

completedConnections() - Method in interface io.muserver.MuStats

completedRequests() - Method in interface io.muserver.HttpConnection

completedRequests() - Method in interface io.muserver.MuStats

completedSuccessfully() - Method in class io.muserver.AsyncContext

Deprecated.

completedSuccessfully() - Method in interface io.muserver.ResponseInfo

Indicates whether or not a response completed successfully.

completedSuccessfully() - Method in enum io.muserver.ResponseState

components - Variable in class io.muserver.openapi.OpenAPIObject

Deprecated.

components() - Method in class io.muserver.openapi.OpenAPIObject

componentsObject() - Static method in class io.muserver.openapi.ComponentsObjectBuilder

Creates a builder for a ComponentsObject

componentsObject(ComponentsObject) - Static method in class io.muserver.openapi.ComponentsObjectBuilder

Creates a builder for a ComponentsObject based on an existing components object

ComponentsObject - Class in io.muserver.openapi

ComponentsObjectBuilder - Class in io.muserver.openapi

Holds a set of reusable objects for different aspects of the OAS.

ComponentsObjectBuilder() - Constructor for class io.muserver.openapi.ComponentsObjectBuilder

COMPRESS - Static variable in class io.muserver.HeaderValues

"compress"

config() - Static method in class io.muserver.handlers.CORSHandlerBuilder

A helper for creating a config object to pass to CORSHandlerBuilder.withCORSConfig(CORSConfigBuilder)

CONNECT - io.muserver.Method

The CONNECT HTTP method

connectedSinksCount(SseBroadcaster) - Static method in class io.muserver.rest.MuRuntimeDelegate

connection() - Method in interface io.muserver.MuRequest

CONNECTION - Static variable in class io.muserver.HeaderNames

"connection"

contact - Variable in class io.muserver.openapi.InfoObject

Deprecated.

use InfoObject.contact() instead

contact() - Method in class io.muserver.openapi.InfoObject

contactObject() - Static method in class io.muserver.openapi.ContactObjectBuilder

Creates a builder for a ContactObject

ContactObject - Class in io.muserver.openapi

ContactObjectBuilder - Class in io.muserver.openapi

Contact information for the exposed API.

ContactObjectBuilder() - Constructor for class io.muserver.openapi.ContactObjectBuilder

contains(CharSequence) - Method in interface io.muserver.Headers

Returns true if the given parameter is specified with any value

contains(CharSequence, CharSequence, boolean) - Method in interface io.muserver.Headers

Checks if a header with the given name exists with the given value.

contains(String) - Method in interface io.muserver.Headers

Returns true if the given parameter is specified with any value

contains(String) - Method in interface io.muserver.RequestParameters

Returns true if the given parameter is specified with any value

contains(String, String, boolean) - Method in interface io.muserver.Headers

Checks if a header with the given name exists with the given value.

containsValue(CharSequence, CharSequence, boolean) - Method in interface io.muserver.Headers

Similar to Headers.contains(String, String, boolean) but returns true even if a value occurs in a comma-separated header list.

content - Variable in class io.muserver.openapi.ParameterObject

Deprecated.

content - Variable in class io.muserver.openapi.RequestBodyObject

Deprecated.

use RequestBodyObject.content() instead

content - Variable in class io.muserver.openapi.ResponseObject

Deprecated.

use ResponseObject.content() instead

content() - Method in class io.muserver.openapi.HeaderObject

content() - Method in class io.muserver.openapi.ParameterObject

content() - Method in class io.muserver.openapi.RequestBodyObject

content() - Method in class io.muserver.openapi.ResponseObject

CONTENT_BASE - Static variable in class io.muserver.HeaderNames

"content-base"

CONTENT_DISPOSITION - Static variable in class io.muserver.HeaderNames

"content-disposition"

CONTENT_ENCODING - Static variable in class io.muserver.HeaderNames

"content-encoding"

CONTENT_LANGUAGE - Static variable in class io.muserver.HeaderNames

"content-language"

CONTENT_LENGTH - Static variable in class io.muserver.HeaderNames

"content-length"

CONTENT_LOCATION - Static variable in class io.muserver.HeaderNames

"content-location"

CONTENT_MD5 - Static variable in class io.muserver.HeaderNames

"content-md5"

CONTENT_RANGE - Static variable in class io.muserver.HeaderNames

"content-range"

CONTENT_SECURITY_POLICY - Static variable in class io.muserver.HeaderNames

"content-security-policy"

CONTENT_TRANSFER_ENCODING - Static variable in class io.muserver.HeaderNames

"content-transfer-encoding"

CONTENT_TYPE - Static variable in class io.muserver.HeaderNames

"content-type"

contentType - Variable in class io.muserver.openapi.EncodingObject

Deprecated.

Use EncodingObject.contentType() instead

contentType() - Method in interface io.muserver.Headers

Gets the parsed Content-Type header value.

contentType() - Method in interface io.muserver.MuRequest

Gets the content type of the request body, for example application/json or null if there is no body.

contentType() - Method in class io.muserver.openapi.EncodingObject

contentType() - Method in annotation type io.muserver.rest.ApiResponse

The content type for this code, if different from the default

contentType() - Method in interface io.muserver.UploadedFile

Gets the media type of the file as specified by the client, for example image/jpeg

contentType(CharSequence) - Method in interface io.muserver.MuResponse

Sets the Content-Type response header.

ContentTypes - Class in io.muserver

String constants for content-types

context(String) - Static method in class io.muserver.ContextHandlerBuilder

Create a new base path.

context(String, MuHandler...) - Static method in class io.muserver.ContextHandlerBuilder

Deprecated.

Use ContextHandlerBuilder.context(String) and then add handlers on to that.

context(String, MuHandlerBuilder...) - Static method in class io.muserver.ContextHandlerBuilder

Deprecated.

Use ContextHandlerBuilder.context(String) and then add handlers on to that.

ContextHandler - Class in io.muserver

A handler that wraps a list of other handlers and serves them at a certain path prefix (or context).

ContextHandler(String, List<MuHandler>) - Constructor for class io.muserver.ContextHandler

Deprecated.

Use ContextHandlerBuilder.context(String) instead

ContextHandlerBuilder - Class in io.muserver

Use this to serve a list of handlers from a base path.

ContextHandlerBuilder() - Constructor for class io.muserver.ContextHandlerBuilder

contextPath() - Method in interface io.muserver.MuRequest

If this handler was added to a ContextHandlerBuilder.context(String) then this will return the value of the context pre-pended with a '/'.

CONTINUE - Static variable in class io.muserver.HeaderValues

"100-continue"

cookie(String) - Method in interface io.muserver.MuRequest

Gets the value of the client-sent cookie with the given name

Cookie - Class in io.muserver

A cookie that is sent from the server to the client.

Cookie(String, String) - Constructor for class io.muserver.Cookie

Deprecated.

Please use CookieBuilder.newCookie() instead

COOKIE - Static variable in class io.muserver.HeaderNames

"cookie"

CookieBuilder - Class in io.muserver

A builder to create cookies that will be sent on a Response with MuResponse.addCookie(Cookie)

CookieBuilder() - Constructor for class io.muserver.CookieBuilder

cookies() - Method in interface io.muserver.MuRequest

Gets all the client-sent cookies

copy(InputStream, OutputStream, int) - Static method in class io.muserver.Mutils

Copies an input stream to another stream

corsConfig() - Static method in class io.muserver.rest.CORSConfigBuilder

Creates a builder to set CORS configuration.

CORSConfig - Class in io.muserver.rest

CORS configuration for REST resources.

CORSConfigBuilder - Class in io.muserver.rest

A builder to set configuration for CORS requests.

CORSConfigBuilder() - Constructor for class io.muserver.rest.CORSConfigBuilder

corsHandler() - Static method in class io.muserver.handlers.CORSHandlerBuilder

A helper for creating a CORS handler

CORSHandler - Class in io.muserver.handlers

A handler that adds CORS headers to responses.

CORSHandlerBuilder - Class in io.muserver.handlers

Used to create a handler that puts appropriate CORS headers on requests.

CORSHandlerBuilder() - Constructor for class io.muserver.handlers.CORSHandlerBuilder

create(MuRequest, Headers) - Method in interface io.muserver.MuWebSocketFactory

Creates a web socket for an upgrade request.

create(Object...) - Static method in class io.muserver.rest.RestHandlerBuilder

Deprecated.

Use restHandler(resources).build() instead.

createEndpoint(Application, Class<T>) - Method in class io.muserver.rest.MuRuntimeDelegate

createHeaderDelegate(Class<T>) - Method in class io.muserver.rest.MuRuntimeDelegate

createLinkBuilder() - Method in class io.muserver.rest.MuRuntimeDelegate

createResponseBuilder() - Method in class io.muserver.rest.MuRuntimeDelegate

createSseFactory() - Static method in class io.muserver.rest.MuRuntimeDelegate

Creates a new SSE interface that can create SSE Events and Broadcasters.

createUriBuilder() - Method in class io.muserver.rest.MuRuntimeDelegate

createVariantListBuilder() - Method in class io.muserver.rest.MuRuntimeDelegate

currentBuckets() - Method in interface io.muserver.RateLimiter

customize(SchemaObjectBuilder, SchemaObjectCustomizerContext) - Method in interface io.muserver.rest.SchemaObjectCustomizer

Optionally change, remove, or create a new schema builder for a piece of an OpenAPI document.

D

DATE - Static variable in class io.muserver.HeaderNames

"date"

DEFAULT - Static variable in class io.muserver.handlers.ResourceType

The resource type used when no others match.

DEFAULT_EXTENSION_MAPPINGS - Static variable in class io.muserver.handlers.ResourceType

The mapping of file extensions (such as "jpg") to resource types (such as ResourceType.IMAGE_JPEG that mu-server uses by default when serving static content.

defaultSSLContext() - Static method in class io.muserver.SSLContextBuilder

Deprecated.

defaultValue - Variable in class io.muserver.openapi.ResponsesObject

Deprecated.

use ResponsesObject.defaultValue() instead

defaultValue - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.defaultValue() instead

defaultValue - Variable in class io.muserver.openapi.ServerVariableObject

Deprecated.

use ServerVariableObject.defaultValue() instead

defaultValue() - Method in class io.muserver.openapi.ResponsesObject

defaultValue() - Method in class io.muserver.openapi.SchemaObject

defaultValue() - Method in class io.muserver.openapi.SchemaObjectBuilder

defaultValue() - Method in class io.muserver.openapi.ServerVariableObject

DEFLATE - Static variable in class io.muserver.HeaderValues

"deflate"

DELETE - io.muserver.Method

The DELETE HTTP method

deprecated - Variable in class io.muserver.openapi.OperationObject

Deprecated.

use OperationObject.deprecated() instead

deprecated - Variable in class io.muserver.openapi.ParameterObject

Deprecated.

deprecated - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.deprecated() instead

deprecated() - Method in class io.muserver.openapi.HeaderObject

deprecated() - Method in class io.muserver.openapi.OperationObject

deprecated() - Method in class io.muserver.openapi.ParameterObject

deprecated() - Method in class io.muserver.openapi.SchemaObject

deprecated() - Method in class io.muserver.openapi.SchemaObjectBuilder

deprecated() - Method in annotation type io.muserver.rest.ResponseHeader

Marks this header as deprecated to indicate that this header should no longer be used by clients.

description - Variable in class io.muserver.openapi.ExampleObject

Deprecated.

use ExampleObject.description() instead

description - Variable in class io.muserver.openapi.ExternalDocumentationObject

Deprecated.

use ExternalDocumentationObject.description() instead

description - Variable in class io.muserver.openapi.InfoObject

Deprecated.

use InfoObject.description() instead

description - Variable in class io.muserver.openapi.LinkObject

Deprecated.

use LinkObject.description() instead

description - Variable in class io.muserver.openapi.OperationObject

Deprecated.

use OperationObject.description() instead

description - Variable in class io.muserver.openapi.ParameterObject

Deprecated.

description - Variable in class io.muserver.openapi.PathItemObject

Deprecated.

use PathItemObject.description() instead

description - Variable in class io.muserver.openapi.RequestBodyObject

Deprecated.

use RequestBodyObject.description() instead

description - Variable in class io.muserver.openapi.ResponseObject

Deprecated.

use ResponseObject.description() instead

description - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.description() instead

description - Variable in class io.muserver.openapi.SecuritySchemeObject

Deprecated.

use SecuritySchemeObject.description() instead

description - Variable in class io.muserver.openapi.ServerObject

Deprecated.

use ServerObject.description() instead

description - Variable in class io.muserver.openapi.ServerVariableObject

Deprecated.

use ServerVariableObject.description() instead

description - Variable in class io.muserver.openapi.TagObject

Deprecated.

use TagObject.description() instead

description() - Method in class io.muserver.openapi.ExampleObject

description() - Method in class io.muserver.openapi.ExternalDocumentationObject

description() - Method in class io.muserver.openapi.HeaderObject

description() - Method in class io.muserver.openapi.InfoObject

description() - Method in class io.muserver.openapi.LinkObject

description() - Method in class io.muserver.openapi.OperationObject

description() - Method in class io.muserver.openapi.ParameterObject

description() - Method in class io.muserver.openapi.PathItemObject

description() - Method in class io.muserver.openapi.RequestBodyObject

description() - Method in class io.muserver.openapi.ResponseObject

description() - Method in class io.muserver.openapi.SchemaObject

description() - Method in class io.muserver.openapi.SchemaObjectBuilder

description() - Method in class io.muserver.openapi.SecuritySchemeObject

description() - Method in class io.muserver.openapi.ServerObject

description() - Method in class io.muserver.openapi.ServerVariableObject

description() - Method in class io.muserver.openapi.TagObject

description() - Method in annotation type io.muserver.rest.ResponseHeader

A brief description of the header.

Description - Annotation Type in io.muserver.rest

Provides a description of a class, method, or parameter for use in documentation.

details() - Method in annotation type io.muserver.rest.Description

An optional, detailed description that may include CommonMark Markdown.

disabled() - Static method in class io.muserver.rest.CORSConfigBuilder

Creates CORS configuration that disables all CORS requests.

DISCONNECTED - io.muserver.WebsocketSessionState

The connection was disconnected early (before a graceful shutdown could occur)

discriminator - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.discriminator() instead

discriminator() - Method in class io.muserver.openapi.SchemaObject

discriminator() - Method in class io.muserver.openapi.SchemaObjectBuilder

discriminatorObject() - Static method in class io.muserver.openapi.DiscriminatorObjectBuilder

Creates a builder for a DiscriminatorObject

DiscriminatorObject - Class in io.muserver.openapi

DiscriminatorObjectBuilder - Class in io.muserver.openapi

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.

DiscriminatorObjectBuilder() - Constructor for class io.muserver.openapi.DiscriminatorObjectBuilder

documentationUrl() - Method in annotation type io.muserver.rest.Description

An optional URL pointing to more documentation for this.

domain() - Method in class io.muserver.Cookie

DoneCallback - Interface in io.muserver

A callback for async operations that calls when an operation completes.

duration() - Method in class io.muserver.AsyncContext

Deprecated.

duration() - Method in interface io.muserver.ResponseInfo

The duration in millis of a completed response, or the duration so far of an in-progress request.

E

email - Variable in class io.muserver.openapi.ContactObject

Deprecated.

email() - Method in class io.muserver.openapi.ContactObject

EMPTY_MATCH - Static variable in class io.muserver.rest.PathMatch

An empty match

enabled(boolean) - Method in class io.muserver.Http2ConfigBuilder

Specifies whether to enable HTTP2 or not.

encoding - Variable in class io.muserver.openapi.MediaTypeObject

Deprecated.

use MediaTypeObject.encoding() instead

encoding() - Method in class io.muserver.openapi.MediaTypeObject

encodingObject() - Static method in class io.muserver.openapi.EncodingObjectBuilder

Creates a builder for an EncodingObject

EncodingObject - Class in io.muserver.openapi

EncodingObjectBuilder - Class in io.muserver.openapi

A single encoding definition applied to a single schema property.

EncodingObjectBuilder() - Constructor for class io.muserver.openapi.EncodingObjectBuilder

endState() - Method in enum io.muserver.ResponseState

endState() - Method in enum io.muserver.WebsocketSessionState

ensureSet() - Static method in class io.muserver.rest.MuRuntimeDelegate

Registers the mu RuntimeDelegate with jax-rs, if it was not already.

entries() - Method in interface io.muserver.Headers

enumValue - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.enumValue() instead

enumValue() - Method in class io.muserver.openapi.SchemaObject

enumValue() - Method in class io.muserver.openapi.SchemaObjectBuilder

enumValues - Variable in class io.muserver.openapi.ServerVariableObject

Deprecated.

use ServerVariableObject.enumValues() instead

enumValues() - Method in class io.muserver.openapi.ServerVariableObject

equals(Object) - Method in class io.muserver.Cookie

equals(Object) - Method in class io.muserver.ForwardedHeader

equals(Object) - Method in class io.muserver.openapi.TagObject

equals(Object) - Method in class io.muserver.ParameterizedHeader

equals(Object) - Method in class io.muserver.ParameterizedHeaderWithValue

equals(Object) - Method in class io.muserver.rest.CORSConfig

equals(Object) - Method in class io.muserver.rest.UriPattern

ERRORED - io.muserver.ResponseState

An error (such as an unhandled exception in a callback) occurred before the exchange was completed.

ERRORED - io.muserver.WebsocketSessionState

The session was ended due to an unexpected error

ETAG - Static variable in class io.muserver.HeaderNames

"etag"

example - Variable in class io.muserver.openapi.MediaTypeObject

Deprecated.

use MediaTypeObject.example() instead

example - Variable in class io.muserver.openapi.ParameterObject

Deprecated.

example - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.example() instead

example() - Method in class io.muserver.openapi.HeaderObject

example() - Method in class io.muserver.openapi.MediaTypeObject

example() - Method in class io.muserver.openapi.ParameterObject

example() - Method in class io.muserver.openapi.SchemaObject

example() - Method in class io.muserver.openapi.SchemaObjectBuilder

example() - Method in annotation type io.muserver.rest.ApiResponse

An example return value

example() - Method in annotation type io.muserver.rest.Description

An example value

example() - Method in annotation type io.muserver.rest.ResponseHeader

An example of a value that will be returned

exampleObject() - Static method in class io.muserver.openapi.ExampleObjectBuilder

Creates a builder for an ExampleObject

ExampleObject - Class in io.muserver.openapi

ExampleObjectBuilder - Class in io.muserver.openapi

A builder for ExampleObject objects

ExampleObjectBuilder() - Constructor for class io.muserver.openapi.ExampleObjectBuilder

examples - Variable in class io.muserver.openapi.ComponentsObject

Deprecated.

examples - Variable in class io.muserver.openapi.MediaTypeObject

Deprecated.

use MediaTypeObject.examples() instead

examples - Variable in class io.muserver.openapi.ParameterObject

Deprecated.

examples() - Method in class io.muserver.openapi.ComponentsObject

examples() - Method in class io.muserver.openapi.HeaderObject

examples() - Method in class io.muserver.openapi.MediaTypeObject

examples() - Method in class io.muserver.openapi.ParameterObject

exclusiveMaximum - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.exclusiveMaximum() instead

exclusiveMaximum() - Method in class io.muserver.openapi.SchemaObject

exclusiveMaximum() - Method in class io.muserver.openapi.SchemaObjectBuilder

exclusiveMinimum - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.exclusiveMinimum() instead

exclusiveMinimum() - Method in class io.muserver.openapi.SchemaObject

exclusiveMinimum() - Method in class io.muserver.openapi.SchemaObjectBuilder

EXPECT - Static variable in class io.muserver.HeaderNames

"expect"

EXPIRES - Static variable in class io.muserver.HeaderNames

"expires"

explode - Variable in class io.muserver.openapi.EncodingObject

Deprecated.

Use EncodingObject.explode() instead

explode - Variable in class io.muserver.openapi.ParameterObject

Deprecated.

explode() - Method in class io.muserver.openapi.EncodingObject

explode() - Method in class io.muserver.openapi.HeaderObject

explode() - Method in class io.muserver.openapi.ParameterObject

exposedHeaders - Variable in class io.muserver.rest.CORSConfig

Deprecated.

use CORSConfig.exposedHeaders() instead

exposedHeaders() - Method in class io.muserver.rest.CORSConfig

extension() - Method in interface io.muserver.UploadedFile

Gets the extension of the file as it was on the client's computer.

extensions - Variable in class io.muserver.handlers.ResourceType

Deprecated.

use ResourceType.extensions() instead

extensions() - Method in class io.muserver.ForwardedHeader

extensions() - Method in class io.muserver.handlers.ResourceType

externalDocs - Variable in class io.muserver.openapi.OpenAPIObject

Deprecated.

externalDocs - Variable in class io.muserver.openapi.OperationObject

Deprecated.

use OperationObject.externalDocs() instead

externalDocs - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.externalDocs() instead

externalDocs - Variable in class io.muserver.openapi.TagObject

Deprecated.

use TagObject.externalDocs() instead

externalDocs() - Method in class io.muserver.openapi.OpenAPIObject

externalDocs() - Method in class io.muserver.openapi.OperationObject

externalDocs() - Method in class io.muserver.openapi.SchemaObject

externalDocs() - Method in class io.muserver.openapi.SchemaObjectBuilder

externalDocs() - Method in class io.muserver.openapi.TagObject

externalDocumentationObject() - Static method in class io.muserver.openapi.ExternalDocumentationObjectBuilder

Creates a builder for an ExternalDocumentationObject

ExternalDocumentationObject - Class in io.muserver.openapi

ExternalDocumentationObjectBuilder - Class in io.muserver.openapi

Allows referencing an external resource for extended documentation.

ExternalDocumentationObjectBuilder() - Constructor for class io.muserver.openapi.ExternalDocumentationObjectBuilder

externalValue - Variable in class io.muserver.openapi.ExampleObject

Deprecated.

use ExampleObject.externalValue() instead

externalValue() - Method in class io.muserver.openapi.ExampleObject

F

failedToConnect() - Method in interface io.muserver.MuStats

FILE - Static variable in class io.muserver.HeaderValues

"file" See HeaderNames.CONTENT_DISPOSITION

fileHandler(File) - Static method in class io.muserver.handlers.ResourceHandler

Deprecated.

Use ResourceHandlerBuilder.fileHandler(File)

fileHandler(File) - Static method in class io.muserver.handlers.ResourceHandlerBuilder

Creates a handler that serves files from the given directory.

fileHandler(String) - Static method in class io.muserver.handlers.ResourceHandler

Deprecated.

Use ResourceHandlerBuilder.fileHandler(String)

fileHandler(String) - Static method in class io.muserver.handlers.ResourceHandlerBuilder

Creates a handler that serves files from the given directory.

fileHandler(Path) - Static method in class io.muserver.handlers.ResourceHandler

Deprecated.

Use ResourceHandlerBuilder.fileHandler(Path)

fileHandler(Path) - Static method in class io.muserver.handlers.ResourceHandlerBuilder

Creates a handler that serves files from the given directory.

filename() - Method in interface io.muserver.UploadedFile

Gets the original name of the file on the client's computer.

FILENAME - Static variable in class io.muserver.HeaderValues

"filename" See HeaderNames.CONTENT_DISPOSITION

fileOrClasspath(String, String) - Static method in class io.muserver.handlers.ResourceHandler

Deprecated.

Use ResourceHandlerBuilder.fileOrClasspath(String, String)

fileOrClasspath(String, String) - Static method in class io.muserver.handlers.ResourceHandlerBuilder

Creates a resource handler that serves from the file system if the directory exists; otherwise from the class path.

filter(ContainerRequestContext) - Method in class io.muserver.rest.BasicAuthSecurityFilter

filter(ContainerRequestContext) - Method in class io.muserver.rest.QueryStringCommaExploderFilter

Deprecated.

FINISHED - io.muserver.ResponseState

The full response was streamed to the client

FINISHING - io.muserver.ResponseState

Completion initiated.

fixedLengthResponsesEnabled - Static variable in class io.muserver.Toggles

Deprecated.

This is now unused and fixed length is always enabled

flows - Variable in class io.muserver.openapi.SecuritySchemeObject

Deprecated.

use SecuritySchemeObject.flows() instead

flows() - Method in class io.muserver.openapi.SecuritySchemeObject

FONT_OTF - Static variable in class io.muserver.ContentTypes

OpenType font: "font/otf"

FONT_OTF - Static variable in class io.muserver.handlers.ResourceType

font/otf

FONT_TTF - Static variable in class io.muserver.ContentTypes

TrueType Font: "font/ttf"

FONT_TTF - Static variable in class io.muserver.handlers.ResourceType

font/ttf

FONT_WOFF - Static variable in class io.muserver.ContentTypes

Web Open Font Format (WOFF): "font/woff"

FONT_WOFF - Static variable in class io.muserver.handlers.ResourceType

font/woff

FONT_WOFF2 - Static variable in class io.muserver.ContentTypes

Web Open Font Format (WOFF): "font/woff2"

FONT_WOFF2 - Static variable in class io.muserver.handlers.ResourceType

font/woff2

form() - Method in interface io.muserver.MuRequest

Gets the form parameters for this request.

FORM_DATA - Static variable in class io.muserver.HeaderValues

"form-data" See HeaderNames.CONTENT_DISPOSITION

FORM_PARAM - io.muserver.rest.SchemaObjectCustomizerTarget

A form parameter

format - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.format() instead

format() - Method in class io.muserver.openapi.SchemaObject

format() - Method in class io.muserver.openapi.SchemaObjectBuilder

formValue(String) - Method in interface io.muserver.MuRequest

Deprecated.

Use form().get(name) instead

formValues(String) - Method in interface io.muserver.MuRequest

Deprecated.

Use form().getAll(name) instead

forValue() - Method in class io.muserver.ForwardedHeader

forwarded() - Method in interface io.muserver.Headers

Gets the Forwarded header value.

FORWARDED - Static variable in class io.muserver.HeaderNames

"forwarded"

ForwardedHeader - Class in io.muserver

Represents a Forwarded header as described by RFC-7239.

ForwardedHeader(String, String, String, String, Map<String, String>) - Constructor for class io.muserver.ForwardedHeader

Creates a new Forwarded Header.

FROM - Static variable in class io.muserver.HeaderNames

"from"

fromHttpDate(String) - Static method in class io.muserver.Mutils

Converts a date string as used in HTTP headers (defined in RFC 7321) into a date object

fromString(String) - Static method in class io.muserver.ForwardedHeader

Parses the value of a Forwarded header into an object.

fromString(String) - Static method in class io.muserver.MediaTypeParser

Converts a string such as "text/plain" into a MediaType object.

fromString(String) - Static method in class io.muserver.ParameterizedHeader

Converts a comma-separated list of param names (with optional values) into a Parameterized Header

fromString(String) - Static method in class io.muserver.ParameterizedHeaderWithValue

Converts headers that are values followed by optional parameters into a list of values with parameters.

FULL_SENT - io.muserver.ResponseState

A non-chunked response has been successfully sent to the client

fullPath(File) - Static method in class io.muserver.Mutils

Gets the canonical path of the given file, or if that throws an exception then gets the absolute path.

fullyMatches() - Method in class io.muserver.rest.PathMatch

G

get(CharSequence) - Method in interface io.muserver.Headers

Gets the value with the given name, or null if there is no parameter with that name.

get(CharSequence, String) - Method in interface io.muserver.Headers

Gets the value with the given name, or the default value if there is no parameter with that name.

get(String) - Method in interface io.muserver.Headers

Gets the value with the given name, or null if there is no parameter with that name.

get(String) - Method in interface io.muserver.RequestParameters

Gets the value with the given name, or null if there is no parameter with that name.

get(String, String) - Method in interface io.muserver.RequestParameters

Gets the value with the given name, or the default value if there is no parameter with that name.

GET - io.muserver.Method

The GET HTTP method

getAll(CharSequence) - Method in interface io.muserver.Headers

Gets all the parameters with the given name, or an empty list if none are found.

getAll(String) - Method in interface io.muserver.Headers

Gets all the parameters with the given name, or an empty list if none are found.

getAll(String) - Method in interface io.muserver.RequestParameters

Gets all the parameters with the given name, or an empty list if none are found.

getAllAsString(CharSequence) - Method in interface io.muserver.Headers

Deprecated.

use an alternative

getAsString(CharSequence) - Method in interface io.muserver.Headers

Deprecated.

use an alternative

getBoolean(String) - Method in interface io.muserver.Headers

Gets a parameter as a boolean, where values such as true, on and yes as considered true, and other values (or no parameter with the name) is considered false.

getBoolean(String) - Method in interface io.muserver.RequestParameters

Gets a parameter as a boolean, where values such as true, on and yes as considered true, and other values (or no parameter with the name) is considered false.

getDefaultMapping() - Static method in class io.muserver.handlers.ResourceType

Can be used as a base to customise mime types via ResourceHandlerBuilder.withExtensionToResourceType(Map)

getDouble(String, double) - Method in interface io.muserver.Headers

Gets the parameter as a double, or returns the default value if it was not specified or was in an invalid format.

getDouble(String, double) - Method in interface io.muserver.RequestParameters

Gets the parameter as a double, or returns the default value if it was not specified or was in an invalid format.

getFloat(String, float) - Method in interface io.muserver.Headers

Gets the parameter as a float, or returns the default value if it was not specified or was in an invalid format.

getFloat(String, float) - Method in interface io.muserver.RequestParameters

Gets the parameter as a float, or returns the default value if it was not specified or was in an invalid format.

getInt(CharSequence) - Method in interface io.muserver.Headers

Deprecated.

use Headers.getInt(CharSequence, int)

getInt(CharSequence, int) - Method in interface io.muserver.Headers

Gets the parameter as an integer, or returns the default value if it was not specified or was in an invalid format.

getInt(String, int) - Method in interface io.muserver.RequestParameters

Gets the parameter as an integer, or returns the default value if it was not specified or was in an invalid format.

getLong(String, long) - Method in interface io.muserver.Headers

Gets the parameter as a long, or returns the default value if it was not specified or was in an invalid format.

getLong(String, long) - Method in interface io.muserver.RequestParameters

Gets the parameter as a long, or returns the default value if it was not specified or was in an invalid format.

getPathToServeFrom() - Method in class io.muserver.handlers.ResourceHandler

Deprecated.

This is a temporary accessor which will be demised. Do not use this.

getResourceTypes() - Static method in class io.muserver.handlers.ResourceType

getShort(CharSequence) - Method in interface io.muserver.Headers

Deprecated.

Please use an alternate accessor

getShort(CharSequence, short) - Method in interface io.muserver.Headers

Deprecated.

Please use an alternate accessor

getTimeMillis(CharSequence) - Method in interface io.muserver.Headers

Gets a date header.

getTimeMillis(CharSequence, long) - Method in interface io.muserver.Headers

Gets a date header.

gzip - Variable in class io.muserver.handlers.ResourceType

Deprecated.

use ResourceType.gzip() instead

gzip() - Method in class io.muserver.handlers.ResourceType

GZIP - Static variable in class io.muserver.HeaderValues

"gzip"

GZIP_DEFLATE - Static variable in class io.muserver.HeaderValues

"gzip,deflate"

gzipEnabled() - Method in interface io.muserver.MuServer

Specifies whether GZIP is on or not.

gzippableMimeTypes(Collection<ResourceType>) - Static method in class io.muserver.handlers.ResourceType

Given a list of resources, returns the ones that are gzippable

H

handle(MuRequest, MuResponse) - Method in class io.muserver.ContextHandler

handle(MuRequest, MuResponse) - Method in class io.muserver.handlers.CORSHandler

handle(MuRequest, MuResponse) - Method in class io.muserver.handlers.HttpsRedirector

handle(MuRequest, MuResponse) - Method in class io.muserver.handlers.ResourceHandler

handle(MuRequest, MuResponse) - Method in interface io.muserver.MuHandler

Called when an HTTP request is made (unless a previous handler stopped handler processing)

handle(MuRequest, MuResponse) - Method in class io.muserver.rest.RestHandler

handle(MuRequest, MuResponse) - Method in class io.muserver.WebSocketHandler

handle(MuRequest, MuResponse, Throwable) - Method in interface io.muserver.UnhandledExceptionHandler

Called when an exception is thrown by another handler.

handle(MuRequest, MuResponse, Map<String, String>) - Method in interface io.muserver.RouteHandler

Called when a request matches the given route

handleAsync() - Method in interface io.muserver.MuRequest

Specifies that you want to handle this response asynchronously.

hasBody() - Method in interface io.muserver.Headers

Returns true if the headers suggest there is a message body by checking if there is a HeaderNames.TRANSFER_ENCODING header or the HeaderNames.CONTENT_LENGTH is greater than 0.

hashCode() - Method in class io.muserver.Cookie

hashCode() - Method in class io.muserver.ForwardedHeader

hashCode() - Method in class io.muserver.openapi.TagObject

hashCode() - Method in class io.muserver.ParameterizedHeader

hashCode() - Method in class io.muserver.ParameterizedHeaderWithValue

hashCode() - Method in class io.muserver.rest.CORSConfig

hashCode() - Method in class io.muserver.rest.UriPattern

hasParameter(String) - Method in class io.muserver.ParameterizedHeader

hasStartedSendingData() - Method in interface io.muserver.MuResponse

Specifies whether or not any response data has already been sent to the client.

hasValue(String) - Static method in class io.muserver.Mutils

Checks that a string is not null and has a length greater than 0.

HEAD - io.muserver.Method

The HEAD HTTP method

HeaderNames - Class in io.muserver

Standard HTTP header names.

headerObject() - Static method in class io.muserver.openapi.HeaderObjectBuilder

Creates a builder for a HeaderObject

HeaderObject - Class in io.muserver.openapi

HeaderObjectBuilder - Class in io.muserver.openapi

A builder for HeaderObject objects

HeaderObjectBuilder() - Constructor for class io.muserver.openapi.HeaderObjectBuilder

headers - Variable in class io.muserver.handlers.ResourceType

Deprecated.

use ResourceType.headers() instead

headers - Variable in class io.muserver.openapi.ComponentsObject

Deprecated.

headers - Variable in class io.muserver.openapi.EncodingObject

Deprecated.

Use EncodingObject.headers() instead

headers - Variable in class io.muserver.openapi.ResponseObject

Deprecated.

use ResponseObject.headers() instead

headers() - Method in class io.muserver.handlers.ResourceType

headers() - Method in interface io.muserver.MuRequest

headers() - Method in interface io.muserver.MuResponse

Gets the response headers map which can be used to specify response headers.

headers() - Method in class io.muserver.openapi.ComponentsObject

headers() - Method in class io.muserver.openapi.EncodingObject

headers() - Method in class io.muserver.openapi.ResponseObject

Headers - Interface in io.muserver

HTTP headers

HeaderValues - Class in io.muserver

Standard HTTP header values.

host() - Method in class io.muserver.ForwardedHeader

HOST - Static variable in class io.muserver.HeaderNames

"host"

htmlEncode(String) - Static method in class io.muserver.Mutils

Very basic HTML encoding, converting characters such as < to <lt;

http1Headers() - Static method in interface io.muserver.Headers

Creates new headers for HTTP1 requests

http2 - Static variable in class io.muserver.Toggles

Deprecated.

Use Http2ConfigBuilder instead

http2Config() - Static method in class io.muserver.Http2ConfigBuilder

Creates a new config where HTTP2 is disabled

Http2Config - Class in io.muserver

Configuration settings for HTTP2

Http2ConfigBuilder - Class in io.muserver

Configuration builder for enabling HTTP2 by passing the config to MuServerBuilder.withHttp2Config(Http2ConfigBuilder)

Http2ConfigBuilder() - Constructor for class io.muserver.Http2ConfigBuilder

http2Enabled() - Static method in class io.muserver.Http2ConfigBuilder

Creates a new config where HTTP2 is enabled

http2EnabledIfAvailable() - Static method in class io.muserver.Http2ConfigBuilder

Creates a new config where HTTP2 is enabled if supported by the Java version.

http2Headers() - Static method in interface io.muserver.Headers

Creates new headers for HTTP2 requests

HttpConnection - Interface in io.muserver

A connection between a server and a client.

httpOnly(boolean) - Method in class io.muserver.CookieBuilder

Instructs browsers on whether or not the cookie can be accessed via JavaScript.

httpsConfig() - Static method in class io.muserver.HttpsConfigBuilder

HttpsConfigBuilder - Class in io.muserver

A builder for specifying HTTPS config.

HttpsConfigBuilder() - Constructor for class io.muserver.HttpsConfigBuilder

httpServer() - Static method in class io.muserver.MuServerBuilder

Creates a new server builder which will run as HTTP on a random port.

httpsProtocol() - Method in interface io.muserver.HttpConnection

Gets the HTTPS protocol, for example "TLSv1.2" or "TLSv1.3"

HttpsRedirector - Class in io.muserver.handlers

Sends any HTTP requests to the same HTTPS address at the supplied port and optionally enables Strict-Transport-Security (HSTS)

HttpsRedirector.Builder - Class in io.muserver.handlers

Deprecated.

Use HttpsRedirectorBuilder

HttpsRedirectorBuilder - Class in io.muserver.handlers

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)

HttpsRedirectorBuilder() - Constructor for class io.muserver.handlers.HttpsRedirectorBuilder

httpsServer() - Static method in class io.muserver.MuServerBuilder

Creates a new server builder which will run as HTTPS on a random port.

httpStatusCodes - Variable in class io.muserver.openapi.ResponsesObject

Deprecated.

use ResponsesObject.httpStatusCodes() instead

httpStatusCodes() - Method in class io.muserver.openapi.ResponsesObject

httpsUri() - Method in interface io.muserver.MuServer

HttpToHttpsRedirector - Class in io.muserver.handlers

Deprecated.

Use HttpsRedirectorBuilder.toHttpsPort(int) instead and add it as standard handler.

HttpToHttpsRedirector(int) - Constructor for class io.muserver.handlers.HttpToHttpsRedirector

Deprecated.

Use HttpsRedirectorBuilder.toHttpsPort(int) instead and add it as standard handler.

httpUri() - Method in interface io.muserver.MuServer

I

IDENTITY - Static variable in class io.muserver.HeaderValues

"identity"

IF_MATCH - Static variable in class io.muserver.HeaderNames

"if-match"

IF_MODIFIED_SINCE - Static variable in class io.muserver.HeaderNames

"if-modified-since"

IF_NONE_MATCH - Static variable in class io.muserver.HeaderNames

"if-none-match"

IF_RANGE - Static variable in class io.muserver.HeaderNames

"if-range"

IF_UNMODIFIED_SINCE - Static variable in class io.muserver.HeaderNames

"if-unmodified-since"

IGNORE - io.muserver.RateLimitRejectionAction

Nothing happens except the event is logged.

IMAGE_AVIF - Static variable in class io.muserver.ContentTypes

AVIF image: "image/avif"

IMAGE_AVIF - Static variable in class io.muserver.handlers.ResourceType

image/avif

IMAGE_GIF - Static variable in class io.muserver.ContentTypes

Graphics Interchange Format (GIF): "image/gif"

IMAGE_GIF - Static variable in class io.muserver.handlers.ResourceType

image/gif

IMAGE_JPEG - Static variable in class io.muserver.ContentTypes

JPEG images: "image/jpeg"

IMAGE_JPEG - Static variable in class io.muserver.handlers.ResourceType

image/jpeg

IMAGE_PNG - Static variable in class io.muserver.ContentTypes

Portable Network Graphics: "image/png"

IMAGE_PNG - Static variable in class io.muserver.handlers.ResourceType

image/png

IMAGE_SVG_XML - Static variable in class io.muserver.ContentTypes

Scalable Vector Graphics (SVG): "image/svg+xml"

IMAGE_SVG_XML - Static variable in class io.muserver.handlers.ResourceType

image/svg-xml

IMAGE_TIFF - Static variable in class io.muserver.ContentTypes

Tagged Image File Format (TIFF): "image/tiff"

IMAGE_TIFF - Static variable in class io.muserver.handlers.ResourceType

image/tiff

IMAGE_WEBP - Static variable in class io.muserver.ContentTypes

WEBP image: "image/webp"

IMAGE_WEBP - Static variable in class io.muserver.handlers.ResourceType

image/webp

IMAGE_X_ICON - Static variable in class io.muserver.ContentTypes

Icon format: "image/x-icon"

IMAGE_X_ICON - Static variable in class io.muserver.handlers.ResourceType

image/x-icon

implicit - Variable in class io.muserver.openapi.OAuthFlowsObject

Deprecated.

use OAuthFlowsObject.implicit() instead

implicit() - Method in class io.muserver.openapi.OAuthFlowsObject

in - Variable in class io.muserver.openapi.ParameterObject

Deprecated.

in - Variable in class io.muserver.openapi.SecuritySchemeObject

Deprecated.

use SecuritySchemeObject.in() instead

in() - Method in class io.muserver.openapi.ParameterObject

in() - Method in class io.muserver.openapi.SecuritySchemeObject

includeSubDomains(boolean) - Method in class io.muserver.handlers.HttpsRedirectorBuilder

Specifies that any subdomains should have HSTS enforced too.

info - Variable in class io.muserver.openapi.OpenAPIObject

Deprecated.

info() - Method in class io.muserver.openapi.OpenAPIObject

infoObject() - Static method in class io.muserver.openapi.InfoObjectBuilder

Creates a builder for a InfoObject

InfoObject - Class in io.muserver.openapi

InfoObjectBuilder - Class in io.muserver.openapi

The object provides metadata about the API.

InfoObjectBuilder() - Constructor for class io.muserver.openapi.InfoObjectBuilder

inputStream() - Method in interface io.muserver.MuRequest

The input stream of the request, if there was a request body.

invalidHttpRequests() - Method in interface io.muserver.HttpConnection

invalidHttpRequests() - Method in interface io.muserver.MuStats

io.muserver - package io.muserver

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

io.muserver.handlers - package io.muserver.handlers

Some pre-built handlers for common tasks such as file handling.

io.muserver.openapi - package io.muserver.openapi

A model of the Open API spec, which is used internally when creating documentation for JAX-RS services.

io.muserver.rest - package io.muserver.rest

This package contains the JAX-RS implementation for mu-server.

isAsync() - Method in interface io.muserver.MuRequest

isClosed() - Method in interface io.muserver.AsyncSsePublisher

Checks if this publisher has been closed.

isDeprecated() - Method in class io.muserver.openapi.OperationObject

isDeprecated() - Method in class io.muserver.openapi.SchemaObject

isEmpty() - Method in interface io.muserver.Headers

isHttpOnly() - Method in class io.muserver.Cookie

isHttps() - Method in interface io.muserver.HttpConnection

isInRole(Principal, String) - Method in interface io.muserver.rest.Authorizer

Checks if a user is in a role

isSecure() - Method in class io.muserver.Cookie

items - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.items() instead

items() - Method in class io.muserver.openapi.SchemaObject

items() - Method in class io.muserver.openapi.SchemaObjectBuilder

iterator() - Method in interface io.muserver.Headers

iteratorAsString() - Method in interface io.muserver.Headers

Deprecated.

use an alternative

J

join(String, String, String) - Static method in class io.muserver.Mutils

Joins two strings with the given separator, unless the first string ends with the separator, or the second string begins with it.

K

KEEP_ALIVE - Static variable in class io.muserver.HeaderValues

"keep-alive"

L

LAST_EVENT_ID - Static variable in class io.muserver.HeaderNames

"last-event-id"

LAST_MODIFIED - Static variable in class io.muserver.HeaderNames

"last-modified"

license - Variable in class io.muserver.openapi.InfoObject

Deprecated.

use InfoObject.license() instead

license() - Method in class io.muserver.openapi.InfoObject

licenseObject() - Static method in class io.muserver.openapi.LicenseObjectBuilder

Creates a builder for a LicenseObject

LicenseObject - Class in io.muserver.openapi

LicenseObjectBuilder - Class in io.muserver.openapi

License information for the exposed API.

LicenseObjectBuilder() - Constructor for class io.muserver.openapi.LicenseObjectBuilder

LINK - Static variable in class io.muserver.HeaderNames

"link"

linkObject() - Static method in class io.muserver.openapi.LinkObjectBuilder

Creates a builder for a LinkObject

LinkObject - Class in io.muserver.openapi

LinkObjectBuilder - Class in io.muserver.openapi

The Link object represents a possible design-time link for a response.

LinkObjectBuilder() - Constructor for class io.muserver.openapi.LinkObjectBuilder

links - Variable in class io.muserver.openapi.ComponentsObject

Deprecated.

links - Variable in class io.muserver.openapi.ResponseObject

Deprecated.

use ResponseObject.links() instead

links() - Method in class io.muserver.openapi.ComponentsObject

links() - Method in class io.muserver.openapi.ResponseObject

LOCATION - Static variable in class io.muserver.HeaderNames

"location"

M

makeSessionCookie() - Method in class io.muserver.CookieBuilder

Makes this cookie expire when the browser session expires (which may be when the user closes their browser).

mapping - Variable in class io.muserver.openapi.DiscriminatorObject

Deprecated.

mapping() - Method in class io.muserver.openapi.DiscriminatorObject

matcher(String) - Method in class io.muserver.rest.UriPattern

Matches the given raw path against this pattern.

matcher(URI) - Method in class io.muserver.rest.UriPattern

Matches the given URI against this pattern.

MAX_AGE - Static variable in class io.muserver.HeaderValues

"max-age"

MAX_FORWARDS - Static variable in class io.muserver.HeaderNames

"max-forwards"

MAX_STALE - Static variable in class io.muserver.HeaderValues

"max-stale"

maxAge - Variable in class io.muserver.rest.CORSConfig

Deprecated.

use CORSConfig.maxAge() instead

maxAge() - Method in class io.muserver.Cookie

maxAge() - Method in class io.muserver.rest.CORSConfig

maximum - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.maximum() instead

maximum() - Method in class io.muserver.openapi.SchemaObject

maximum() - Method in class io.muserver.openapi.SchemaObjectBuilder

maxItems - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.maxItems() instead

maxItems() - Method in class io.muserver.openapi.SchemaObject

maxItems() - Method in class io.muserver.openapi.SchemaObjectBuilder

maxLength - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.maxLength() instead

maxLength() - Method in class io.muserver.openapi.SchemaObject

maxLength() - Method in class io.muserver.openapi.SchemaObjectBuilder

maxProperties - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.maxProperties() instead

maxProperties() - Method in class io.muserver.openapi.SchemaObject

maxProperties() - Method in class io.muserver.openapi.SchemaObjectBuilder

maxRequestHeadersSize() - Method in interface io.muserver.MuServer

The maximum allowed size of request headers.

maxRequestSize() - Method in interface io.muserver.MuServer

The maximum allowed size of a request body.

maxUrlSize() - Method in interface io.muserver.MuServer

The maximum allowed size of the URI sent in a request line.

mediaType() - Method in class io.muserver.rest.SchemaObjectCustomizerContext

mediaTypeObject() - Static method in class io.muserver.openapi.MediaTypeObjectBuilder

Creates a builder for a MediaTypeObject

MediaTypeObject - Class in io.muserver.openapi

MediaTypeObjectBuilder - Class in io.muserver.openapi

Each Media Type Object provides schema and examples for the media type identified by its key.

MediaTypeObjectBuilder() - Constructor for class io.muserver.openapi.MediaTypeObjectBuilder

MediaTypeParser - Class in io.muserver

A utility class to parse Media Type or Content Type values such as text/plain and text/plain; charset=UTF-8 etc

MediaTypeParser() - Constructor for class io.muserver.MediaTypeParser

mergeResponses(ResponseObject, ResponseObject) - Static method in class io.muserver.openapi.ResponseObjectBuilder

Creates a new build by merging two existing response objects

mergeResponses(ResponsesObject, ResponsesObject) - Static method in class io.muserver.openapi.ResponsesObjectBuilder

Creates a new build by merging two exising responses

message() - Method in annotation type io.muserver.rest.ApiResponse

A short description of the response.

method() - Method in interface io.muserver.MuRequest

Method - Enum in io.muserver

An HTTP Method

methodHandle() - Method in class io.muserver.rest.SchemaObjectCustomizerContext

mimeType - Variable in class io.muserver.handlers.ResourceType

Deprecated.

use ResourceType.mimeType() instead

mimeType() - Method in class io.muserver.handlers.ResourceType

mimeTypesToGzip() - Method in interface io.muserver.MuServer

Specifies the mime-types that GZIP should be applied to.

MIN_FRESH - Static variable in class io.muserver.HeaderValues

"min-fresh"

minimum - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.minimum() instead

minimum() - Method in class io.muserver.openapi.SchemaObject

minimum() - Method in class io.muserver.openapi.SchemaObjectBuilder

minimumGzipSize() - Method in interface io.muserver.MuServer

The size a response body must be before GZIP is enabled, if MuServer.gzipEnabled() is true and the mime type is in MuServer.mimeTypesToGzip()

minItems - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.minItems() instead

minItems() - Method in class io.muserver.openapi.SchemaObject

minItems() - Method in class io.muserver.openapi.SchemaObjectBuilder

minLength - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.minLength() instead

minLength() - Method in class io.muserver.openapi.SchemaObject

minLength() - Method in class io.muserver.openapi.SchemaObjectBuilder

minProperties - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.minProperties() instead

minProperties() - Method in class io.muserver.openapi.SchemaObject

minProperties() - Method in class io.muserver.openapi.SchemaObjectBuilder

MITLicense() - Static method in class io.muserver.openapi.LicenseObjectBuilder

MU_REQUEST_PROPERTY - Static variable in class io.muserver.rest.MuRuntimeDelegate

The ContainerRequestContext or InterceptorContext property name to use to get the MuRequest for the current JAX-RS request, which can be used in a ContainerRequestFilter, ContainerResponseFilter, ReaderInterceptor or WriterInterceptor.

MuException - Exception in io.muserver

A generic exception raised by mu-server

MuException(String) - Constructor for exception io.muserver.MuException

Creates a new exception

MuException(String, Throwable) - Constructor for exception io.muserver.MuException

Creates a new exception

MuHandler - Interface in io.muserver

An HTTP request handler.

MuHandlerBuilder<T extends MuHandler> - Interface in io.muserver

A builder for MuHandler objects

MULTIPART_FORM_DATA - Static variable in class io.muserver.HeaderValues

"multipart/form-data"

MULTIPART_MIXED - Static variable in class io.muserver.HeaderValues

"multipart/mixed"

multipleOf - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.multipleOf() instead

multipleOf() - Method in class io.muserver.openapi.SchemaObject

multipleOf() - Method in class io.muserver.openapi.SchemaObjectBuilder

MuRequest - Interface in io.muserver

An HTTP request from a client.

MuResponse - Interface in io.muserver

A response sent to a client.

MuRuntimeDelegate - Class in io.muserver.rest

The JAX-RS runtime delegate for mu-server.

muServer() - Static method in class io.muserver.MuServerBuilder

Creates a new server builder.

MuServer - Interface in io.muserver

A web server handler.

MuServerBuilder - Class in io.muserver

A builder for creating a web server.

MuServerBuilder() - Constructor for class io.muserver.MuServerBuilder

MUST_REVALIDATE - Static variable in class io.muserver.HeaderValues

"must-revalidate"

MuStats - Interface in io.muserver

Various statistics about the current instance of a Mu Server.

Mutils - Class in io.muserver

Utility methods

MuWebSocket - Interface in io.muserver

An interface defining the callbacks received on a websocket which is returned by MuWebSocketFactory.create(MuRequest, Headers).

MuWebSocketFactory - Interface in io.muserver

A factory that can convert an upgrade request into a web socket.

MuWebSocketSession - Interface in io.muserver

A web socket session used to send messages and events to a web socket client.

N

name - Variable in class io.muserver.openapi.ContactObject

Deprecated.

name - Variable in class io.muserver.openapi.LicenseObject

Deprecated.

use LicenseObject.name() instead

name - Variable in class io.muserver.openapi.ParameterObject

Deprecated.

name - Variable in class io.muserver.openapi.SecuritySchemeObject

Deprecated.

use SecuritySchemeObject.name() instead

name - Variable in class io.muserver.openapi.TagObject

Deprecated.

use TagObject.name() instead

name - Variable in class io.muserver.openapi.XmlObject

Deprecated.

use XmlObject.name() instead

name() - Method in class io.muserver.Cookie

name() - Method in class io.muserver.openapi.ContactObject

name() - Method in class io.muserver.openapi.LicenseObject

name() - Method in class io.muserver.openapi.ParameterObject

name() - Method in class io.muserver.openapi.SecuritySchemeObject

name() - Method in class io.muserver.openapi.TagObject

name() - Method in class io.muserver.openapi.XmlObject

name() - Method in annotation type io.muserver.rest.ResponseHeader

The header name.

NAME - Static variable in class io.muserver.HeaderValues

"name" See HeaderNames.CONTENT_DISPOSITION

namedGroups() - Method in class io.muserver.rest.UriPattern

names() - Method in interface io.muserver.Headers

namespace - Variable in class io.muserver.openapi.XmlObject

Deprecated.

use XmlObject.namespace() instead

namespace() - Method in class io.muserver.openapi.XmlObject

newCookie() - Static method in class io.muserver.CookieBuilder

Creates a new session cookie

NEWLINE - Static variable in class io.muserver.Mutils

The new-line character for the current platform, e.g.

newSecureCookie() - Static method in class io.muserver.CookieBuilder

Creates a new session cookie that is only sent over HTTPS and cannot be accessed with JavaScript with a Strict samesite policy applied.

NO_CACHE - Static variable in class io.muserver.HeaderValues

"no-cache"

NO_STORE - Static variable in class io.muserver.HeaderValues

"no-store"

NO_TRANSFORM - io.muserver.rest.CollectionParameterStrategy

No transformation is applied, for example a,b,c would result in a single string with value "a,b,c"

NO_TRANSFORM - Static variable in class io.muserver.HeaderValues

"no-transform"

noCache() - Static method in class io.muserver.handlers.ResourceType

NONE - Static variable in class io.muserver.HeaderValues

"none"

NoOp - Static variable in interface io.muserver.DoneCallback

A callback that does nothing on completion.

NoOp - Static variable in interface io.muserver.WriteCallback

Deprecated.

A write callback that does nothing when it receives the callbacks

NOSNIFF - Static variable in class io.muserver.HeaderValues

"nosniff"

not - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.not() instead

not() - Method in class io.muserver.openapi.SchemaObject

not() - Method in class io.muserver.openapi.SchemaObjectBuilder

NOT_STARTED - io.muserver.WebsocketSessionState

The session has not started yet

NOTHING - io.muserver.ResponseState

Nothing has started yet

notNull(String, Object) - Static method in class io.muserver.Mutils

Throws an IllegalArgumentException if the given value is null

nullable - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.nullable() instead

nullable() - Method in class io.muserver.openapi.SchemaObject

nullable() - Method in class io.muserver.openapi.SchemaObjectBuilder

nullOrEmpty(String) - Static method in class io.muserver.Mutils

Checks for a null string or string with a length of 9

O

oAuthFlowObject() - Static method in class io.muserver.openapi.OAuthFlowObjectBuilder

Creates a builder for an OAuthFlowObject

OAuthFlowObject - Class in io.muserver.openapi

OAuthFlowObjectBuilder - Class in io.muserver.openapi

Configuration details for a supported OAuth Flow

OAuthFlowObjectBuilder() - Constructor for class io.muserver.openapi.OAuthFlowObjectBuilder

oAuthFlowsObject() - Static method in class io.muserver.openapi.OAuthFlowsObjectBuilder

Creates a builder for an OAuthFlowsObject

OAuthFlowsObject - Class in io.muserver.openapi

OAuthFlowsObjectBuilder - Class in io.muserver.openapi

Allows configuration of the supported OAuth Flows.

OAuthFlowsObjectBuilder() - Constructor for class io.muserver.openapi.OAuthFlowsObjectBuilder

onBinary(ByteBuffer, boolean, DoneCallback) - Method in class io.muserver.BaseWebSocket

onBinary(ByteBuffer, boolean, DoneCallback) - Method in interface io.muserver.MuWebSocket

Called when a message is received from the client.

onBinary(ByteBuffer, DoneCallback) - Method in interface io.muserver.MuWebSocket

Deprecated.

use MuWebSocket.onBinary(ByteBuffer, boolean, DoneCallback) instead

onClientClosed(int, String) - Method in class io.muserver.BaseWebSocket

onClientClosed(int, String) - Method in interface io.muserver.MuWebSocket

Called when the client has closed the connection.

onComplete() - Method in interface io.muserver.RequestBodyListener

Called when the request body is fully received.

onComplete(boolean) - Method in interface io.muserver.AsyncHandle.ResponseCompletedListener

Deprecated.

Called when it is detected that the client request is completed.

onComplete(ResponseInfo) - Method in interface io.muserver.ResponseCompleteListener

Called when a response completes (successfully or not).

onComplete(Throwable) - Method in interface io.muserver.DoneCallback

The operation has completed.

onConnect(MuWebSocketSession) - Method in class io.muserver.BaseWebSocket

onConnect(MuWebSocketSession) - Method in interface io.muserver.MuWebSocket

Called when the websocket is connected.

onDataReceived(ByteBuffer, DoneCallback) - Method in interface io.muserver.RequestBodyListener

Called when request data is received from the client.

oneOf - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.oneOf() instead

oneOf() - Method in class io.muserver.openapi.SchemaObject

oneOf() - Method in class io.muserver.openapi.SchemaObjectBuilder

onError(Throwable) - Method in class io.muserver.BaseWebSocket

onError(Throwable) - Method in interface io.muserver.MuWebSocket

Called when an unexpected error occurs.

onError(Throwable) - Method in interface io.muserver.RequestBodyListener

Called if there is an error reading the body.

onFailure(Throwable) - Method in interface io.muserver.WriteCallback

Deprecated.

Called if the write failed, for example if the user closed their browser while writing to it

ONLY_IF_CACHED - Static variable in class io.muserver.HeaderValues

"only-if-cached"

onPing(ByteBuffer, DoneCallback) - Method in class io.muserver.BaseWebSocket

onPing(ByteBuffer, DoneCallback) - Method in interface io.muserver.MuWebSocket

Called when a ping message is sent from a client.

onPong(ByteBuffer, DoneCallback) - Method in class io.muserver.BaseWebSocket

onPong(ByteBuffer, DoneCallback) - Method in interface io.muserver.MuWebSocket

Called when a pong message is sent from the client.

onSuccess() - Method in interface io.muserver.WriteCallback

Deprecated.

Called if the write succeeds

onText(String, boolean, DoneCallback) - Method in class io.muserver.BaseWebSocket

onText(String, boolean, DoneCallback) - Method in interface io.muserver.MuWebSocket

Called when a message is received from the client.

onText(String, DoneCallback) - Method in interface io.muserver.MuWebSocket

Deprecated.

use MuWebSocket.onText(String, boolean, DoneCallback) instead

OPEN - io.muserver.WebsocketSessionState

The session is running and messages can be written and received

openapi - Variable in class io.muserver.openapi.OpenAPIObject

Deprecated.

openApi() - Method in class io.muserver.openapi.OpenAPIObject

openAPIObject() - Static method in class io.muserver.openapi.OpenAPIObjectBuilder

Creates a builder for an OpenAPIObject

OpenAPIObject - Class in io.muserver.openapi

OpenAPIObjectBuilder - Class in io.muserver.openapi

This is the root document object of the OpenAPI document.

OpenAPIObjectBuilder() - Constructor for class io.muserver.openapi.OpenAPIObjectBuilder

openIdConnectUrl - Variable in class io.muserver.openapi.SecuritySchemeObject

Deprecated.

use SecuritySchemeObject.openIdConnectUrl() instead

openIdConnectUrl() - Method in class io.muserver.openapi.SecuritySchemeObject

operationId - Variable in class io.muserver.openapi.LinkObject

Deprecated.

use LinkObject.operationId() instead

operationId - Variable in class io.muserver.openapi.OperationObject

Deprecated.

use OperationObject.operationId() instead

operationId() - Method in class io.muserver.openapi.LinkObject

operationId() - Method in class io.muserver.openapi.OperationObject

operationObject() - Static method in class io.muserver.openapi.OperationObjectBuilder

Creates a builder for a OperationObject

OperationObject - Class in io.muserver.openapi

OperationObjectBuilder - Class in io.muserver.openapi

Describes a single API operation on a path.

OperationObjectBuilder() - Constructor for class io.muserver.openapi.OperationObjectBuilder

operations - Variable in class io.muserver.openapi.PathItemObject

Deprecated.

use PathItemObject.operations() instead

operations() - Method in class io.muserver.openapi.PathItemObject

operations() - Method in class io.muserver.openapi.PathItemObjectBuilder

OPTIONS - io.muserver.Method

The OPTIONS HTTP method

ORIGIN - Static variable in class io.muserver.HeaderNames

"origin"

outputStream() - Method in interface io.muserver.MuResponse

Gets a buffered output stream that can send data to the client.

outputStream(int) - Method in interface io.muserver.MuResponse

Gets a buffered output stream that can send data to the client.

P

parameter(String) - Method in interface io.muserver.MuRequest

Deprecated.

Use query().get(name) instead

parameter(String) - Method in class io.muserver.ParameterizedHeader

parameter(String) - Method in class io.muserver.ParameterizedHeaderWithValue

parameter(String, String) - Method in class io.muserver.ParameterizedHeader

parameter(String, String) - Method in class io.muserver.ParameterizedHeaderWithValue

ParameterizedHeader - Class in io.muserver

A utility class to parse headers that are of the format param1, param2=value, param3="quoted string" such as Cache-Control etc.

ParameterizedHeaderWithValue - Class in io.muserver

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.

parameterizedType() - Method in class io.muserver.rest.SchemaObjectCustomizerContext

parameterName() - Method in class io.muserver.rest.SchemaObjectCustomizerContext

parameterNames() - Method in class io.muserver.ParameterizedHeader

parameterObject() - Static method in class io.muserver.openapi.ParameterObjectBuilder

Creates a builder for a ParameterObject

ParameterObject - Class in io.muserver.openapi

ParameterObjectBuilder - Class in io.muserver.openapi

Describes a single operation parameter.

ParameterObjectBuilder() - Constructor for class io.muserver.openapi.ParameterObjectBuilder

parameters - Variable in class io.muserver.openapi.ComponentsObject

Deprecated.

parameters - Variable in class io.muserver.openapi.LinkObject

Deprecated.

use LinkObject.parameters() instead

parameters - Variable in class io.muserver.openapi.OperationObject

Deprecated.

use OperationObject.parameters() instead

parameters - Variable in class io.muserver.openapi.PathItemObject

Deprecated.

use PathItemObject.parameters() instead

parameters() - Method in class io.muserver.openapi.ComponentsObject

parameters() - Method in class io.muserver.openapi.LinkObject

parameters() - Method in class io.muserver.openapi.OperationObject

parameters() - Method in class io.muserver.openapi.PathItemObject

parameters() - Method in class io.muserver.ParameterizedHeader

parameters() - Method in class io.muserver.ParameterizedHeaderWithValue

parameters(String) - Method in interface io.muserver.MuRequest

Deprecated.

Use query().getAll(name) instead

params() - Method in class io.muserver.rest.PathMatch

Returns a mapping of URI names to path params.

password - Variable in class io.muserver.openapi.OAuthFlowsObject

Deprecated.

use OAuthFlowsObject.password() instead

password() - Method in class io.muserver.openapi.OAuthFlowsObject

PATCH - io.muserver.Method

The PATCH HTTP method

path() - Method in class io.muserver.Cookie

pathItemObject() - Static method in class io.muserver.openapi.PathItemObjectBuilder

Creates a builder for a PathItemObject

PathItemObject - Class in io.muserver.openapi

PathItemObjectBuilder - Class in io.muserver.openapi

Describes the operations available on a single path.

PathItemObjectBuilder() - Constructor for class io.muserver.openapi.PathItemObjectBuilder

pathItemObjects - Variable in class io.muserver.openapi.PathsObject

Deprecated.

use PathsObject.pathItemObjects() instead

pathItemObjects() - Method in class io.muserver.openapi.PathsObject

PathMatch - Class in io.muserver.rest

The result of matching a template URI against a real request URI.

paths - Variable in class io.muserver.openapi.OpenAPIObject

Deprecated.

paths() - Method in class io.muserver.openapi.OpenAPIObject

pathsObject() - Static method in class io.muserver.openapi.PathsObjectBuilder

Creates a builder for a PathsObject

PathsObject - Class in io.muserver.openapi

PathsObjectBuilder - Class in io.muserver.openapi

Holds the relative paths to the individual endpoints and their operations.

PathsObjectBuilder() - Constructor for class io.muserver.openapi.PathsObjectBuilder

pattern - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.pattern() instead

pattern() - Method in class io.muserver.openapi.SchemaObject

pattern() - Method in class io.muserver.openapi.SchemaObjectBuilder

pattern() - Method in class io.muserver.rest.UriPattern

POST - io.muserver.Method

The POST HTTP method

PRAGMA - Static variable in class io.muserver.HeaderNames

"pragma"

prefix - Variable in class io.muserver.openapi.XmlObject

Deprecated.

use XmlObject.prefix() instead

prefix() - Method in class io.muserver.openapi.XmlObject

prefixMatches() - Method in class io.muserver.rest.PathMatch

PRIVATE - Static variable in class io.muserver.HeaderValues

"private"

properties - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.properties() instead

properties() - Method in class io.muserver.openapi.SchemaObject

properties() - Method in class io.muserver.openapi.SchemaObjectBuilder

propertyName - Variable in class io.muserver.openapi.DiscriminatorObject

Deprecated.

propertyName() - Method in class io.muserver.openapi.DiscriminatorObject

proto() - Method in class io.muserver.ForwardedHeader

protocol() - Method in interface io.muserver.HttpConnection

The HTTP protocol for the request.

protocol() - Method in interface io.muserver.MuRequest

The protocol for the request.

protocols() - Method in interface io.muserver.SSLInfo

providerName() - Method in interface io.muserver.SSLInfo

PROXY_AUTHENTICATE - Static variable in class io.muserver.HeaderNames

"proxy-authenticate"

PROXY_AUTHORIZATION - Static variable in class io.muserver.HeaderNames

"proxy-authorization"

PROXY_REVALIDATE - Static variable in class io.muserver.HeaderValues

"proxy-revalidate"

PUBLIC - Static variable in class io.muserver.HeaderValues

"public"

PUT - io.muserver.Method

The PUT HTTP method

Q

query() - Method in interface io.muserver.MuRequest

Gets the querystring parameters for this request.

QueryStringCommaExploderFilter - Class in io.muserver.rest

Deprecated.

This was temporarily used to work around a bug-fix in the JAX-RS implementation, however now RestHandlerBuilder.withCollectionParameterStrategy(CollectionParameterStrategy) should be used instead.

QueryStringCommaExploderFilter(List<String>) - Constructor for class io.muserver.rest.QueryStringCommaExploderFilter

Deprecated.

Creates a new filter to exploded comma-separated values in querystring parameters

QUOTED_PRINTABLE - Static variable in class io.muserver.HeaderValues

"quoted-printable"

R

RANGE - Static variable in class io.muserver.HeaderNames

"range"

rateLimit() - Static method in class io.muserver.RateLimitBuilder

Creates a new builder

RateLimit - Class in io.muserver

Specifies the limits allowed for a single value, such as an IP address.

RateLimitBuilder - Class in io.muserver

A builder to create RateLimit objects.

RateLimitBuilder() - Constructor for class io.muserver.RateLimitBuilder

RateLimiter - Interface in io.muserver

A rate limiter.

rateLimiters() - Method in interface io.muserver.MuServer

RateLimitRejectionAction - Enum in io.muserver

Specifies what to do when a rate limit is exceeded

RateLimitSelector - Interface in io.muserver

A function that controls how rate limits are applied.

readBodyAsString() - Method in interface io.muserver.MuRequest

Returns the request body as a string.

readOnly - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.readOnly() instead

readOnly() - Method in class io.muserver.openapi.SchemaObject

readOnly() - Method in class io.muserver.openapi.SchemaObjectBuilder

redirect(String) - Method in interface io.muserver.MuResponse

Redirects to the given URL.

redirect(URI) - Method in interface io.muserver.MuResponse

Redirects to the given URL.

REFERER - Static variable in class io.muserver.HeaderNames

"referer"

refreshUrl - Variable in class io.muserver.openapi.OAuthFlowObject

Deprecated.

use OAuthFlowObject.refreshUrl() instead

refreshUrl() - Method in class io.muserver.openapi.OAuthFlowObject

regexMatcher() - Method in class io.muserver.rest.PathMatch

rejectedDueToOverload() - Method in interface io.muserver.HttpConnection

rejectedDueToOverload() - Method in interface io.muserver.MuStats

relativePath() - Method in interface io.muserver.MuRequest

The path of this request (without query string) relative to the context.

remoteAddress() - Method in interface io.muserver.HttpConnection

remoteAddress() - Method in interface io.muserver.MuRequest

Gets the address that the request came from.

remoteAddress() - Method in interface io.muserver.MuWebSocketSession

remove(CharSequence) - Method in interface io.muserver.Headers

Removes a header.

remove(String) - Method in interface io.muserver.Headers

Removes a header.

request() - Method in class io.muserver.AsyncContext

Deprecated.

request() - Method in interface io.muserver.ResponseInfo

REQUEST_BODY - io.muserver.rest.SchemaObjectCustomizerTarget

The request body

requestBodies - Variable in class io.muserver.openapi.ComponentsObject

Deprecated.

requestBodies() - Method in class io.muserver.openapi.ComponentsObject

requestBody - Variable in class io.muserver.openapi.LinkObject

Deprecated.

use LinkObject.requestBody() instead

requestBody - Variable in class io.muserver.openapi.OperationObject

Deprecated.

use OperationObject.requestBody() instead

requestBody() - Method in class io.muserver.openapi.LinkObject

requestBody() - Method in class io.muserver.openapi.OperationObject

RequestBodyListener - Interface in io.muserver

Callbacks for reading request body data asynchronously.

requestBodyObject() - Static method in class io.muserver.openapi.RequestBodyObjectBuilder

Creates a builder for a RequestBodyObject

RequestBodyObject - Class in io.muserver.openapi

RequestBodyObjectBuilder - Class in io.muserver.openapi

Describes a single request body.

RequestBodyObjectBuilder() - Constructor for class io.muserver.openapi.RequestBodyObjectBuilder

requestIdleTimeoutMillis() - Method in interface io.muserver.MuServer

The maximum idle timeout for reading request bodies.

RequestParameters - Interface in io.muserver

Provides access to QueryString or Form values.

required - Variable in class io.muserver.openapi.ParameterObject

Deprecated.

required - Variable in class io.muserver.openapi.RequestBodyObject

Deprecated.

use RequestBodyObject.required() instead

required - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.required() instead

required() - Method in class io.muserver.openapi.HeaderObject

required() - Method in class io.muserver.openapi.ParameterObject

required() - Method in class io.muserver.openapi.RequestBodyObject

required() - Method in class io.muserver.openapi.SchemaObject

required() - Method in class io.muserver.openapi.SchemaObjectBuilder

Required - Annotation Type in io.muserver.rest

Specifies that a parameter in a rest method is required

requirements - Variable in class io.muserver.openapi.SecurityRequirementObject

Deprecated.

use SecurityRequirementObject.requirements() instead

requirements() - Method in class io.muserver.openapi.SecurityRequirementObject

resource() - Method in class io.muserver.rest.SchemaObjectCustomizerContext

For normal resources, this is the instance passed to the RestHandlerBuilder.

RESOURCE_INFO_PROPERTY - Static variable in class io.muserver.rest.MuRuntimeDelegate

The ContainerRequestContext or InterceptorContext property name to use to get the ResourceInfo for the current JAX-RS request, which can be used in a ContainerRequestFilter, ContainerResponseFilter, ReaderInterceptor or WriterInterceptor.

ResourceCustomizer - Interface in io.muserver.handlers

A hook to change responses for static resources.

ResourceHandler - Class in io.muserver.handlers

A handler to serve static content.

ResourceHandler.Builder - Class in io.muserver.handlers

Deprecated.

Use ResourceHandlerBuilder

ResourceHandlerBuilder - Class in io.muserver.handlers

Used to create a ResourceHandler for serving static files.

ResourceHandlerBuilder() - Constructor for class io.muserver.handlers.ResourceHandlerBuilder

ResourceType - Class in io.muserver.handlers

Used by the ResourceHandler to specify a mapping between file name extensions and mime types, and whether they should be gzipped or not.

ResourceType(CharSequence, Headers, boolean, List<String>) - Constructor for class io.muserver.handlers.ResourceType

Creates a new resource type.

response() - Method in class io.muserver.AsyncContext

Deprecated.

response() - Method in interface io.muserver.ResponseInfo

response() - Method in annotation type io.muserver.rest.ApiResponse

The type of the response body.

RESPONSE_BODY - io.muserver.rest.SchemaObjectCustomizerTarget

The response body

ResponseCompleteListener - Interface in io.muserver

A callback for listening to response completion events.

ResponseHeader - Annotation Type in io.muserver.rest

Describes an HTTP Header that is returned by a rest method.

responseHeaders() - Method in annotation type io.muserver.rest.ApiResponse

A list of possible headers provided alongside the response.

ResponseInfo - Interface in io.muserver

Information about a request and response.

responseObject() - Static method in class io.muserver.openapi.ResponseObjectBuilder

Creates a builder for a ResponseObject

ResponseObject - Class in io.muserver.openapi

ResponseObjectBuilder - Class in io.muserver.openapi

Describes a single response from an API Operation, including design-time, static links to operations based on the response.

ResponseObjectBuilder() - Constructor for class io.muserver.openapi.ResponseObjectBuilder

responses - Variable in class io.muserver.openapi.ComponentsObject

Deprecated.

responses - Variable in class io.muserver.openapi.OperationObject

Deprecated.

use OperationObject.responses() instead

responses() - Method in class io.muserver.openapi.ComponentsObject

responses() - Method in class io.muserver.openapi.OperationObject

responsesObject() - Static method in class io.muserver.openapi.ResponsesObjectBuilder

Creates a builder for a ResponsesObject

ResponsesObject - Class in io.muserver.openapi

ResponsesObjectBuilder - Class in io.muserver.openapi

A container for the expected responses of an operation.

ResponsesObjectBuilder() - Constructor for class io.muserver.openapi.ResponsesObjectBuilder

responseState() - Method in interface io.muserver.MuResponse

ResponseState - Enum in io.muserver

The state of a response

restHandler(Object...) - Static method in class io.muserver.rest.RestHandlerBuilder

Creates a handler builder for JAX-RS REST services.

RestHandler - Class in io.muserver.rest

A handler that serves JAX-RS resources.

RestHandlerBuilder - Class in io.muserver.rest

Used to create a RestHandler for handling JAX-RS REST resources.

RestHandlerBuilder(Object...) - Constructor for class io.muserver.rest.RestHandlerBuilder

Deprecated.

Use RestHandlerBuilder.restHandler(Object...) instead

RETRY_AFTER - Static variable in class io.muserver.HeaderNames

"retry-after"

route(Method, String, RouteHandler) - Static method in class io.muserver.Routes

Creates a new handler that will only be called if it matches the given route info.

RouteHandler - Interface in io.muserver

A handler for a Route created with MuServerBuilder.addHandler(Method, String, RouteHandler) or Routes.route(Method, String, RouteHandler)

Routes - Class in io.muserver

A helper class to create a handler for a specific URL.

S

S_MAXAGE - Static variable in class io.muserver.HeaderValues

"s-maxage"

sameSite() - Method in class io.muserver.Cookie

saveTo(File) - Method in interface io.muserver.UploadedFile

Saves the file to the specified destination.

schema - Variable in class io.muserver.openapi.MediaTypeObject

Deprecated.

use MediaTypeObject.schema() instead

schema - Variable in class io.muserver.openapi.ParameterObject

Deprecated.

schema() - Method in class io.muserver.openapi.HeaderObject

schema() - Method in class io.muserver.openapi.MediaTypeObject

schema() - Method in class io.muserver.openapi.ParameterObject

schemaObject() - Static method in class io.muserver.openapi.SchemaObjectBuilder

Creates a builder for a SchemaObject

SchemaObject - Class in io.muserver.openapi

SchemaObjectBuilder - Class in io.muserver.openapi

The Schema Object allows the definition of input and output data types.

SchemaObjectBuilder() - Constructor for class io.muserver.openapi.SchemaObjectBuilder

SchemaObjectCustomizer - Interface in io.muserver.rest

A class that can customize the SchemaObjects generated in OpenAPI documents for JAX-RS resources.

SchemaObjectCustomizerContext - Class in io.muserver.rest

Provides the context that a SchemaObject is in when customizing the schema in a SchemaObjectCustomizer

SchemaObjectCustomizerTarget - Enum in io.muserver.rest

The aspect of the API that a SchemaObject refers to

schemaObjectFrom(Class<?>) - Static method in class io.muserver.openapi.SchemaObjectBuilder

Creates a builder for a SchemaObject with the type and format based on the given class

schemaObjectFrom(Class<?>, Type, boolean) - Static method in class io.muserver.openapi.SchemaObjectBuilder

Creates a builder for a SchemaObject with the type and format based on the given class and generic type.

schemas - Variable in class io.muserver.openapi.ComponentsObject

Deprecated.

schemas() - Method in class io.muserver.openapi.ComponentsObject

scheme - Variable in class io.muserver.openapi.SecuritySchemeObject

Deprecated.

use SecuritySchemeObject.scheme() instead

scheme() - Method in class io.muserver.openapi.SecuritySchemeObject

scopes - Variable in class io.muserver.openapi.OAuthFlowObject

Deprecated.

use OAuthFlowObject.scopes() instead

scopes() - Method in class io.muserver.openapi.OAuthFlowObject

SEC_WEBSOCKET_ACCEPT - Static variable in class io.muserver.HeaderNames

"sec-websocket-accept"

SEC_WEBSOCKET_EXTENSIONS - Static variable in class io.muserver.HeaderNames

"sec-websocket-protocol"

SEC_WEBSOCKET_KEY - Static variable in class io.muserver.HeaderNames

"sec-websocket-key"

SEC_WEBSOCKET_KEY1 - Static variable in class io.muserver.HeaderNames

"sec-websocket-key1"

SEC_WEBSOCKET_KEY2 - Static variable in class io.muserver.HeaderNames

"sec-websocket-key2"

SEC_WEBSOCKET_LOCATION - Static variable in class io.muserver.HeaderNames

"sec-websocket-location"

SEC_WEBSOCKET_ORIGIN - Static variable in class io.muserver.HeaderNames

"sec-websocket-origin"

SEC_WEBSOCKET_PROTOCOL - Static variable in class io.muserver.HeaderNames

"sec-websocket-protocol"

SEC_WEBSOCKET_VERSION - Static variable in class io.muserver.HeaderNames

"sec-websocket-version"

secure(boolean) - Method in class io.muserver.CookieBuilder

Instructs clients on whether or not cookies can be sent over non-secure (HTTP) connections.

secureCookie(String, String) - Static method in class io.muserver.Cookie

Deprecated.

Please use CookieBuilder.newSecureCookie() instead

security - Variable in class io.muserver.openapi.OpenAPIObject

Deprecated.

security - Variable in class io.muserver.openapi.OperationObject

Deprecated.

use OperationObject.security() instead

security() - Method in class io.muserver.openapi.OpenAPIObject

security() - Method in class io.muserver.openapi.OperationObject

securityRequirementObject() - Static method in class io.muserver.openapi.SecurityRequirementObjectBuilder

Creates a builder for a SecurityRequirementObjectBuilder

SecurityRequirementObject - Class in io.muserver.openapi

SecurityRequirementObjectBuilder - Class in io.muserver.openapi

Lists the required security schemes to execute this operation.

SecurityRequirementObjectBuilder() - Constructor for class io.muserver.openapi.SecurityRequirementObjectBuilder

securitySchemeObject() - Static method in class io.muserver.openapi.SecuritySchemeObjectBuilder

Creates a builder for a SecuritySchemeObject

SecuritySchemeObject - Class in io.muserver.openapi

SecuritySchemeObjectBuilder - Class in io.muserver.openapi

Defines a security scheme that can be used by the operations.

SecuritySchemeObjectBuilder() - Constructor for class io.muserver.openapi.SecuritySchemeObjectBuilder

securitySchemes - Variable in class io.muserver.openapi.ComponentsObject

Deprecated.

securitySchemes() - Method in class io.muserver.openapi.ComponentsObject

segments() - Method in class io.muserver.rest.PathMatch

Returns a mapping of URI names to path segments.

select(MuRequest) - Method in interface io.muserver.RateLimitSelector

Selects a rate limit bucket based on the current request.

selectCiphers(Set<String>, List<String>) - Method in interface io.muserver.SSLCipherFilter

A method that returns the ciphers desired in the preferred order of use.

selector() - Method in interface io.muserver.RateLimiter

send(String) - Method in interface io.muserver.AsyncSsePublisher

Sends a message (without an ID or event type)

send(String) - Method in interface io.muserver.SsePublisher

Sends a message (without an ID or event type)

send(String, String) - Method in interface io.muserver.AsyncSsePublisher

Sends a message with an event type (without an ID).

send(String, String) - Method in interface io.muserver.SsePublisher

Sends a message with an event type (without an ID).

send(String, String, String) - Method in interface io.muserver.AsyncSsePublisher

Sends a message with an event type and ID.

send(String, String, String) - Method in interface io.muserver.SsePublisher

Sends a message with an event type and ID.

SEND_429 - io.muserver.RateLimitRejectionAction

An HTTP 429 response is sent to the client

sendBinary(ByteBuffer, boolean, DoneCallback) - Method in interface io.muserver.MuWebSocketSession

Sends a full or partial message to the client asynchronously with an optional parameter allowing partial fragments to be sent

sendBinary(ByteBuffer, DoneCallback) - Method in interface io.muserver.MuWebSocketSession

Sends a message to the client asynchronously

sendChunk(String) - Method in interface io.muserver.MuResponse

Immediately sends the given text to the client as a chunk.

sendComment(String) - Method in interface io.muserver.AsyncSsePublisher

Sends a comment to the client.

sendComment(String) - Method in interface io.muserver.SsePublisher

Sends a comment to the client.

sendPing(ByteBuffer, DoneCallback) - Method in interface io.muserver.MuWebSocketSession

Sends a ping message to the client, which is used for keeping sockets alive.

sendPong(ByteBuffer, DoneCallback) - Method in interface io.muserver.MuWebSocketSession

Sends a pong message to the client, generally in response to receiving a ping via MuWebSocket.onPing(ByteBuffer, DoneCallback)

sendText(String, boolean, DoneCallback) - Method in interface io.muserver.MuWebSocketSession

Sends a full or partial message to the client asynchronously with an optional parameter allowing partial fragments to be sent

sendText(String, DoneCallback) - Method in interface io.muserver.MuWebSocketSession

Sends a message to the client asynchronously

server - Variable in class io.muserver.openapi.LinkObject

Deprecated.

use LinkObject.server() instead

server() - Method in interface io.muserver.HttpConnection

server() - Method in interface io.muserver.MuRequest

server() - Method in class io.muserver.openapi.LinkObject

SERVER - Static variable in class io.muserver.HeaderNames

"server"

SERVER_CLOSED - io.muserver.WebsocketSessionState

The connection has ended due to a server-initiated shutdown

SERVER_CLOSING - io.muserver.WebsocketSessionState

The server has sent a close frame to the client, but the connection is not yet closed

serverObject() - Static method in class io.muserver.openapi.ServerObjectBuilder

Creates a builder for a ServerObject

ServerObject - Class in io.muserver.openapi

ServerObjectBuilder - Class in io.muserver.openapi

An object representing a Server.

ServerObjectBuilder() - Constructor for class io.muserver.openapi.ServerObjectBuilder

servers - Variable in class io.muserver.openapi.OpenAPIObject

Deprecated.

servers - Variable in class io.muserver.openapi.OperationObject

Deprecated.

use OperationObject.servers() instead

servers - Variable in class io.muserver.openapi.PathItemObject

Deprecated.

use PathItemObject.servers() instead

servers() - Method in class io.muserver.openapi.OpenAPIObject

servers() - Method in class io.muserver.openapi.OperationObject

servers() - Method in class io.muserver.openapi.PathItemObject

serverURI() - Method in interface io.muserver.MuRequest

The URI of the request for this server.

serverVariableObject() - Static method in class io.muserver.openapi.ServerVariableObjectBuilder

Creates a builder for a ServerVariableObjectBuilder

ServerVariableObject - Class in io.muserver.openapi

ServerVariableObjectBuilder - Class in io.muserver.openapi

An object representing a Server Variable for server URL template substitution.

ServerVariableObjectBuilder() - Constructor for class io.muserver.openapi.ServerVariableObjectBuilder

session() - Method in class io.muserver.BaseWebSocket

Gets the websocket session

set(Headers) - Method in interface io.muserver.Headers

Removes all the current headers and adds them from the given headers.

set(CharSequence, Iterable<?>) - Method in interface io.muserver.Headers

Sets a header value list.

set(CharSequence, Object) - Method in interface io.muserver.Headers

Sets a header value.

set(String, Iterable<?>) - Method in interface io.muserver.Headers

Sets a header value list.

set(String, Object) - Method in interface io.muserver.Headers

Sets a header value.

SET_COOKIE - Static variable in class io.muserver.HeaderNames

"set-cookie"

SET_COOKIE2 - Static variable in class io.muserver.HeaderNames

"set-cookie2"

setAll(Headers) - Method in interface io.muserver.Headers

Sets all the values from the given headers object, overwriting any existing headers with the same names.

setClientReconnectTime(long, TimeUnit) - Method in interface io.muserver.AsyncSsePublisher

Sends a message to the client instructing it to reconnect after the given time period in case of any disconnection (including calling AsyncSsePublisher.close() from the server).

setClientReconnectTime(long, TimeUnit) - Method in interface io.muserver.SsePublisher

Sends a message to the client instructing it to reconnect after the given time period in case of any disconnection (including calling SsePublisher.close() from the server).

setDomain(String) - Method in class io.muserver.Cookie

Deprecated.

Please create cookies with the CookieBuilder

setHttpOnly(boolean) - Method in class io.muserver.Cookie

Deprecated.

Please create cookies with the CookieBuilder

setInt(CharSequence, int) - Method in interface io.muserver.Headers

Sets the given integer value, replacing the existing value if it is already set.

setKeystoreBytes(InputStream, boolean) - Method in class io.muserver.SSLContextBuilder

Deprecated.

Sets the keystore to use

setMaxAge(long) - Method in class io.muserver.Cookie

Deprecated.

Please create cookies with the CookieBuilder

setPath(String) - Method in class io.muserver.Cookie

Deprecated.

Please create cookies with the CookieBuilder

setReadListener(RequestBodyListener) - Method in interface io.muserver.AsyncHandle

Sets a listener that will be notified when chunks of request data become available.

setResponseCompletedHandler(AsyncHandle.ResponseCompletedListener) - Method in interface io.muserver.AsyncHandle

Deprecated.

Use AsyncHandle.addResponseCompleteHandler(ResponseCompleteListener) instead

setResponseCompleteHandler(ResponseCompleteListener) - Method in interface io.muserver.AsyncHandle

Deprecated.

Use AsyncHandle.addResponseCompleteHandler(ResponseCompleteListener) instead

setResponseCompleteHandler(ResponseCompleteListener) - Method in interface io.muserver.AsyncSsePublisher

Add a listener for when request processing is complete.

setSecure(boolean) - Method in class io.muserver.Cookie

Deprecated.

Please create cookies with the CookieBuilder

setShort(CharSequence, short) - Method in interface io.muserver.Headers

Deprecated.

use Headers.setInt(CharSequence, int) instead

setValue(String) - Method in class io.muserver.Cookie

Deprecated.

Please create cookies with the CookieBuilder

shortCache() - Static method in class io.muserver.handlers.ResourceType

size() - Method in interface io.muserver.Headers

size() - Method in interface io.muserver.UploadedFile

Gets the size of the file.

SPLIT_ON_COMMA - io.muserver.rest.CollectionParameterStrategy

Splits parameter values on commas, for example a,b,c would result in a list of 3 strings.

SsePublisher - Interface in io.muserver

An interface for sending Server-Sent Events (SSE) to a client.

SSLCipherFilter - Interface in io.muserver

A filter allowing the selection of SSL certificates

sslContext() - Static method in class io.muserver.SSLContextBuilder

Deprecated.

SSLContextBuilder - Class in io.muserver

Deprecated.

Use HttpsConfigBuilder instead

SSLContextBuilder() - Constructor for class io.muserver.SSLContextBuilder

Deprecated.

sslInfo() - Method in interface io.muserver.MuServer

Gets the SSL info of the server, or null if SSL is not enabled.

SSLInfo - Interface in io.muserver

Information about the SSL settings being used by the server

start() - Method in class io.muserver.MuServerBuilder

Creates and starts this server.

start(MuRequest, MuResponse) - Static method in interface io.muserver.AsyncSsePublisher

Creates a new Server-Sent Events publisher.

start(MuRequest, MuResponse) - Static method in interface io.muserver.SsePublisher

Creates a new Server-Sent Events publisher.

startTime() - Method in interface io.muserver.HttpConnection

startTime() - Method in interface io.muserver.MuRequest

state - Variable in class io.muserver.AsyncContext

Deprecated.

Use MuRequest.attribute(String) instead.

state() - Method in class io.muserver.BaseWebSocket

state() - Method in interface io.muserver.MuRequest

Deprecated.

Use MuRequest.attribute(String) instead

state() - Method in interface io.muserver.MuWebSocketSession

state(Object) - Method in interface io.muserver.MuRequest

Deprecated.

Use MuRequest.attribute(String, Object) instead with a key name

stats() - Method in interface io.muserver.MuServer

status() - Method in interface io.muserver.MuResponse

status(int) - Method in interface io.muserver.MuResponse

Sets the response code for this request.

stop() - Method in interface io.muserver.MuServer

Shuts down the server

STREAMING - io.muserver.ResponseState

Response body has started streaming, but is not complete

STRICT_TRANSPORT_SECURITY - Static variable in class io.muserver.HeaderNames

"te"

style - Variable in class io.muserver.openapi.EncodingObject

Deprecated.

Use EncodingObject.style() instead

style - Variable in class io.muserver.openapi.ParameterObject

Deprecated.

style() - Method in class io.muserver.openapi.EncodingObject

style() - Method in class io.muserver.openapi.HeaderObject

style() - Method in class io.muserver.openapi.ParameterObject

summary - Variable in class io.muserver.openapi.ExampleObject

Deprecated.

use ExampleObject.summary() instead

summary - Variable in class io.muserver.openapi.OperationObject

Deprecated.

use OperationObject.summary() instead

summary - Variable in class io.muserver.openapi.PathItemObject

Deprecated.

use PathItemObject.summary() instead

summary() - Method in class io.muserver.openapi.ExampleObject

summary() - Method in class io.muserver.openapi.OperationObject

summary() - Method in class io.muserver.openapi.PathItemObject

T

tagObject() - Static method in class io.muserver.openapi.TagObjectBuilder

Creates a builder for a TagObjectBuilder

TagObject - Class in io.muserver.openapi

TagObjectBuilder - Class in io.muserver.openapi

Adds metadata to a single tag that is used by the OperationObject.

TagObjectBuilder() - Constructor for class io.muserver.openapi.TagObjectBuilder

tags - Variable in class io.muserver.openapi.OpenAPIObject

Deprecated.

tags - Variable in class io.muserver.openapi.OperationObject

Deprecated.

use OperationObject.tags() instead

tags() - Method in class io.muserver.openapi.OpenAPIObject

tags() - Method in class io.muserver.openapi.OperationObject

target() - Method in class io.muserver.rest.SchemaObjectCustomizerContext

TE - Static variable in class io.muserver.HeaderNames

"te"

termsOfService - Variable in class io.muserver.openapi.InfoObject

Deprecated.

use InfoObject.termsOfService() instead

termsOfService() - Method in class io.muserver.openapi.InfoObject

TEXT_CALENDAR - Static variable in class io.muserver.ContentTypes

iCalendar format: "text/calendar"

TEXT_CALENDAR - Static variable in class io.muserver.handlers.ResourceType

text/calendar;charset=utf-8

TEXT_CALENDAR_UTF8 - Static variable in class io.muserver.ContentTypes

iCalendar format: "text/calendar;charset=utf-8"

TEXT_CSS - Static variable in class io.muserver.ContentTypes

Cascading Style Sheets (CSS): "text/css"

TEXT_CSS - Static variable in class io.muserver.handlers.ResourceType

text/css

TEXT_CSS_UTF8 - Static variable in class io.muserver.ContentTypes

Cascading Style Sheets (CSS): "text/css;charset=utf-8"

TEXT_CSV - Static variable in class io.muserver.ContentTypes

Comma-separated values (CSV): "text/csv"

TEXT_CSV - Static variable in class io.muserver.handlers.ResourceType

text/csv;charset=utf-8

TEXT_CSV_UTF8 - Static variable in class io.muserver.ContentTypes

Comma-separated values (CSV): "text/csv;charset=utf-8"

TEXT_EVENT_STREAM - Static variable in class io.muserver.ContentTypes

Server-Sent-Events, a.k.a.

TEXT_HTML - Static variable in class io.muserver.ContentTypes

HyperText Markup Language (HTML): "text/html"

TEXT_HTML - Static variable in class io.muserver.handlers.ResourceType

text/html;charset=utf-8

TEXT_HTML_UTF8 - Static variable in class io.muserver.ContentTypes

HyperText Markup Language (HTML): "text/html;charset=utf-8"

TEXT_JAVASCRIPT - Static variable in class io.muserver.handlers.ResourceType

Deprecated.

use ResourceType.APPLICATION_JAVASCRIPT instead

TEXT_MARKDOWN - Static variable in class io.muserver.ContentTypes

Markdown: "text/markdown"

TEXT_MARKDOWN - Static variable in class io.muserver.handlers.ResourceType

text/markdown;charset=utf-8

TEXT_MARKDOWN_UTF8 - Static variable in class io.muserver.ContentTypes

Markdown: "text/markdown;charset=utf-8"

TEXT_PLAIN - Static variable in class io.muserver.ContentTypes

Plain text: "text/plain"

TEXT_PLAIN - Static variable in class io.muserver.handlers.ResourceType

text/plain;charset=utf-8

TEXT_PLAIN_UTF8 - Static variable in class io.muserver.ContentTypes

Plain text: "text/plain;charset=utf-8"

TheUnlicense() - Static method in class io.muserver.openapi.LicenseObjectBuilder

TIMED_OUT - io.muserver.ResponseState

The idle timeout (as specified in MuServerBuilder.withIdleTimeout(long, TimeUnit) occurred and so the response was cancelled early.

TIMED_OUT - io.muserver.WebsocketSessionState

The session was disconnected because no messages were received in the time period configured with WebSocketHandlerBuilder.withIdleReadTimeout(long, TimeUnit)

title - Variable in class io.muserver.openapi.InfoObject

Deprecated.

use InfoObject.title() instead

title - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.title() instead

title() - Method in class io.muserver.openapi.InfoObject

title() - Method in class io.muserver.openapi.SchemaObject

title() - Method in class io.muserver.openapi.SchemaObjectBuilder

toBuilder() - Method in class io.muserver.openapi.SchemaObject

toByteArray(InputStream, int) - Static method in class io.muserver.Mutils

Reads the given input stream into a byte array and closes the input stream

toByteBuffer(String) - Static method in class io.muserver.Mutils

Converts a string to a ByteBuffer with UTF-8 encoding.

Toggles - Class in io.muserver

Temporary features that might be removed without notice.

Toggles() - Constructor for class io.muserver.Toggles

toHandler(Method...) - Method in class io.muserver.rest.CORSConfigBuilder

Creates a CORS handler from this config.

toHttpDate(Date) - Static method in class io.muserver.Mutils

Converts a date into a date string as used in HTTP headers (defined in RFC 7321), for example Tue, 15 Nov 1994 08:12:31 GMT

toHttpsPort(int) - Static method in class io.muserver.handlers.HttpsRedirector

Deprecated.

Use HttpsRedirectorBuilder.toHttpsPort(int)

toHttpsPort(int) - Static method in class io.muserver.handlers.HttpsRedirectorBuilder

Creates a new redirect builder

tokenUrl - Variable in class io.muserver.openapi.OAuthFlowObject

Deprecated.

use OAuthFlowObject.tokenUrl() instead

tokenUrl() - Method in class io.muserver.openapi.OAuthFlowObject

toString() - Method in class io.muserver.ContextHandler

toString() - Method in class io.muserver.Cookie

toString() - Method in class io.muserver.ForwardedHeader

Converts the HeaderValue into a string, suitable for printing in an HTTP header.

toString() - Method in class io.muserver.handlers.CORSHandler

toString() - Method in class io.muserver.handlers.HttpsRedirector

toString() - Method in class io.muserver.handlers.ResourceHandler

toString() - Method in class io.muserver.handlers.ResourceType

toString() - Method in interface io.muserver.Headers

Returns a string representation of the headers.

toString() - Method in class io.muserver.Http2Config

toString() - Method in class io.muserver.MuServerBuilder

toString() - Method in class io.muserver.openapi.ParameterObject

toString() - Method in class io.muserver.openapi.SchemaObject

toString() - Method in class io.muserver.openapi.SchemaObjectBuilder

toString() - Method in class io.muserver.ParameterizedHeader

Converts the HeaderValue into a string, suitable for printing in an HTTP header.

toString() - Method in class io.muserver.ParameterizedHeaderWithValue

Converts the HeaderValue into a string, suitable for printing in an HTTP header.

toString() - Method in class io.muserver.rest.CORSConfig

toString() - Method in class io.muserver.rest.PathMatch

toString() - Method in class io.muserver.rest.SchemaObjectCustomizerContext

toString() - Method in class io.muserver.rest.UriPattern

toString() - Method in class io.muserver.WebSocketHandler

toString(Collection<String>) - Method in interface io.muserver.Headers

Returns a string representation of the headers with selected header values replaced with the string (hidden).

toString(List<ForwardedHeader>) - Static method in class io.muserver.ForwardedHeader

Converts a list of headers into a single string that can be put into a Forwarded header field.

toString(MediaType) - Static method in class io.muserver.MediaTypeParser

Converts a MediaType object into a string, suitable for printing in an HTTP header.

TRACE - io.muserver.Method

The TRACE HTTP method

TRAILER - Static variable in class io.muserver.HeaderNames

"trailer"

TRAILERS - Static variable in class io.muserver.HeaderValues

"trailers"

TRANSFER_ENCODING - Static variable in class io.muserver.HeaderNames

"transfer-encoding"

trim(String, String) - Static method in class io.muserver.Mutils

Trims the given string from the given value

type - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.type() instead

type - Variable in class io.muserver.openapi.SecuritySchemeObject

Deprecated.

use SecuritySchemeObject.type() instead

type() - Method in class io.muserver.openapi.SchemaObject

type() - Method in class io.muserver.openapi.SchemaObjectBuilder

type() - Method in class io.muserver.openapi.SecuritySchemeObject

type() - Method in class io.muserver.rest.SchemaObjectCustomizerContext

U

UnhandledExceptionHandler - Interface in io.muserver

A handler for exceptions that have been thrown by other handlers which allows for custom error pages.

uniqueItems - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.uniqueItems() instead

uniqueItems() - Method in class io.muserver.openapi.SchemaObject

uniqueItems() - Method in class io.muserver.openapi.SchemaObjectBuilder

unsignedLocalhost() - Static method in class io.muserver.HttpsConfigBuilder

Creates an SSL config builder that will serve HTTPS over a self-signed SSL cert for the localhost domain.

unsignedLocalhostCert() - Static method in class io.muserver.SSLContextBuilder

Deprecated.

Use HttpsConfigBuilder.unsignedLocalhost() instead

unsignedLocalhostCertBuilder() - Static method in class io.muserver.SSLContextBuilder

Deprecated.

Use HttpsConfigBuilder.unsignedLocalhost() instead

UPGRADE - Static variable in class io.muserver.HeaderNames

"upgrade"

UPGRADE - Static variable in class io.muserver.HeaderValues

"upgrade"

UPGRADED - io.muserver.ResponseState

Upgraded successfully to a websocket

uploadedFile(String) - Method in interface io.muserver.MuRequest

Gets the uploaded file with the given name, or null if there is no upload with that name.

UploadedFile - Interface in io.muserver

A file uploaded by the user, for example with an <input type="file" name="name"> input field in a multipart form.

uploadedFiles(String) - Method in interface io.muserver.MuRequest

Gets all the uploaded files with the given name, or an empty list if none are found.

uri() - Method in interface io.muserver.MuRequest

The URI of the request at the origin.

uri() - Method in interface io.muserver.MuServer

UriPattern - Class in io.muserver.rest

A pattern representing a URI template, such as /fruit or /fruit/{name} etc.

uriTemplateToRegex(String) - Static method in class io.muserver.rest.UriPattern

Converts a URI Template to a regular expression, following the JAX-RS: Java™ API for RESTful Web Services specification Version 2.0 section 3.7.3

url - Variable in class io.muserver.openapi.ContactObject

Deprecated.

url - Variable in class io.muserver.openapi.ExternalDocumentationObject

Deprecated.

use ExternalDocumentationObject.url() instead

url - Variable in class io.muserver.openapi.LicenseObject

Deprecated.

use LicenseObject.url() instead

url - Variable in class io.muserver.openapi.ServerObject

Deprecated.

use ServerObject.url() instead

url() - Method in class io.muserver.openapi.ContactObject

url() - Method in class io.muserver.openapi.ExternalDocumentationObject

url() - Method in class io.muserver.openapi.LicenseObject

url() - Method in class io.muserver.openapi.ServerObject

urlDecode(String) - Static method in class io.muserver.Mutils

urlEncode(String) - Static method in class io.muserver.Mutils

USER_AGENT - Static variable in class io.muserver.HeaderNames

"user-agent"

UserPassAuthenticator - Interface in io.muserver.rest

An authenticator used by BasicAuthSecurityFilter which can look up a user based on a username and password.

V

validTypes() - Static method in class io.muserver.openapi.SecuritySchemeObject

value - Variable in class io.muserver.openapi.ExampleObject

Deprecated.

use ExampleObject.value() instead

value() - Method in class io.muserver.Cookie

value() - Method in class io.muserver.openapi.ExampleObject

value() - Method in class io.muserver.ParameterizedHeaderWithValue

value() - Method in annotation type io.muserver.rest.ApiResponses

A list of ApiResponses provided by the API operation.

value() - Method in annotation type io.muserver.rest.Description

A short plaintext summary.

valueOf(String) - Static method in enum io.muserver.Method

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.muserver.RateLimitRejectionAction

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.muserver.ResponseState

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.muserver.rest.CollectionParameterStrategy

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.muserver.rest.SchemaObjectCustomizerTarget

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.muserver.WebsocketSessionState

Returns the enum constant of this type with the specified name.

values() - Static method in enum io.muserver.Method

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.muserver.RateLimitRejectionAction

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.muserver.ResponseState

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.muserver.rest.CollectionParameterStrategy

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.muserver.rest.SchemaObjectCustomizerTarget

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.muserver.WebsocketSessionState

Returns an array containing the constants of this enum type, in the order they are declared.

variables - Variable in class io.muserver.openapi.ServerObject

Deprecated.

use ServerObject.variables() instead

variables() - Method in class io.muserver.openapi.ServerObject

VARY - Static variable in class io.muserver.HeaderNames

"vary"

version - Variable in class io.muserver.openapi.InfoObject

Deprecated.

use InfoObject.version() instead

version() - Method in class io.muserver.openapi.InfoObject

VIA - Static variable in class io.muserver.HeaderNames

"via"

VIDEO_3GPP - Static variable in class io.muserver.ContentTypes

3GPP audio/video container: "video/3gpp"

VIDEO_3GPP - Static variable in class io.muserver.handlers.ResourceType

video/3gpp

VIDEO_3GPP2 - Static variable in class io.muserver.ContentTypes

3GPP2 audio/video container: "video/3gpp2"

VIDEO_3GPP2 - Static variable in class io.muserver.handlers.ResourceType

video/3gpp2

VIDEO_MP4 - Static variable in class io.muserver.ContentTypes

MPEG Video: "video/mp4"

VIDEO_MP4 - Static variable in class io.muserver.handlers.ResourceType

video/mp4

VIDEO_MPEG - Static variable in class io.muserver.ContentTypes

MPEG Video: "video/mpeg"

VIDEO_MPEG - Static variable in class io.muserver.handlers.ResourceType

video/mpeg

VIDEO_OGG - Static variable in class io.muserver.ContentTypes

OGG video: "video/ogg"

VIDEO_OGG - Static variable in class io.muserver.handlers.ResourceType

video/ogg

VIDEO_WEBM - Static variable in class io.muserver.ContentTypes

WEBM video: "video/webm"

VIDEO_WEBM - Static variable in class io.muserver.handlers.ResourceType

video/webm

VIDEO_X_MATROSKA - Static variable in class io.muserver.ContentTypes

MKV video files "video/x-matroska"

VIDEO_X_MATROSKA - Static variable in class io.muserver.handlers.ResourceType

video/x-matroska

VIDEO_X_MSVIDEO - Static variable in class io.muserver.ContentTypes

AVI: Audio Video Interleave: "video/x-msvideo"

VIDEO_X_MSVIDEO - Static variable in class io.muserver.handlers.ResourceType

video/x-msvideo

W

WARNING - Static variable in class io.muserver.HeaderNames

"warning"

WEB_APP_MANIFEST - Static variable in class io.muserver.ContentTypes

Web App Manifest files "application/manifest+json"

WEB_APP_MANIFEST - Static variable in class io.muserver.handlers.ResourceType

web/app-manifest

WEBSOCKET - Static variable in class io.muserver.HeaderValues

"websocket"

WEBSOCKET_LOCATION - Static variable in class io.muserver.HeaderNames

"websocket-location"

WEBSOCKET_ORIGIN - Static variable in class io.muserver.HeaderNames

"websocket-origin"

WEBSOCKET_PROTOCOL - Static variable in class io.muserver.HeaderNames

"websocket-protocol"

webSocketHandler() - Static method in class io.muserver.WebSocketHandlerBuilder

Creates a new handler builder.

webSocketHandler(MuWebSocketFactory) - Static method in class io.muserver.WebSocketHandlerBuilder

Creates a new handler builder with the given factory.

WebSocketHandler - Class in io.muserver

A handler that can establish a web socket based on web socket upgrade requests.

WebSocketHandlerBuilder - Class in io.muserver

Used to create handlers for web sockets.

WebSocketHandlerBuilder() - Constructor for class io.muserver.WebSocketHandlerBuilder

WebSocketProtocolException - Exception in io.muserver

Deprecated.

WebSocketProtocolException(String, Throwable) - Constructor for exception io.muserver.WebSocketProtocolException

Deprecated.

WebsocketSessionState - Enum in io.muserver

The state of a websocket session

withAdditionalProperties(Object) - Method in class io.muserver.openapi.SchemaObjectBuilder

Defines how properties not covered by SchemaObjectBuilder.withProperties(Map) are handled when the type is object

withAllOf(List<SchemaObject>) - Method in class io.muserver.openapi.SchemaObjectBuilder

withAllOriginsAllowed() - Method in class io.muserver.rest.CORSConfigBuilder

All origins will be allowed

withAllowCredentials(boolean) - Method in class io.muserver.rest.CORSConfigBuilder

If set to true, then access-control-allow-credentials is returned with true on CORS responses.

withAllowedHeaders(String...) - Method in class io.muserver.rest.CORSConfigBuilder

On preflight OPTIONS requests, specifies which headers are allowed to be sent on the request, aside from the "simple" headers.

withAllowedHeaders(Collection<String>) - Method in class io.muserver.rest.CORSConfigBuilder

On preflight OPTIONS requests, specifies which headers are allowed to be sent on the request, aside from the "simple" headers.

withAllowedMethods(Method...) - Method in class io.muserver.handlers.CORSHandlerBuilder

Specifies the headers allowed for CORS requests.

withAllowedOriginRegex(String) - Method in class io.muserver.rest.CORSConfigBuilder

The origin values that CORS requests are allowed for.

withAllowedOriginRegex(Pattern) - Method in class io.muserver.rest.CORSConfigBuilder

The origin values that CORS requests are allowed for.

withAllowedOrigins(String...) - Method in class io.muserver.rest.CORSConfigBuilder

The origin values that CORS requests are allowed for.

withAllowedOrigins(Collection<String>) - Method in class io.muserver.rest.CORSConfigBuilder

The origin values that CORS requests are allowed for, or null to allow all origins.

withAllowEmptyValue(boolean) - Method in class io.muserver.openapi.ParameterObjectBuilder

withAllowReserved(boolean) - Method in class io.muserver.openapi.EncodingObjectBuilder

withAllowReserved(boolean) - Method in class io.muserver.openapi.ParameterObjectBuilder

withAnyOf(List<SchemaObject>) - Method in class io.muserver.openapi.SchemaObjectBuilder

Forces a value to be any of a number of different schemas

withAttribute(boolean) - Method in class io.muserver.openapi.XmlObjectBuilder

withAuthorizationCode(OAuthFlowObject) - Method in class io.muserver.openapi.OAuthFlowsObjectBuilder

withAuthorizationUrl(URI) - Method in class io.muserver.openapi.OAuthFlowObjectBuilder

withBearerFormat(String) - Method in class io.muserver.openapi.SecuritySchemeObjectBuilder

withBucket(String) - Method in class io.muserver.RateLimitBuilder

Sets the bucket that the limit applies to.

withCallbacks(Map<String, CallbackObject>) - Method in class io.muserver.openapi.ComponentsObjectBuilder

withCallbacks(Map<String, CallbackObject>) - Method in class io.muserver.openapi.OperationObjectBuilder

withCallbacks(Map<String, PathItemObject>) - Method in class io.muserver.openapi.CallbackObjectBuilder

withCipherFilter(SSLCipherFilter) - Method in class io.muserver.HttpsConfigBuilder

Sets a filter allowing you to specify which ciphers you would like to support.

withCipherFilter(SSLCipherFilter) - Method in class io.muserver.SSLContextBuilder

Deprecated.

Sets a filter allowing you to specify which ciphers you would like to support.

withClientCredentials(OAuthFlowObject) - Method in class io.muserver.openapi.OAuthFlowsObjectBuilder

withCollectionParameterStrategy(CollectionParameterStrategy) - Method in class io.muserver.rest.RestHandlerBuilder

Specifies if values passed to method parameters with QueryParam or HeaderParam annotations should be transformed or not.

withComponents(ComponentsObject) - Method in class io.muserver.openapi.OpenAPIObjectBuilder

withContact(ContactObject) - Method in class io.muserver.openapi.InfoObjectBuilder

withContent(Map<String, MediaTypeObject>) - Method in class io.muserver.openapi.HeaderObjectBuilder

withContent(Map<String, MediaTypeObject>) - Method in class io.muserver.openapi.ParameterObjectBuilder

withContent(Map<String, MediaTypeObject>) - Method in class io.muserver.openapi.RequestBodyObjectBuilder

withContent(Map<String, MediaTypeObject>) - Method in class io.muserver.openapi.ResponseObjectBuilder

withContentType(String) - Method in class io.muserver.openapi.EncodingObjectBuilder

withCORS(CORSConfig) - Method in class io.muserver.rest.RestHandlerBuilder

Specifies the CORS config for the REST services.

withCORS(CORSConfigBuilder) - Method in class io.muserver.rest.RestHandlerBuilder

Specifies the CORS config for the REST services.

withCORSConfig(CORSConfig) - Method in class io.muserver.handlers.CORSHandlerBuilder

Sets the CORS configuration for the handler

withCORSConfig(CORSConfigBuilder) - Method in class io.muserver.handlers.CORSHandlerBuilder

Sets the CORS configuration for the handler

withDefaultAlias(String) - Method in class io.muserver.HttpsConfigBuilder

This option may be useful for cases where multiple certificates exist in a single keystore.

withDefaultAlias(String) - Method in class io.muserver.SSLContextBuilder

Deprecated.

This option may be useful for cases where multiple certificates exist in a single keystore.

withDefaultFile(String) - Method in class io.muserver.handlers.ResourceHandler.Builder

Deprecated.

Use ResourceHandlerBuilder

withDefaultFile(String) - Method in class io.muserver.handlers.ResourceHandlerBuilder

Specifies the file to use when a request such as /web/ is made.

withDefaultValue(ResponseObject) - Method in class io.muserver.openapi.ResponsesObjectBuilder

withDefaultValue(Object) - Method in class io.muserver.openapi.SchemaObjectBuilder

withDefaultValue(String) - Method in class io.muserver.openapi.ServerVariableObjectBuilder

withDeprecated(boolean) - Method in class io.muserver.openapi.ParameterObjectBuilder

withDeprecated(Boolean) - Method in class io.muserver.openapi.HeaderObjectBuilder

withDeprecated(Boolean) - Method in class io.muserver.openapi.OperationObjectBuilder

withDeprecated(Boolean) - Method in class io.muserver.openapi.SchemaObjectBuilder

withDescription(String) - Method in class io.muserver.openapi.ExampleObjectBuilder

withDescription(String) - Method in class io.muserver.openapi.ExternalDocumentationObjectBuilder

withDescription(String) - Method in class io.muserver.openapi.HeaderObjectBuilder

withDescription(String) - Method in class io.muserver.openapi.InfoObjectBuilder

withDescription(String) - Method in class io.muserver.openapi.LinkObjectBuilder

withDescription(String) - Method in class io.muserver.openapi.OperationObjectBuilder

withDescription(String) - Method in class io.muserver.openapi.ParameterObjectBuilder

withDescription(String) - Method in class io.muserver.openapi.PathItemObjectBuilder

withDescription(String) - Method in class io.muserver.openapi.RequestBodyObjectBuilder

withDescription(String) - Method in class io.muserver.openapi.ResponseObjectBuilder

withDescription(String) - Method in class io.muserver.openapi.SchemaObjectBuilder

withDescription(String) - Method in class io.muserver.openapi.SecuritySchemeObjectBuilder

withDescription(String) - Method in class io.muserver.openapi.ServerObjectBuilder

withDescription(String) - Method in class io.muserver.openapi.ServerVariableObjectBuilder

withDescription(String) - Method in class io.muserver.openapi.TagObjectBuilder

withDirectoryListing(boolean) - Method in class io.muserver.handlers.ResourceHandlerBuilder

Specifies whether or not to allow directory listing.

withDirectoryListingCSS(String) - Method in class io.muserver.handlers.ResourceHandlerBuilder

Specifies CSS to use for the HTML directory listing page, if directory listing is enabled.

withDirectoryListingDateFormatter(DateTimeFormatter) - Method in class io.muserver.handlers.ResourceHandlerBuilder

Specifies a custom date format for the "Last modified" column when directory listing is enabled.

withDiscriminator(DiscriminatorObject) - Method in class io.muserver.openapi.SchemaObjectBuilder

withDocumentation() - Method in class io.muserver.rest.RestHandlerBuilder

Deprecated.

This does nothing. To expose API endpoints, use RestHandlerBuilder.withOpenApiJsonUrl(String) and/or RestHandlerBuilder.withOpenApiHtmlUrl(String)

withDomain(String) - Method in class io.muserver.CookieBuilder

Sets the host that clients should send the cookie over.

withEmail(String) - Method in class io.muserver.openapi.ContactObjectBuilder

withEncoding(Map<String, EncodingObject>) - Method in class io.muserver.openapi.MediaTypeObjectBuilder

withEnumValue(List<Object>) - Method in class io.muserver.openapi.SchemaObjectBuilder

withEnumValues(List<String>) - Method in class io.muserver.openapi.ServerVariableObjectBuilder

withExample(Object) - Method in class io.muserver.openapi.HeaderObjectBuilder

withExample(Object) - Method in class io.muserver.openapi.MediaTypeObjectBuilder

withExample(Object) - Method in class io.muserver.openapi.ParameterObjectBuilder

withExample(Object) - Method in class io.muserver.openapi.SchemaObjectBuilder

withExamples(Map<String, ExampleObject>) - Method in class io.muserver.openapi.ComponentsObjectBuilder

withExamples(Map<String, ExampleObject>) - Method in class io.muserver.openapi.HeaderObjectBuilder

withExamples(Map<String, ExampleObject>) - Method in class io.muserver.openapi.MediaTypeObjectBuilder

withExamples(Map<String, ExampleObject>) - Method in class io.muserver.openapi.ParameterObjectBuilder

withExceptionHandler(UnhandledExceptionHandler) - Method in class io.muserver.MuServerBuilder

Sets the handler to use for exceptions thrown by other handlers, allowing for things such as custom error pages.

withExclusiveMaximum(Boolean) - Method in class io.muserver.openapi.SchemaObjectBuilder

withExclusiveMinimum(Boolean) - Method in class io.muserver.openapi.SchemaObjectBuilder

withExplode(boolean) - Method in class io.muserver.openapi.EncodingObjectBuilder

withExplode(Boolean) - Method in class io.muserver.openapi.ParameterObjectBuilder

withExplode(String) - Method in class io.muserver.openapi.HeaderObjectBuilder

withExposedHeaders(String...) - Method in class io.muserver.rest.CORSConfigBuilder

Specifies which headers (aside from "simple" headers) are allowed to be accessed by JavaScript in responses.

withExposedHeaders(Collection<String>) - Method in class io.muserver.rest.CORSConfigBuilder

Specifies which headers (aside from "simple" headers) are allowed to be accessed by JavaScript in responses.

withExtensionToResourceType(Map<String, ResourceType>) - Method in class io.muserver.handlers.ResourceHandler.Builder

Deprecated.

Use ResourceHandlerBuilder

withExtensionToResourceType(Map<String, ResourceType>) - Method in class io.muserver.handlers.ResourceHandlerBuilder

Specify custom filename extension to mime-type mappings.

withExternalDocs(ExternalDocumentationObject) - Method in class io.muserver.openapi.OpenAPIObjectBuilder

withExternalDocs(ExternalDocumentationObject) - Method in class io.muserver.openapi.OperationObjectBuilder

withExternalDocs(ExternalDocumentationObject) - Method in class io.muserver.openapi.SchemaObjectBuilder

withExternalDocs(ExternalDocumentationObject) - Method in class io.muserver.openapi.TagObjectBuilder

withExternalValue(URI) - Method in class io.muserver.openapi.ExampleObjectBuilder

withFlows(OAuthFlowsObject) - Method in class io.muserver.openapi.SecuritySchemeObjectBuilder

withFormat(String) - Method in class io.muserver.openapi.SchemaObjectBuilder

This is used to further specify the format of string types.

withGzip(long, Set<String>) - Method in class io.muserver.MuServerBuilder

Enables gzip for files of at least the specified size that match the given mime-types.

withGzipEnabled(boolean) - Method in class io.muserver.MuServerBuilder

Enables gzip for certain resource types.

withHandlerExecutor(ExecutorService) - Method in class io.muserver.MuServerBuilder

Sets the thread executor service to run requests on.

withHeaders(Map<String, HeaderObject>) - Method in class io.muserver.openapi.ComponentsObjectBuilder

withHeaders(Map<String, HeaderObject>) - Method in class io.muserver.openapi.EncodingObjectBuilder

withHeaders(Map<String, HeaderObject>) - Method in class io.muserver.openapi.ResponseObjectBuilder

withHSTSExpireTime(int, TimeUnit) - Method in class io.muserver.handlers.HttpsRedirectorBuilder

If set to a positive number, this will add a Strict-Transport-Security header to all HTTPS responses to indicate that clients should always use HTTPS to access this server.

withHSTSPreload(boolean) - Method in class io.muserver.handlers.HttpsRedirectorBuilder

Specifies that this website can be added to the HSTS preload lists.

withHttp2Config(Http2Config) - Method in class io.muserver.MuServerBuilder

Sets the configuration for HTTP2

withHttp2Config(Http2ConfigBuilder) - Method in class io.muserver.MuServerBuilder

Sets the configuration for HTTP2

withHttpConnection(int) - Method in class io.muserver.MuServerBuilder

Deprecated.

Use MuServerBuilder.withHttpPort(int) instead

withHttpDisabled() - Method in class io.muserver.MuServerBuilder

Deprecated.

It is off by default so this is not needed.

withHttpPort(int) - Method in class io.muserver.MuServerBuilder

withHttpsConfig(HttpsConfigBuilder) - Method in class io.muserver.MuServerBuilder

Sets the HTTPS config.

withHttpsConfig(SSLContextBuilder) - Method in class io.muserver.MuServerBuilder

Deprecated.

Use MuServerBuilder.withHttpsConfig(HttpsConfigBuilder) instead

withHttpsConfig(SSLContext) - Method in class io.muserver.MuServerBuilder

Deprecated.

This won't be supported in the future. Instead, use a HttpsConfigBuilder to set up HTTPS.

withHttpsConnection(int, SSLContext) - Method in class io.muserver.MuServerBuilder

Deprecated.

use MuServerBuilder.withHttpsPort(int) and MuServerBuilder.withHttpsConfig(SSLContext) instead.

withHttpsPort(int) - Method in class io.muserver.MuServerBuilder

Sets the HTTPS port to use.

withHttpStatusCodes(Map<String, ResponseObject>) - Method in class io.muserver.openapi.ResponsesObjectBuilder

withIdleReadTimeout(long, TimeUnit) - Method in class io.muserver.WebSocketHandlerBuilder

Sets the idle timeout.

withIdleTimeout(long, TimeUnit) - Method in class io.muserver.MuServerBuilder

Sets the idle timeout for connections.

withImplicit(OAuthFlowObject) - Method in class io.muserver.openapi.OAuthFlowsObjectBuilder

withIn(String) - Method in class io.muserver.openapi.ParameterObjectBuilder

withIn(String) - Method in class io.muserver.openapi.SecuritySchemeObjectBuilder

withInfo(InfoObject) - Method in class io.muserver.openapi.OpenAPIObjectBuilder

withInterface(String) - Method in class io.muserver.MuServerBuilder

Use this to specify which network interface to bind to.

withItems(SchemaObject) - Method in class io.muserver.openapi.SchemaObjectBuilder

withKeyManagerFactory(KeyManagerFactory) - Method in class io.muserver.HttpsConfigBuilder

Sets the key manager factory to use for SSL.

withKeyManagerFactory(KeyManagerFactory) - Method in class io.muserver.SSLContextBuilder

Deprecated.

Sets the key manager factory to use for SSL.

withKeyPassword(char[]) - Method in class io.muserver.HttpsConfigBuilder

The password to use to get the key from the keystore

withKeyPassword(char[]) - Method in class io.muserver.SSLContextBuilder

Deprecated.

The password to use to get the key from the keystore

withKeyPassword(String) - Method in class io.muserver.HttpsConfigBuilder

The password to use to get the key from the keystore

withKeyPassword(String) - Method in class io.muserver.SSLContextBuilder

Deprecated.

The password to use to get the key from the keystore

withKeystore(File) - Method in class io.muserver.HttpsConfigBuilder

Specifies the keystore to use

withKeystore(File) - Method in class io.muserver.SSLContextBuilder

Deprecated.

Specifies the keystore to use

withKeystore(InputStream) - Method in class io.muserver.HttpsConfigBuilder

Loads a keystore from the given stream.

withKeystore(InputStream) - Method in class io.muserver.SSLContextBuilder

Deprecated.

Loads a keystore from the given stream.

withKeystoreFromClasspath(String) - Method in class io.muserver.HttpsConfigBuilder

Loads a keystore from the classpath

withKeystoreFromClasspath(String) - Method in class io.muserver.SSLContextBuilder

Deprecated.

Loads a keystore from the classpath

withKeystorePassword(char[]) - Method in class io.muserver.HttpsConfigBuilder

The password to use to access the keystore

withKeystorePassword(char[]) - Method in class io.muserver.SSLContextBuilder

Deprecated.

The password to use to access the keystore

withKeystorePassword(String) - Method in class io.muserver.HttpsConfigBuilder

The password to use to access the keystore

withKeystorePassword(String) - Method in class io.muserver.SSLContextBuilder

Deprecated.

The password to use to access the keystore

withKeystoreType(String) - Method in class io.muserver.HttpsConfigBuilder

The type of keystore, such as JKS, JCEKS, PKCS12, etc

withKeystoreType(String) - Method in class io.muserver.SSLContextBuilder

Deprecated.

The type of keystore, such as JKS, JCEKS, PKCS12, etc

withLicense(LicenseObject) - Method in class io.muserver.openapi.InfoObjectBuilder

withLinks(Map<String, LinkObject>) - Method in class io.muserver.openapi.ComponentsObjectBuilder

withLinks(Map<String, LinkObject>) - Method in class io.muserver.openapi.ResponseObjectBuilder

withLocalhostAllowed() - Method in class io.muserver.rest.CORSConfigBuilder

Adds all localhost URLs (whether http or https) as allowed origins.

withMapping(Map<String, String>) - Method in class io.muserver.openapi.DiscriminatorObjectBuilder

withMaxAge(long) - Method in class io.muserver.rest.CORSConfigBuilder

On preflight OPTIONS requests, specifies the time the response is valid for

withMaxAgeInSeconds(long) - Method in class io.muserver.CookieBuilder

Specifies how long the cookie will last for.

withMaxFramePayloadLength(int) - Method in class io.muserver.WebSocketHandlerBuilder

Sets the maximum size in bytes that a frame can be.

withMaxHeadersSize(int) - Method in class io.muserver.MuServerBuilder

Specifies the maximum size in bytes of the HTTP request headers.

withMaximum(Double) - Method in class io.muserver.openapi.SchemaObjectBuilder

withMaxItems(Integer) - Method in class io.muserver.openapi.SchemaObjectBuilder

withMaxLength(Integer) - Method in class io.muserver.openapi.SchemaObjectBuilder

withMaxProperties(Integer) - Method in class io.muserver.openapi.SchemaObjectBuilder

withMaxRequestSize(long) - Method in class io.muserver.MuServerBuilder

The maximum allowed request body size.

withMaxUrlSize(int) - Method in class io.muserver.MuServerBuilder

The maximum length that a URL can be.

withMinimum(Double) - Method in class io.muserver.openapi.SchemaObjectBuilder

withMinItems(Integer) - Method in class io.muserver.openapi.SchemaObjectBuilder

withMinLength(Integer) - Method in class io.muserver.openapi.SchemaObjectBuilder

withMinProperties(Integer) - Method in class io.muserver.openapi.SchemaObjectBuilder

withMultipleOf(Double) - Method in class io.muserver.openapi.SchemaObjectBuilder

Restricts numeric values to be a multiple of the given value

withName(String) - Method in class io.muserver.CookieBuilder

Sets the name of the cookie.

withName(String) - Method in class io.muserver.openapi.ContactObjectBuilder

withName(String) - Method in class io.muserver.openapi.LicenseObjectBuilder

withName(String) - Method in class io.muserver.openapi.ParameterObjectBuilder

withName(String) - Method in class io.muserver.openapi.SecuritySchemeObjectBuilder

withName(String) - Method in class io.muserver.openapi.TagObjectBuilder

withName(String) - Method in class io.muserver.openapi.XmlObjectBuilder

withNamespace(URI) - Method in class io.muserver.openapi.XmlObjectBuilder

withNioThreads(int) - Method in class io.muserver.MuServerBuilder

The number of nio threads to handle requests.

withNot(List<SchemaObject>) - Method in class io.muserver.openapi.SchemaObjectBuilder

withNullable(Boolean) - Method in class io.muserver.openapi.SchemaObjectBuilder

withOneOf(List<SchemaObject>) - Method in class io.muserver.openapi.SchemaObjectBuilder

Forces a value to be one of several different schemas

withOpenApiDocument(OpenAPIObjectBuilder) - Method in class io.muserver.rest.RestHandlerBuilder

Use this value to create JSON and HTML documentation for your rest service.

withOpenApiHtmlCss(String) - Method in class io.muserver.rest.RestHandlerBuilder

When using the HTML endpoint made available by calling RestHandlerBuilder.withOpenApiDocument(OpenAPIObjectBuilder) this allows you to override the default CSS that is used.

withOpenApiHtmlUrl(String) - Method in class io.muserver.rest.RestHandlerBuilder

Enables a simple HTML endpoint that documents the API exposed by the rest resources declared by this builder.

withOpenApiJsonUrl(String) - Method in class io.muserver.rest.RestHandlerBuilder

Enables an Open API JSON URL at the specified endpoint.

withOpenIdConnectUrl(URI) - Method in class io.muserver.openapi.SecuritySchemeObjectBuilder

withOperationId(String) - Method in class io.muserver.openapi.LinkObjectBuilder

withOperationId(String) - Method in class io.muserver.openapi.OperationObjectBuilder

withOperations(Map<String, OperationObject>) - Method in class io.muserver.openapi.PathItemObjectBuilder

withParameters(List<ParameterObject>) - Method in class io.muserver.openapi.OperationObjectBuilder

withParameters(List<ParameterObject>) - Method in class io.muserver.openapi.PathItemObjectBuilder

withParameters(Map<String, ParameterObject>) - Method in class io.muserver.openapi.ComponentsObjectBuilder

withParameters(Map<String, Object>) - Method in class io.muserver.openapi.LinkObjectBuilder

withPassword(OAuthFlowObject) - Method in class io.muserver.openapi.OAuthFlowsObjectBuilder

withPath(String) - Method in class io.muserver.ContextHandlerBuilder

Sets the path to serve from.

withPath(String) - Method in class io.muserver.CookieBuilder

Sets the path prefix that the cookie will be sent with, or null to send to all paths.

withPath(String) - Method in class io.muserver.WebSocketHandlerBuilder

Sets the path to listen on for this handler.

withPathItemObjects(Map<String, PathItemObject>) - Method in class io.muserver.openapi.PathsObjectBuilder

withPaths(PathsObject) - Method in class io.muserver.openapi.OpenAPIObjectBuilder

withPathToServeFrom(String) - Method in class io.muserver.handlers.ResourceHandler.Builder

Deprecated.

Use ResourceHandlerBuilder

withPathToServeFrom(String) - Method in class io.muserver.handlers.ResourceHandlerBuilder

Deprecated.

Please use ContextHandlerBuilder.context(pathToServeFrom).addHandler(resourceHandler) instead.

withPattern(Pattern) - Method in class io.muserver.openapi.SchemaObjectBuilder

withPingSentAfterNoWritesFor(int, TimeUnit) - Method in class io.muserver.WebSocketHandlerBuilder

Sets the amount of time to wait before sending a ping message if no messages having been sent.

withPort(int) - Method in class io.muserver.handlers.HttpsRedirectorBuilder

Sets the port to redirect HTTP requests to, for example 443

withPrefix(String) - Method in class io.muserver.openapi.XmlObjectBuilder

withProperties(Map<String, SchemaObject>) - Method in class io.muserver.openapi.SchemaObjectBuilder

withPropertyName(String) - Method in class io.muserver.openapi.DiscriminatorObjectBuilder

withProtocols(String...) - Method in class io.muserver.HttpsConfigBuilder

Sets the SSL/TLS protocols to use, for example "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2", "TLSv1.3".

withProtocols(String...) - Method in class io.muserver.SSLContextBuilder

Deprecated.

Sets the SSL/TLS protocols to use, for example "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2", "TLSv1.3".

withRate(long) - Method in class io.muserver.RateLimitBuilder

Sets the allowed rate.

withRateLimiter(RateLimitSelector) - Method in class io.muserver.MuServerBuilder

Adds a rate limiter to incoming requests.

withReadOnly(Boolean) - Method in class io.muserver.openapi.SchemaObjectBuilder

withRefreshUrl(URI) - Method in class io.muserver.openapi.OAuthFlowObjectBuilder

withRejectionAction(RateLimitRejectionAction) - Method in class io.muserver.RateLimitBuilder

Specifies what to do when this limit is breached.

withRequestBodies(Map<String, RequestBodyObject>) - Method in class io.muserver.openapi.ComponentsObjectBuilder

withRequestBody(RequestBodyObject) - Method in class io.muserver.openapi.OperationObjectBuilder

withRequestBody(Object) - Method in class io.muserver.openapi.LinkObjectBuilder

withRequestTimeout(long, TimeUnit) - Method in class io.muserver.MuServerBuilder

Sets the idle timeout for reading request bodies.

withRequired(boolean) - Method in class io.muserver.openapi.HeaderObjectBuilder

withRequired(boolean) - Method in class io.muserver.openapi.RequestBodyObjectBuilder

withRequired(Boolean) - Method in class io.muserver.openapi.ParameterObjectBuilder

withRequired(List<String>) - Method in class io.muserver.openapi.SchemaObjectBuilder

withRequirements(Map<String, List<String>>) - Method in class io.muserver.openapi.SecurityRequirementObjectBuilder

withResourceCustomizer(ResourceCustomizer) - Method in class io.muserver.handlers.ResourceHandlerBuilder

Registers a hook to intercept responses, allowing things such as response header customization based on the request.

withResponses(ResponsesObject) - Method in class io.muserver.openapi.OperationObjectBuilder

withResponses(Map<String, ResponseObject>) - Method in class io.muserver.openapi.ComponentsObjectBuilder

withSameSite(String) - Method in class io.muserver.CookieBuilder

Sets the SameSite property of the cookie.

withSchema(SchemaObject) - Method in class io.muserver.openapi.HeaderObjectBuilder

withSchema(SchemaObject) - Method in class io.muserver.openapi.MediaTypeObjectBuilder

withSchema(SchemaObject) - Method in class io.muserver.openapi.ParameterObjectBuilder

withSchemas(Map<String, SchemaObject>) - Method in class io.muserver.openapi.ComponentsObjectBuilder

withScheme(String) - Method in class io.muserver.openapi.SecuritySchemeObjectBuilder

withScopes(Map<String, String>) - Method in class io.muserver.openapi.OAuthFlowObjectBuilder

withSecurity(List<SecurityRequirementObject>) - Method in class io.muserver.openapi.OpenAPIObjectBuilder

withSecurity(List<SecurityRequirementObject>) - Method in class io.muserver.openapi.OperationObjectBuilder

withSecuritySchemes(Map<String, SecuritySchemeObject>) - Method in class io.muserver.openapi.ComponentsObjectBuilder

withServer(ServerObject) - Method in class io.muserver.openapi.LinkObjectBuilder

withServers(List<ServerObject>) - Method in class io.muserver.openapi.OpenAPIObjectBuilder

withServers(List<ServerObject>) - Method in class io.muserver.openapi.OperationObjectBuilder

withServers(List<ServerObject>) - Method in class io.muserver.openapi.PathItemObjectBuilder

withStyle(String) - Method in class io.muserver.openapi.EncodingObjectBuilder

withStyle(String) - Method in class io.muserver.openapi.HeaderObjectBuilder

withStyle(String) - Method in class io.muserver.openapi.ParameterObjectBuilder

withSummary(String) - Method in class io.muserver.openapi.ExampleObjectBuilder

withSummary(String) - Method in class io.muserver.openapi.OperationObjectBuilder

withSummary(String) - Method in class io.muserver.openapi.PathItemObjectBuilder

withTags(List<TagObject>) - Method in class io.muserver.openapi.OpenAPIObjectBuilder

withTags(List<String>) - Method in class io.muserver.openapi.OperationObjectBuilder

withTermsOfService(URI) - Method in class io.muserver.openapi.InfoObjectBuilder

withTitle(String) - Method in class io.muserver.openapi.InfoObjectBuilder

withTitle(String) - Method in class io.muserver.openapi.SchemaObjectBuilder

withTokenUrl(URI) - Method in class io.muserver.openapi.OAuthFlowObjectBuilder

withType(String) - Method in class io.muserver.openapi.SchemaObjectBuilder

withType(String) - Method in class io.muserver.openapi.SecuritySchemeObjectBuilder

withUniqueItems(Boolean) - Method in class io.muserver.openapi.SchemaObjectBuilder

withUrl(String) - Method in class io.muserver.openapi.ServerObjectBuilder

withUrl(URI) - Method in class io.muserver.openapi.ContactObjectBuilder

withUrl(URI) - Method in class io.muserver.openapi.ExternalDocumentationObjectBuilder

withUrl(URI) - Method in class io.muserver.openapi.LicenseObjectBuilder

withUrlEncodedValue(String) - Method in class io.muserver.CookieBuilder

Sets the value of the cookie by URL Encoding the given value.

withValue(Object) - Method in class io.muserver.openapi.ExampleObjectBuilder

withValue(String) - Method in class io.muserver.CookieBuilder

Sets the value of the cookie.

withVariables(Map<String, ServerVariableObject>) - Method in class io.muserver.openapi.ServerObjectBuilder

withVersion(String) - Method in class io.muserver.openapi.InfoObjectBuilder

withWebSocketFactory(MuWebSocketFactory) - Method in class io.muserver.WebSocketHandlerBuilder

Sets the factory that decides whether to create a websocket connection for a request.

withWindow(long, TimeUnit) - Method in class io.muserver.RateLimitBuilder

The period that the limit applies to.

withWrapped(boolean) - Method in class io.muserver.openapi.XmlObjectBuilder

withWriteOnly(Boolean) - Method in class io.muserver.openapi.SchemaObjectBuilder

withXml(XmlObject) - Method in class io.muserver.openapi.SchemaObjectBuilder

wrapped - Variable in class io.muserver.openapi.XmlObject

Deprecated.

use XmlObject.wrapped() instead

wrapped() - Method in class io.muserver.openapi.XmlObject

write(String) - Method in interface io.muserver.MuResponse

Writes the given text as the response body for this request.

write(ByteBuffer) - Method in interface io.muserver.AsyncHandle

Writes data to the response asynchronously.

write(ByteBuffer, DoneCallback) - Method in interface io.muserver.AsyncHandle

Writes data to the response asynchronously.

write(ByteBuffer, WriteCallback) - Method in interface io.muserver.AsyncHandle

Deprecated.

Use AsyncHandle.write(ByteBuffer, DoneCallback) instead

writeAsync(String) - Method in interface io.muserver.MuResponse

Deprecated.

For async handling, call MuRequest.handleAsync()

WriteCallback - Interface in io.muserver

Deprecated.

This is being replaced with DoneCallback

writeHeaders(MuRequest, MuResponse, Set<Method>) - Method in class io.muserver.rest.CORSConfig

Adds CORS headers to the response, if needed.

writeJson(Writer) - Method in class io.muserver.openapi.CallbackObject

writeJson(Writer) - Method in class io.muserver.openapi.ComponentsObject

writeJson(Writer) - Method in class io.muserver.openapi.ContactObject

writeJson(Writer) - Method in class io.muserver.openapi.DiscriminatorObject

writeJson(Writer) - Method in class io.muserver.openapi.EncodingObject

writeJson(Writer) - Method in class io.muserver.openapi.ExampleObject

writeJson(Writer) - Method in class io.muserver.openapi.ExternalDocumentationObject

writeJson(Writer) - Method in class io.muserver.openapi.HeaderObject

writeJson(Writer) - Method in class io.muserver.openapi.InfoObject

writeJson(Writer) - Method in class io.muserver.openapi.LicenseObject

writeJson(Writer) - Method in class io.muserver.openapi.LinkObject

writeJson(Writer) - Method in class io.muserver.openapi.MediaTypeObject

writeJson(Writer) - Method in class io.muserver.openapi.OAuthFlowObject

writeJson(Writer) - Method in class io.muserver.openapi.OAuthFlowsObject

writeJson(Writer) - Method in class io.muserver.openapi.OpenAPIObject

writeJson(Writer) - Method in class io.muserver.openapi.OperationObject

writeJson(Writer) - Method in class io.muserver.openapi.ParameterObject

writeJson(Writer) - Method in class io.muserver.openapi.PathItemObject

writeJson(Writer) - Method in class io.muserver.openapi.PathsObject

writeJson(Writer) - Method in class io.muserver.openapi.RequestBodyObject

writeJson(Writer) - Method in class io.muserver.openapi.ResponseObject

writeJson(Writer) - Method in class io.muserver.openapi.ResponsesObject

writeJson(Writer) - Method in class io.muserver.openapi.SchemaObject

writeJson(Writer) - Method in class io.muserver.openapi.SecurityRequirementObject

writeJson(Writer) - Method in class io.muserver.openapi.SecuritySchemeObject

writeJson(Writer) - Method in class io.muserver.openapi.ServerObject

writeJson(Writer) - Method in class io.muserver.openapi.ServerVariableObject

writeJson(Writer) - Method in class io.muserver.openapi.TagObject

writeJson(Writer) - Method in class io.muserver.openapi.XmlObject

writeOnly - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.writeOnly() instead

writeOnly() - Method in class io.muserver.openapi.SchemaObject

writeOnly() - Method in class io.muserver.openapi.SchemaObjectBuilder

writer() - Method in interface io.muserver.MuResponse

A print writer that can be used to send text to the client.

writeResponseHeaders(URI, Response, MuResponse) - Static method in class io.muserver.rest.MuRuntimeDelegate

Writes headers from a JAX-RS response to a MuResponse

WWW_AUTHENTICATE - Static variable in class io.muserver.HeaderNames

"www-authenticate"

X

X_CONTENT_TYPE_OPTIONS - Static variable in class io.muserver.HeaderNames

"content-type"

X_DEFLATE - Static variable in class io.muserver.HeaderValues

"x-deflate"

X_FORWARDED_FOR - Static variable in class io.muserver.HeaderNames

"x-forwarded-for"

X_FORWARDED_HOST - Static variable in class io.muserver.HeaderNames

"x-forwarded-host"

X_FORWARDED_PORT - Static variable in class io.muserver.HeaderNames

"x-forwarded-port"

X_FORWARDED_PROTO - Static variable in class io.muserver.HeaderNames

"x-forwarded-proto"

X_FRAME_OPTIONS - Static variable in class io.muserver.HeaderNames

"x-frame-options"

X_GZIP - Static variable in class io.muserver.HeaderValues

"x-gzip"

xml - Variable in class io.muserver.openapi.SchemaObject

Deprecated.

use SchemaObject.xml() instead

xml() - Method in class io.muserver.openapi.SchemaObject

xml() - Method in class io.muserver.openapi.SchemaObjectBuilder

xmlObject() - Static method in class io.muserver.openapi.XmlObjectBuilder

Creates a builder for a XmlObject

XmlObject - Class in io.muserver.openapi

XmlObjectBuilder - Class in io.muserver.openapi

A metadata object that allows for more fine-tuned XML model definitions.

XmlObjectBuilder() - Constructor for class io.muserver.openapi.XmlObjectBuilder

Z

ZERO - Static variable in class io.muserver.HeaderValues

"0"

A B C D E F G H I J K L M N O P Q R S T U V W X Z
All Classes All Packages