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

A

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"

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.MuStats

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

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

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

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

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

add(Headers) - Method in class io.muserver.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.

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(MuHandlerBuilder) - Method in class io.muserver.ContextHandlerBuilder

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

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

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

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(MuHandlerBuilder) - Method in class io.muserver.MuServerBuilder

Adds a request handler.

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

Adds a request handler.

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

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

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

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

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

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

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

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

ALLOW - Static variable in class io.muserver.HeaderNames

"allow"

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

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

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

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

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

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

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

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_GZIP - Static variable in class io.muserver.ContentTypes

GZIP (.gz): "application/gzip"

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

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_JAVASCRIPT - Static variable in class io.muserver.ContentTypes

JavaScript (ECMAScript): "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_MSWORD - Static variable in class io.muserver.ContentTypes

Microsoft Word: "application/msword"

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

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_OGG - Static variable in class io.muserver.ContentTypes

OGG: "application/ogg"

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

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_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_TYPESCRIPT - Static variable in class io.muserver.ContentTypes

Typescript file: "application/typescript"

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

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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_XML - Static variable in class io.muserver.ContentTypes

XML: "application/xml"

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

APPLICATION_ZIP - Static variable in class io.muserver.ContentTypes

ZIP archive: "application/zip"

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

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.

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

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

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_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_OGG - Static variable in class io.muserver.ContentTypes

OGG audio: "audio/ogg"

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

AUDIO_WEBM - Static variable in class io.muserver.ContentTypes

WEBM audio: "audio/webm"

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

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

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

authorizationUrl - Variable 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"

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

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.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 interface io.muserver.MuHandlerBuilder

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

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.rest.CORSConfigBuilder

Builds CORS configuration from a builder

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

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

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

Deprecated.

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

Deprecated.

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"

CallbackObject - Class in io.muserver.openapi

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

Creates a builder for a CallbackObject

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

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

CHARSET - Static variable in class io.muserver.HeaderValues

"charset"

CHUNKED - Static variable in class io.muserver.HeaderValues

"chunked"

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 class io.muserver.Headers

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

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

Stops the event stream.

CLOSE - Static variable in class io.muserver.HeaderValues

"close"

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

Stops the event stream.

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)

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

Deprecated.

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

Call this to indicate that the response is complete.

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

Calling this will mark the request as complete and log the error message.

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

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

ComponentsObject - Class in io.muserver.openapi

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

Creates a builder for a ComponentsObject

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"

CONNECTION - Static variable in class io.muserver.HeaderNames

"connection"

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

ContactObject - Class in io.muserver.openapi

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

Creates a builder for a ContactObject

ContactObjectBuilder - Class in io.muserver.openapi

Contact information for the exposed API.

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

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

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

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

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

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

Returns true if the given parameter is specified with any value

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

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

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

content - Variable 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() - 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(CharSequence) - Method in interface io.muserver.MuResponse

Sets the Content-Type response header.

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

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

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

ContentTypes - Class in io.muserver

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

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

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 - Class in io.muserver

A cookie

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

COOKIE - Static variable in class io.muserver.HeaderNames

"cookie"

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

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

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 - Class in io.muserver.rest

CORS configuration for REST resources.

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

Creates a builder to set CORS configuration.

CORSConfigBuilder - Class in io.muserver.rest

A builder to set configuration for CORS requests.

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

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

D

DATE - Static variable in class io.muserver.HeaderNames

"date"

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

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

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

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

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

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

DEFLATE - Static variable in class io.muserver.HeaderValues

"deflate"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Description - Annotation Type in io.muserver.rest

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

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

Creates CORS configuration that disables all CORS requests.

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

DiscriminatorObject - Class in io.muserver.openapi

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

Creates a builder for a DiscriminatorObject

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

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

E

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

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

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

EncodingObject - Class in io.muserver.openapi

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

Creates a builder for an EncodingObject

EncodingObjectBuilder - Class in io.muserver.openapi

A single encoding definition applied to a single schema property.

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

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

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

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

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

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

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

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

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

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

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

ETAG - Static variable in class io.muserver.HeaderNames

"etag"

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

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

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

ExampleObject - Class in io.muserver.openapi

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

Creates a builder for an ExampleObject

ExampleObjectBuilder - Class in io.muserver.openapi

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

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

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

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

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

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

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

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

exposedHeaders - Variable 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

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

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

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

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

ExternalDocumentationObject - Class in io.muserver.openapi

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

Creates a builder for an ExternalDocumentationObject

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

F

FILE - Static variable in class io.muserver.HeaderValues

"file" See HeaderNames.CONTENT_DISPOSITION

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

Deprecated.

Use ResourceHandlerBuilder.fileHandler(String)

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

Deprecated.

Use ResourceHandlerBuilder.fileHandler(File)

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

Deprecated.

Use ResourceHandlerBuilder.fileHandler(Path)

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

Creates a handler that serves files from the given directory.

fileHandler(File) - 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.ResourceHandlerBuilder

Creates a handler that serves files from the given directory.

FILENAME - Static variable in class io.muserver.HeaderValues

"filename" See HeaderNames.CONTENT_DISPOSITION

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

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

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

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

FONT_OTF - Static variable in class io.muserver.ContentTypes

OpenType font: "font/otf"

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

FONT_TTF - Static variable in class io.muserver.ContentTypes

TrueType Font: "font/ttf"

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

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_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

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

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

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

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.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.

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(String) - Method in class io.muserver.Headers

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

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

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

Gets the value with the given name, or empty string 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.

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

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

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

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

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

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

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.

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.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 class io.muserver.Headers

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

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.RequestParameters

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

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

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

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

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

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

gzip - Variable 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"

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

H

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

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, Map<String, String>) - Method in interface io.muserver.RouteHandler

A handler for a Route created with MuServerBuilder.addHandler(Method, String, RouteHandler) or Routes.route(Method, String, RouteHandler)

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

Specifies that you want to handle this response asynchronously.

hasBody() - Method in class 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.Headers

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

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

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.

HeaderNames - Class in io.muserver

Standard HTTP header names.

HeaderObject - Class in io.muserver.openapi

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

Creates a builder for a HeaderObject

HeaderObjectBuilder - Class in io.muserver.openapi

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

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

Headers - Class in io.muserver

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

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 - Variable in class io.muserver.openapi.ComponentsObject

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

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

HeaderValues - Class in io.muserver

Standard HTTP header values.

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;

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

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

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

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

HttpToHttpsRedirector - Class in io.muserver.handlers

Deprecated.

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

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

Deprecated.

Creates a HTTPS redirector

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"

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_JPEG - Static variable in class io.muserver.ContentTypes

JPEG images: "image/jpeg"

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

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_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_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_WEBP - Static variable in class io.muserver.ContentTypes

WEBP image: "image/webp"

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

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

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

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

in - Variable 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

InfoObject - Class in io.muserver.openapi

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

Creates a builder for a InfoObject

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.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

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

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

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

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

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

iteratorCharSequence() - Method in class io.muserver.Headers

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

LicenseObject - Class in io.muserver.openapi

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

Creates a builder for a LicenseObject

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 - Class in io.muserver.openapi

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

Creates a builder for a LinkObject

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

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

LOCATION - Static variable in class io.muserver.HeaderNames

"location"

M

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

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

Matches the given URI against this pattern.

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

Matches the given raw path 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() - Method in class io.muserver.Cookie

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

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

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

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

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

MediaTypeObject - Class in io.muserver.openapi

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

Creates a builder for a MediaTypeObject

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

Method - Enum in io.muserver

An HTTP Method

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

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

MIN_FRESH - Static variable in class io.muserver.HeaderValues

"min-fresh"

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

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

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

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

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

MuException - Exception in io.muserver

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

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

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

MuHandler - Interface in io.muserver

An HTTP request handler.

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

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

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 - Interface in io.muserver

A web server handler.

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

Creates a new server builder.

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

Mutils - Class in io.muserver

N

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

NAME - Static variable in class io.muserver.HeaderValues

"name" See HeaderNames.CONTENT_DISPOSITION

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

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

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

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

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

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

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

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

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

NEWLINE - Static variable in class io.muserver.Mutils

The new-line character for the current platform, e.g.

NO_CACHE - Static variable in class io.muserver.HeaderValues

"no-cache"

NO_STORE - Static variable in class io.muserver.HeaderValues

"no-store"

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"

NOSNIFF - Static variable in class io.muserver.HeaderValues

"nosniff"

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

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

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

Checks for a null string or string with a length of 9

O

OAuthFlowObject - Class in io.muserver.openapi

oAuthFlowObject() - Static method in class io.muserver.openapi.OAuthFlowObjectBuilder

Creates a builder for an OAuthFlowObject

OAuthFlowObjectBuilder - Class in io.muserver.openapi

Configuration details for a supported OAuth Flow

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

OAuthFlowsObject - Class in io.muserver.openapi

oAuthFlowsObject() - Static method in class io.muserver.openapi.OAuthFlowsObjectBuilder

Creates a builder for an OAuthFlowsObject

OAuthFlowsObjectBuilder - Class in io.muserver.openapi

Allows configuration of the supported OAuth Flows.

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

onComplete(boolean) - Method in interface io.muserver.AsyncHandle.ResponseCompletedListener

Called when it is detected that the client request is completed.

onComplete() - Method in interface io.muserver.RequestBodyListener

Called when the request body is fully received.

onDataReceived(ByteBuffer) - Method in interface io.muserver.RequestBodyListener

Called when request data is received from the client.

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

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

Called if the write failed, for example if the user closed their browser while writing to it

onHeaders(AsyncContext, Headers) - Method in interface io.muserver.AsyncMuHandler

Deprecated.

onHeaders(AsyncContext, Headers) - Method in class io.muserver.handlers.HttpToHttpsRedirector

Deprecated.

ONLY_IF_CACHED - Static variable in class io.muserver.HeaderValues

"only-if-cached"

onRequestComplete(AsyncContext) - Method in interface io.muserver.AsyncMuHandler

Deprecated.

onRequestComplete(AsyncContext) - Method in class io.muserver.handlers.HttpToHttpsRedirector

Deprecated.

onRequestData(AsyncContext, ByteBuffer) - Method in interface io.muserver.AsyncMuHandler

Deprecated.

onRequestData(AsyncContext, ByteBuffer) - Method in class io.muserver.handlers.HttpToHttpsRedirector

Deprecated.

onSuccess() - Method in interface io.muserver.WriteCallback

Called if the write succeeds

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

OpenAPIObject - Class in io.muserver.openapi

openAPIObject() - Static method in class io.muserver.openapi.OpenAPIObjectBuilder

Creates a builder for an OpenAPIObject

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

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

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

OperationObject - Class in io.muserver.openapi

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

Creates a builder for a OperationObject

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

ORIGIN - Static variable in class io.muserver.HeaderNames

"origin"

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

Gets an output stream that sends an HTTP chunk each time the write method is called.

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, String) - Method in class io.muserver.ParameterizedHeader

parameter(String) - Method in class io.muserver.ParameterizedHeaderWithValue

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.

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

ParameterObject - Class in io.muserver.openapi

parameterObject() - Static method in class io.muserver.openapi.ParameterObjectBuilder

Creates a builder for a ParameterObject

ParameterObjectBuilder - Class in io.muserver.openapi

Describes a single operation parameter.

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

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

Deprecated.

Use query().getAll(name) instead

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

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

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

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

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

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

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

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

PathItemObject - Class in io.muserver.openapi

pathItemObject() - Static method in class io.muserver.openapi.PathItemObjectBuilder

Creates a builder for a PathItemObject

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

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

PathsObject - Class in io.muserver.openapi

pathsObject() - Static method in class io.muserver.openapi.PathsObjectBuilder

Creates a builder for a PathsObject

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

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

PRAGMA - Static variable in class io.muserver.HeaderNames

"pragma"

prefix - Variable 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

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

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"

Q

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

Gets the querystring parameters for this request.

QUOTED_PRINTABLE - Static variable in class io.muserver.HeaderValues

"quoted-printable"

R

RANGE - Static variable in class io.muserver.HeaderNames

"range"

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

Returns the request body as a string.

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

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 URI.

REFERER - Static variable in class io.muserver.HeaderNames

"referer"

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

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

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.MuRequest

Gets the address that the request came from.

remove(String) - Method in class io.muserver.Headers

remove(CharSequence) - Method in class io.muserver.Headers

request - Variable in class io.muserver.AsyncContext

Deprecated.

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

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

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

RequestBodyListener - Interface in io.muserver

Callbacks for reading request body data asynchronously.

RequestBodyObject - Class in io.muserver.openapi

requestBodyObject() - Static method in class io.muserver.openapi.RequestBodyObjectBuilder

Creates a builder for a RequestBodyObject

RequestBodyObjectBuilder - Class in io.muserver.openapi

Describes a single request body.

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

RequestParameters - Interface in io.muserver

Provides access to QueryString or Form values.

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

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

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

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

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

response - Variable in class io.muserver.AsyncContext

Deprecated.

ResponseHeader - Annotation Type in io.muserver.rest

Describes an HTTP Header that is returned by a rest method.

ResponseObject - Class in io.muserver.openapi

responseObject() - Static method in class io.muserver.openapi.ResponseObjectBuilder

Creates a builder for a ResponseObject

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

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

ResponsesObject - Class in io.muserver.openapi

responsesObject() - Static method in class io.muserver.openapi.ResponsesObjectBuilder

Creates a builder for a ResponsesObject

ResponsesObjectBuilder - Class in io.muserver.openapi

A container for the expected responses of an operation.

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

RestHandler - Class in io.muserver.rest

A handler that serves JAX-RS resources.

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

Creates a handler builder for JAX-RS REST services.

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

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

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"

saveTo(File) - Method in interface io.muserver.UploadedFile

Saves the file to the specified destination.

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

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

SchemaObject - Class in io.muserver.openapi

schemaObject() - Static method in class io.muserver.openapi.SchemaObjectBuilder

Creates a builder for a SchemaObject

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

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

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

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

scopes - Variable 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"

secureCookie(String, String) - Static method in class io.muserver.Cookie

Creates a new cookie with secure settings such as HttpOnly and Secure set to true.

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

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

SecurityRequirementObject - Class in io.muserver.openapi

securityRequirementObject() - Static method in class io.muserver.openapi.SecurityRequirementObjectBuilder

Creates a builder for a SecurityRequirementObjectBuilder

SecurityRequirementObjectBuilder - Class in io.muserver.openapi

Lists the required security schemes to execute this operation.

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

SecuritySchemeObject - Class in io.muserver.openapi

securitySchemeObject() - Static method in class io.muserver.openapi.SecuritySchemeObjectBuilder

Creates a builder for a SecuritySchemeObject

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

send(String) - Method in interface io.muserver.AsyncSsePublisher

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, String) - Method in interface io.muserver.AsyncSsePublisher

Sends a message with an event type and ID.

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.SsePublisher

Sends a message with an event type (without an ID).

send(String, String, String) - Method in interface io.muserver.SsePublisher

Sends a message with an event type and ID.

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.

SERVER - Static variable in class io.muserver.HeaderNames

"server"

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

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

ServerObject - Class in io.muserver.openapi

serverObject() - Static method in class io.muserver.openapi.ServerObjectBuilder

Creates a builder for a ServerObject

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

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

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

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

The URI of the request for this server.

ServerVariableObject - Class in io.muserver.openapi

serverVariableObject() - Static method in class io.muserver.openapi.ServerVariableObjectBuilder

Creates a builder for a ServerVariableObjectBuilder

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

set(String, Object) - Method in class io.muserver.Headers

set(CharSequence, Object) - Method in class io.muserver.Headers

set(String, Iterable<?>) - Method in class io.muserver.Headers

set(CharSequence, Iterable<?>) - Method in class io.muserver.Headers

set(Headers) - Method in class io.muserver.Headers

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 class io.muserver.Headers

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

setHttpOnly(boolean) - Method in class io.muserver.Cookie

setInt(CharSequence, int) - Method in class io.muserver.Headers

setMaxAge(long) - Method in class io.muserver.Cookie

setPath(String) - Method in class io.muserver.Cookie

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

Add a listener for when request processing is complete.

setSecure(boolean) - Method in class io.muserver.Cookie

setShort(CharSequence, short) - Method in class io.muserver.Headers

setValue(String) - Method in class io.muserver.Cookie

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

size() - Method in class io.muserver.Headers

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

Gets the size of the file.

SsePublisher - Interface in io.muserver

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

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

SSLContextBuilder - Class in io.muserver

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

start(MuRequest, MuResponse) - Static method in interface io.muserver.AsyncSsePublisher

Creates a new Server-Sent Events publisher.

start() - Method in class io.muserver.MuServerBuilder

Creates and starts this server.

start(MuRequest, MuResponse) - Static method in interface io.muserver.SsePublisher

Creates a new Server-Sent Events publisher.

state - Variable in class io.muserver.AsyncContext

Deprecated.

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

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

state(Object) - Method in interface io.muserver.MuRequest

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

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

STRICT_TRANSPORT_SECURITY - Static variable in class io.muserver.HeaderNames

"te"

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

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

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

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

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

T

TagObject - Class in io.muserver.openapi

tagObject() - Static method in class io.muserver.openapi.TagObjectBuilder

Creates a builder for a TagObjectBuilder

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

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

TE - Static variable in class io.muserver.HeaderNames

"te"

termsOfService - Variable 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_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_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_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_JAVASCRIPT - Static variable in class io.muserver.handlers.ResourceType

TEXT_MARKDOWN - Static variable in class io.muserver.ContentTypes

Markdown: "text/markdown"

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

TEXT_PLAIN - Static variable in class io.muserver.ContentTypes

Plain text: "text/plain"

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

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

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

title - Variable 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

Toggles - Class in io.muserver

Temporary features that might be removed without notice.

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

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

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

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

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

toString() - Method in class io.muserver.Headers

toString(MediaType) - Static method in class io.muserver.MediaTypeParser

Converts a MediaType object into a string, suitable for printing in an HTTP header.

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

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.PathMatch

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

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

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

U

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

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

UPGRADE - Static variable in class io.muserver.HeaderNames

"upgrade"

UPGRADE - Static variable in class io.muserver.HeaderValues

"upgrade"

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

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

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

url - Variable 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

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

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

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

valueOf(String) - Static method in enum io.muserver.Method

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.

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

VARY - Static variable in class io.muserver.HeaderNames

"vary"

version - Variable 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_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_MPEG - Static variable in class io.muserver.ContentTypes

MPEG Video: "video/mpeg"

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

VIDEO_OGG - Static variable in class io.muserver.ContentTypes

OGG video: "video/ogg"

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

VIDEO_WEBM - Static variable in class io.muserver.ContentTypes

WEBM video: "video/webm"

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

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_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

W

WARNING - Static variable in class io.muserver.HeaderNames

"warning"

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"

withAdditionalProperties(Object) - Method in class io.muserver.openapi.SchemaObjectBuilder

withAllOf(List<SchemaObject>) - Method in class io.muserver.openapi.SchemaObjectBuilder

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.

withAllowedOriginRegex(Pattern) - 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.

withAllowedOrigins(String...) - Method in class io.muserver.rest.CORSConfigBuilder

The origin values that CORS requests are allowed for.

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

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

withCallbacks(Map<String, PathItemObject>) - Method in class io.muserver.openapi.CallbackObjectBuilder

withCallbacks(Map<String, CallbackObject>) - Method in class io.muserver.openapi.ComponentsObjectBuilder

withCallbacks(Map<String, CallbackObject>) - Method in class io.muserver.openapi.OperationObjectBuilder

withClientCredentials(OAuthFlowObject) - Method in class io.muserver.openapi.OAuthFlowsObjectBuilder

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.

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.HeaderObjectBuilder

withDeprecated(boolean) - Method in class io.muserver.openapi.OperationObjectBuilder

withDeprecated(boolean) - Method in class io.muserver.openapi.ParameterObjectBuilder

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

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)

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

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(String) - Method in class io.muserver.openapi.HeaderObjectBuilder

withExplode(Boolean) - Method in class io.muserver.openapi.ParameterObjectBuilder

withExposedHeaders(String...) - Method in class io.muserver.rest.CORSConfigBuilder

Specifies which headers are allowed to be accessed by JavaScript.

withExposedHeaders(Collection<String>) - Method in class io.muserver.rest.CORSConfigBuilder

Specifies which headers are allowed to be accessed by JavaScript.

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

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.

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.

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(SSLContext) - Method in class io.muserver.MuServerBuilder

Sets the HTTPS config.

withHttpsConfig(SSLContextBuilder) - Method in class io.muserver.MuServerBuilder

Sets the HTTPS config.

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

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

withKeyPassword(String) - Method in class io.muserver.SSLContextBuilder

withKeyPassword(char[]) - Method in class io.muserver.SSLContextBuilder

withKeystore(InputStream) - Method in class io.muserver.SSLContextBuilder

withKeystore(File) - Method in class io.muserver.SSLContextBuilder

withKeystoreFromClasspath(String) - Method in class io.muserver.SSLContextBuilder

withKeystorePassword(String) - Method in class io.muserver.SSLContextBuilder

withKeystorePassword(char[]) - Method in class io.muserver.SSLContextBuilder

withKeystoreType(String) - Method in class io.muserver.SSLContextBuilder

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

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

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

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

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

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

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(Map<String, ParameterObject>) - Method in class io.muserver.openapi.ComponentsObjectBuilder

withParameters(Map<String, Object>) - Method in class io.muserver.openapi.LinkObjectBuilder

withParameters(List<ParameterObject>) - Method in class io.muserver.openapi.OperationObjectBuilder

withParameters(List<ParameterObject>) - Method in class io.muserver.openapi.PathItemObjectBuilder

withPassword(OAuthFlowObject) - Method in class io.muserver.openapi.OAuthFlowsObjectBuilder

withPath(String) - Method in class io.muserver.ContextHandlerBuilder

Sets the path to serve from.

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

Specifies the path to serve the static from.

withPattern(Pattern) - Method in class io.muserver.openapi.SchemaObjectBuilder

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

withReadOnly(Boolean) - Method in class io.muserver.openapi.SchemaObjectBuilder

withRefreshUrl(URI) - Method in class io.muserver.openapi.OAuthFlowObjectBuilder

withRequestBodies(Map<String, RequestBodyObject>) - Method in class io.muserver.openapi.ComponentsObjectBuilder

withRequestBody(Object) - Method in class io.muserver.openapi.LinkObjectBuilder

withRequestBody(RequestBodyObject) - Method in class io.muserver.openapi.OperationObjectBuilder

withRequired(boolean) - Method in class io.muserver.openapi.HeaderObjectBuilder

withRequired(Boolean) - Method in class io.muserver.openapi.ParameterObjectBuilder

withRequired(boolean) - Method in class io.muserver.openapi.RequestBodyObjectBuilder

withRequired(List<String>) - Method in class io.muserver.openapi.SchemaObjectBuilder

withRequirements(Map<String, List<String>>) - Method in class io.muserver.openapi.SecurityRequirementObjectBuilder

withResponses(Map<String, ResponseObject>) - Method in class io.muserver.openapi.ComponentsObjectBuilder

withResponses(ResponsesObject) - Method in class io.muserver.openapi.OperationObjectBuilder

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(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

withUrl(String) - Method in class io.muserver.openapi.ServerObjectBuilder

withValue(Object) - Method in class io.muserver.openapi.ExampleObjectBuilder

withVariables(Map<String, ServerVariableObject>) - Method in class io.muserver.openapi.ServerObjectBuilder

withVersion(String) - Method in class io.muserver.openapi.InfoObjectBuilder

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

write(ByteBuffer, WriteCallback) - Method in interface io.muserver.AsyncHandle

Writes data to the response asynchronously.

write(ByteBuffer) - Method in interface io.muserver.AsyncHandle

Writes data to the response asynchronously.

write(String) - Method in interface io.muserver.MuResponse

Writes the given text as the response body for this request.

writeAsync(String) - Method in interface io.muserver.MuResponse

Deprecated.

For async handling, call MuRequest.handleAsync()

WriteCallback - Interface in io.muserver

A callback for asynchronous write operations.

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

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

A print writer that can be used to send text to the client.

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

XmlObject - Class in io.muserver.openapi

xmlObject() - Static method in class io.muserver.openapi.XmlObjectBuilder

Creates a builder for a XmlObject

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