- ACCEPT - Static variable in class io.muserver.HeaderNames
-
"accept"
- accept() - Method in interface io.muserver.Headers
-
Gets the Accept-Charset
header value.
- ACCEPT_CHARSET - Static variable in class io.muserver.HeaderNames
-
"accept-charset"
- ACCEPT_ENCODING - Static variable in class io.muserver.HeaderNames
-
"accept-encoding"
- ACCEPT_LANGUAGE - Static variable in class io.muserver.HeaderNames
-
"accept-language"
- ACCEPT_PATCH - Static variable in class io.muserver.HeaderNames
-
"accept-patch"
- ACCEPT_RANGES - Static variable in class io.muserver.HeaderNames
-
"accept-ranges"
- acceptCharset() - Method in interface io.muserver.Headers
-
Gets the Accept
header value.
- acceptEncoding() - Method in interface io.muserver.Headers
-
Gets the Accept-Encoding
header value.
- acceptLanguage() - Method in interface io.muserver.Headers
-
Gets the Accept-Language
header value.
- ACCESS_CONTROL_ALLOW_CREDENTIALS - Static variable in class io.muserver.HeaderNames
-
"access-control-allow-credentials"
- ACCESS_CONTROL_ALLOW_HEADERS - Static variable in class io.muserver.HeaderNames
-
"access-control-allow-headers"
- ACCESS_CONTROL_ALLOW_METHODS - Static variable in class io.muserver.HeaderNames
-
"access-control-allow-methods"
- ACCESS_CONTROL_ALLOW_ORIGIN - Static variable in class io.muserver.HeaderNames
-
"access-control-allow-origin"
- ACCESS_CONTROL_EXPOSE_HEADERS - Static variable in class io.muserver.HeaderNames
-
"access-control-expose-headers"
- ACCESS_CONTROL_MAX_AGE - Static variable in class io.muserver.HeaderNames
-
"access-control-max-age"
- ACCESS_CONTROL_REQUEST_HEADERS - Static variable in class io.muserver.HeaderNames
-
"access-control-request-headers"
- ACCESS_CONTROL_REQUEST_METHOD - Static variable in class io.muserver.HeaderNames
-
"access-control-request-method"
- activeConnections() - Method in interface io.muserver.MuServer
-
- activeConnections() - Method in interface io.muserver.MuStats
-
- activeRequests() - Method in interface io.muserver.HttpConnection
-
- activeRequests() - Method in interface io.muserver.MuStats
-
- activeWebsockets() - Method in interface io.muserver.HttpConnection
-
The websockets on this connection.
- add(String, Object) - Method in interface io.muserver.Headers
-
- add(CharSequence, Object) - Method in interface io.muserver.Headers
-
- add(String, Iterable<?>) - Method in interface io.muserver.Headers
-
- add(CharSequence, Iterable<?>) - Method in interface io.muserver.Headers
-
- add(Headers) - Method in interface io.muserver.Headers
-
- addAsyncHandler(AsyncMuHandler) - Method in class io.muserver.MuServerBuilder
-
- 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 interface 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
- addResponseCompleteListener(ResponseCompleteListener) - Method in class io.muserver.MuServerBuilder
-
Adds a listener that is notified when each response completes
- addResponseFilter(ContainerResponseFilter) - Method in class io.muserver.rest.RestHandlerBuilder
-
Registers a response filter, which is called after execution of a method takes place.
- address() - Method in interface io.muserver.MuServer
-
- addShort(CharSequence, short) - Method in interface io.muserver.Headers
-
Deprecated.
- 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
-
- allowedHeaders - 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_JAVASCRIPT - Static variable in class io.muserver.handlers.ResourceType
-
- 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
-
- artifactVersion() - Static method in interface io.muserver.MuServer
-
- asBytes() - Method in interface io.muserver.UploadedFile
-
Gets the file contents as a byte array.
- asFile() - Method in interface io.muserver.UploadedFile
-
Gets a copy of the file.
- asStream() - Method in interface io.muserver.UploadedFile
-
Gets the uploaded file as a stream.
- asString() - Method in interface io.muserver.UploadedFile
-
Returns the contents of the file as a String, decoded using UTF-8
- AsyncContext - Class in io.muserver
-
- AsyncHandle - Interface in io.muserver
-
A class to handle the request and response handling when using asynchronous request handling.
- AsyncHandle.ResponseCompletedListener - Interface in io.muserver
-
Deprecated.
- AsyncMuHandler - Interface in io.muserver
-
- 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
-
- attribute(String) - Method in interface io.muserver.MuRequest
-
- attribute(String, Object) - Method in interface io.muserver.MuRequest
-
Sets the given object as state associated with the given key that is bound to this request which any subsequent handlers can access.
- attribute - Variable in class io.muserver.openapi.XmlObject
-
- attributes() - Method in interface io.muserver.MuRequest
-
Returns the map containing all the attributes.
- AUDIO_AAC - Static variable in class io.muserver.ContentTypes
-
AAC audio file: "audio/aac"
- AUDIO_AAC - Static variable in class io.muserver.handlers.ResourceType
-
- AUDIO_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.
- CACHE_CONTROL - Static variable in class io.muserver.HeaderNames
-
"cache-control"
- cacheControl() - Method in interface io.muserver.Headers
-
Gets the Cache-Control
header value.
- CallbackObject - Class in io.muserver.openapi
-
- callbackObject() - Static method in class io.muserver.openapi.CallbackObjectBuilder
-
- 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
-
- certificates() - Method in interface io.muserver.SSLInfo
-
Gets the server certificates that are in use.
- changeHttpsConfig(HttpsConfigBuilder) - Method in interface io.muserver.MuServer
-
Changes the HTTPS certificate.
- changeSSLContext(SSLContext) - Method in interface io.muserver.MuServer
-
- changeSSLContext(SSLContextBuilder) - Method in interface io.muserver.MuServer
-
- CHARSET - Static variable in class io.muserver.HeaderValues
-
"charset"
- CHUNKED - Static variable in class io.muserver.HeaderValues
-
"chunked"
- cipher() - Method in interface io.muserver.HttpConnection
-
- ciphers() - Method in interface io.muserver.SSLInfo
-
- classpathHandler(String) - Static method in class io.muserver.handlers.ResourceHandler
-
- classpathHandler(String) - Static method in class io.muserver.handlers.ResourceHandlerBuilder
-
Creates a handler that serves files from the classpath..
- clear() - Method in interface io.muserver.Headers
-
- clientCredentials - Variable in class io.muserver.openapi.OAuthFlowsObject
-
- ClientDisconnectedException - Exception in io.muserver
-
Thrown when a client non-gracefully disconnects.
- ClientDisconnectedException() - Constructor for exception io.muserver.ClientDisconnectedException
-
- 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.MuWebSocketSession
-
Initiates a graceful shutdown with the client.
- close(int, String) - Method in interface io.muserver.MuWebSocketSession
-
Initiates a graceful shutdown with the client.
- 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
-
Call this to indicate that the response is complete.
- completedConnections() - Method in interface io.muserver.MuStats
-
- completedRequests() - Method in interface io.muserver.HttpConnection
-
- completedRequests() - Method in interface io.muserver.MuStats
-
- completedSuccessfully() - Method in class io.muserver.AsyncContext
-
Deprecated.
- completedSuccessfully() - Method in interface io.muserver.ResponseInfo
-
Indicates whether or not a response completed successfully.
- components - Variable in class io.muserver.openapi.OpenAPIObject
-
- ComponentsObject - Class in io.muserver.openapi
-
- componentsObject() - Static method in class io.muserver.openapi.ComponentsObjectBuilder
-
- ComponentsObjectBuilder - Class in io.muserver.openapi
-
Holds a set of reusable objects for different aspects of the OAS.
- ComponentsObjectBuilder() - Constructor for class io.muserver.openapi.ComponentsObjectBuilder
-
- COMPRESS - Static variable in class io.muserver.HeaderValues
-
"compress"
- config() - Static method in class io.muserver.handlers.CORSHandlerBuilder
-
- CONNECTION - Static variable in class io.muserver.HeaderNames
-
"connection"
- connection() - Method in interface io.muserver.MuRequest
-
- contact - Variable in class io.muserver.openapi.InfoObject
-
- ContactObject - Class in io.muserver.openapi
-
- contactObject() - Static method in class io.muserver.openapi.ContactObjectBuilder
-
- ContactObjectBuilder - Class in io.muserver.openapi
-
Contact information for the exposed API.
- ContactObjectBuilder() - Constructor for class io.muserver.openapi.ContactObjectBuilder
-
- contains(String) - Method in interface io.muserver.Headers
-
Returns true if the given parameter is specified with any value
- contains(CharSequence) - Method in interface io.muserver.Headers
-
Returns true if the given parameter is specified with any value
- contains(String, String, boolean) - Method in interface io.muserver.Headers
-
Checks if a header with the given name exists with the given value.
- contains(CharSequence, CharSequence, boolean) - Method in interface io.muserver.Headers
-
Checks if a header with the given name exists with the given value.
- contains(String) - Method in interface io.muserver.RequestParameters
-
Returns true if the given parameter is specified with any value
- containsValue(CharSequence, CharSequence, boolean) - Method in interface 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.Headers
-
Gets the parsed Content-Type
header value.
- contentType() - Method in interface io.muserver.MuRequest
-
Gets the content type of the request body, for example application/json
or null
if there is no body.
- contentType(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
-
- context(String, MuHandlerBuilder...) - Static method in class io.muserver.ContextHandlerBuilder
-
- 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
-
- CONTINUE - Static variable in class io.muserver.HeaderValues
-
"100-continue"
- Cookie - Class in io.muserver
-
A cookie that is sent from the server to the client.
- Cookie(String, String) - Constructor for class io.muserver.Cookie
-
- 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
- CookieBuilder - Class in io.muserver
-
- CookieBuilder() - Constructor for class io.muserver.CookieBuilder
-
- cookies() - Method in interface io.muserver.MuRequest
-
Gets all the client-sent cookies
- copy(InputStream, OutputStream, int) - Static method in class io.muserver.Mutils
-
Copies an input stream to another stream
- CORSConfig - 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
-
- CORSHandler - Class in io.muserver.handlers
-
A handler that adds CORS headers to responses.
- corsHandler() - Static method in class io.muserver.handlers.CORSHandlerBuilder
-
A helper for creating a CORS handler
- CORSHandlerBuilder - Class in io.muserver.handlers
-
Used to create a handler that puts appropriate CORS headers on requests.
- CORSHandlerBuilder() - Constructor for class io.muserver.handlers.CORSHandlerBuilder
-
- create(MuRequest, Headers) - Method in interface io.muserver.MuWebSocketFactory
-
Creates a web socket for an upgrade request.
- create(Object...) - Static method in class io.muserver.rest.RestHandlerBuilder
-
- 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
-
- failedToConnect() - Method in interface io.muserver.MuStats
-
- FILE - Static variable in class io.muserver.HeaderValues
-
- fileHandler(String) - Static method in class io.muserver.handlers.ResourceHandler
-
- fileHandler(File) - Static method in class io.muserver.handlers.ResourceHandler
-
- fileHandler(Path) - Static method in class io.muserver.handlers.ResourceHandler
-
- 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() - 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
-
- 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
-
- 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
-
- format - Variable in class io.muserver.openapi.SchemaObject
-
- formValue(String) - Method in interface io.muserver.MuRequest
-
- formValues(String) - Method in interface io.muserver.MuRequest
-
- forValue() - Method in class io.muserver.ForwardedHeader
-
- FORWARDED - Static variable in class io.muserver.HeaderNames
-
"forwarded"
- forwarded() - Method in interface io.muserver.Headers
-
Gets the Forwarded
header value.
- ForwardedHeader - Class in io.muserver
-
Represents a Forwarded
header as described by RFC-7239.
- ForwardedHeader(String, String, String, String, Map<String, String>) - Constructor for class io.muserver.ForwardedHeader
-
Creates a new Forwarded Header.
- FROM - Static variable in class io.muserver.HeaderNames
-
"from"
- fromHttpDate(String) - Static method in class io.muserver.Mutils
-
Converts a date string as used in HTTP headers (defined in RFC 7321) into a date object
- fromString(String) - Static method in class io.muserver.ForwardedHeader
-
Parses the value of a Forwarded
header into an object.
- fromString(String) - Static method in class io.muserver.MediaTypeParser
-
Converts a string such as "text/plain" into a MediaType object.
- fromString(String) - Static method in class io.muserver.ParameterizedHeader
-
Converts a comma-separated list of param names (with optional values) into a Parameterized Header
- fromString(String) - Static method in class io.muserver.ParameterizedHeaderWithValue
-
Converts headers that are values followed by optional parameters into a list of values with parameters.
- 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
-
- get(String) - Method in interface io.muserver.Headers
-
Gets the value with the given name, or null if there is no parameter with that name.
- get(CharSequence) - Method in interface io.muserver.Headers
-
Gets the value with the given name, or null if there is no parameter with that name.
- get(CharSequence, String) - Method in interface io.muserver.Headers
-
Gets the value with the given name, or the default value if there is no parameter with that name.
- get(String) - Method in interface io.muserver.RequestParameters
-
Gets the value with the given name, or null if there is no parameter with that name.
- get(String, String) - Method in interface io.muserver.RequestParameters
-
Gets the value with the given name, or the default value if there is no parameter with that name.
- getAll(String) - Method in interface io.muserver.Headers
-
Gets all the parameters with the given name, or an empty list if none are found.
- getAll(CharSequence) - Method in interface io.muserver.Headers
-
Gets all the parameters with the given name, or an empty list if none are found.
- getAll(String) - Method in interface io.muserver.RequestParameters
-
Gets all the parameters with the given name, or an empty list if none are found.
- getAllAsString(CharSequence) - Method in interface io.muserver.Headers
-
Deprecated.
- getAsString(CharSequence) - Method in interface io.muserver.Headers
-
Deprecated.
- getBoolean(String) - Method in interface io.muserver.Headers
-
Gets a parameter as a boolean, where values such as true
, on
and yes
as
considered true, and other values (or no parameter with the name) is considered false.
- getBoolean(String) - Method in interface io.muserver.RequestParameters
-
Gets a parameter as a boolean, where values such as true
, on
and yes
as
considered true, and other values (or no parameter with the name) is considered false.
- getDefaultMapping() - Static method in class io.muserver.handlers.ResourceType
-
- getDouble(String, double) - Method in interface io.muserver.Headers
-
Gets the parameter as a double, or returns the default value if it was not specified or was in an invalid format.
- getDouble(String, double) - Method in interface io.muserver.RequestParameters
-
Gets the parameter as a double, or returns the default value if it was not specified or was in an invalid format.
- getFloat(String, float) - Method in interface io.muserver.Headers
-
Gets the parameter as a float, or returns the default value if it was not specified or was in an invalid format.
- getFloat(String, float) - Method in interface io.muserver.RequestParameters
-
Gets the parameter as a float, or returns the default value if it was not specified or was in an invalid format.
- getInt(CharSequence) - Method in interface io.muserver.Headers
-
Deprecated.
- getInt(CharSequence, int) - Method in interface io.muserver.Headers
-
Gets the parameter as an integer, or returns the default value if it was not specified or was in an invalid format.
- getInt(String, int) - Method in interface io.muserver.RequestParameters
-
Gets the parameter as an integer, or returns the default value if it was not specified or was in an invalid format.
- getLong(String, long) - Method in interface io.muserver.Headers
-
Gets the parameter as a long, or returns the default value if it was not specified or was in an invalid format.
- getLong(String, long) - Method in interface io.muserver.RequestParameters
-
Gets the parameter as a long, or returns the default value if it was not specified or was in an invalid format.
- getPathToServeFrom() - Method in class io.muserver.handlers.ResourceHandler
-
- getResourceTypes() - Static method in class io.muserver.handlers.ResourceType
-
- getShort(CharSequence) - Method in interface io.muserver.Headers
-
Deprecated.
- getShort(CharSequence, short) - Method in interface io.muserver.Headers
-
Deprecated.
- getTimeMillis(CharSequence) - Method in interface io.muserver.Headers
-
- getTimeMillis(CharSequence, long) - Method in interface 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"
- gzipEnabled() - Method in interface io.muserver.MuServer
-
Specifies whether GZIP is on or not.
- gzippableMimeTypes(List<ResourceType>) - Static method in class io.muserver.handlers.ResourceType
-
- handle(MuRequest, MuResponse) - Method in class io.muserver.ContextHandler
-
- handle(MuRequest, MuResponse) - Method in class io.muserver.handlers.CORSHandler
-
- handle(MuRequest, MuResponse) - Method in class io.muserver.handlers.HttpsRedirector
-
- handle(MuRequest, MuResponse) - Method in class io.muserver.handlers.ResourceHandler
-
- handle(MuRequest, MuResponse) - Method in interface io.muserver.MuHandler
-
Called when an HTTP request is made (unless a previous handler stopped handler processing)
- handle(MuRequest, MuResponse) - Method in class io.muserver.rest.RestHandler
-
- handle(MuRequest, MuResponse, Map<String, String>) - Method in interface io.muserver.RouteHandler
-
- handle(MuRequest, MuResponse) - Method in class io.muserver.WebSocketHandler
-
- handleAsync() - Method in interface io.muserver.MuRequest
-
Specifies that you want to handle this response asynchronously.
- hasBody() - Method in interface io.muserver.Headers
-
- hashCode() - Method in class io.muserver.Cookie
-
- hashCode() - Method in class io.muserver.ForwardedHeader
-
- hashCode() - Method in interface io.muserver.Headers
-
- hashCode() - Method in class io.muserver.openapi.TagObject
-
- hashCode() - Method in class io.muserver.ParameterizedHeader
-
- hashCode() - Method in class io.muserver.ParameterizedHeaderWithValue
-
- hashCode() - Method in class io.muserver.rest.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
-
- HeaderObjectBuilder - Class in io.muserver.openapi
-
- HeaderObjectBuilder() - Constructor for class io.muserver.openapi.HeaderObjectBuilder
-
- headers - Variable in class io.muserver.handlers.ResourceType
-
- Headers - Interface in io.muserver
-
- 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() - Method in class io.muserver.ForwardedHeader
-
- HOST - Static variable in class io.muserver.HeaderNames
-
"host"
- htmlEncode(String) - Static method in class io.muserver.Mutils
-
Very basic HTML encoding, converting characters such as <
to <lt;
- http1Headers() - Static method in interface io.muserver.Headers
-
Creates new headers for HTTP1 requests
- http2 - Static variable in class io.muserver.Toggles
-
- Http2Config - Class in io.muserver
-
Configuration settings for HTTP2
- http2Config() - Static method in class io.muserver.Http2ConfigBuilder
-
Creates a new config where HTTP2 is disabled
- Http2ConfigBuilder - Class in io.muserver
-
- Http2ConfigBuilder() - Constructor for class io.muserver.Http2ConfigBuilder
-
- http2Enabled() - Static method in class io.muserver.Http2ConfigBuilder
-
Creates a new config where HTTP2 is enabled
- http2EnabledIfAvailable() - Static method in class io.muserver.Http2ConfigBuilder
-
Creates a new config where HTTP2 is enabled if supported by the Java version.
- http2Headers() - Static method in interface io.muserver.Headers
-
Creates new headers for HTTP2 requests
- HttpConnection - Interface in io.muserver
-
A connection between a server and a client.
- httpOnly(boolean) - Method in class io.muserver.CookieBuilder
-
Instructs browsers on whether or not the cookie can be accessed via JavaScript.
- httpsConfig() - Static method in class io.muserver.HttpsConfigBuilder
-
- HttpsConfigBuilder - Class in io.muserver
-
A builder for specifying HTTPS config.
- HttpsConfigBuilder() - Constructor for class io.muserver.HttpsConfigBuilder
-
- httpServer() - Static method in class io.muserver.MuServerBuilder
-
Creates a new server builder which will run as HTTP on a random port.
- httpsProtocol() - Method in interface io.muserver.HttpConnection
-
Gets the HTTPS protocol, for example "TLSv1.2" or "TLSv1.3"
- HttpsRedirector - Class in io.muserver.handlers
-
- HttpsRedirector.Builder - Class in io.muserver.handlers
-
- HttpsRedirectorBuilder - Class in io.muserver.handlers
-
- 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
-
- HttpToHttpsRedirector(int) - Constructor for class io.muserver.handlers.HttpToHttpsRedirector
-
Deprecated.
Creates a HTTPS redirector
- httpUri() - Method in interface io.muserver.MuServer
-
- 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
-
- InfoObjectBuilder - Class in io.muserver.openapi
-
The object provides metadata about the API.
- InfoObjectBuilder() - Constructor for class io.muserver.openapi.InfoObjectBuilder
-
- inputStream() - Method in interface io.muserver.MuRequest
-
The input stream of the request, if there was a request body.
- invalidHttpRequests() - Method in interface io.muserver.HttpConnection
-
- invalidHttpRequests() - Method in interface io.muserver.MuStats
-
- io.muserver - package io.muserver
-
This package contains the main API of mu-server, for example the server builders, request and response objects.
- io.muserver.handlers - package io.muserver.handlers
-
Some pre-built handlers for common tasks such as file handling.
- io.muserver.openapi - package io.muserver.openapi
-
A model of the Open API spec, which is used internally when creating documentation for JAX-RS services.
- io.muserver.rest - package io.muserver.rest
-
This package contains the JAX-RS implementation for mu-server.
- isAsync() - Method in interface io.muserver.MuRequest
-
- isDeprecated() - Method in class io.muserver.openapi.OperationObject
-
- isDeprecated() - Method in class io.muserver.openapi.SchemaObject
-
- isEmpty() - Method in interface io.muserver.Headers
-
- isHttpOnly() - Method in class io.muserver.Cookie
-
- isHttps() - Method in interface io.muserver.HttpConnection
-
- isInRole(Principal, String) - Method in interface io.muserver.rest.Authorizer
-
Checks if a user is in a role
- isSecure() - Method in class io.muserver.Cookie
-
- items - Variable in class io.muserver.openapi.SchemaObject
-
- iterator() - Method in interface io.muserver.Headers
-
- iteratorAsString() - Method in interface io.muserver.Headers
-
Deprecated.
- makeSessionCookie() - Method in class io.muserver.CookieBuilder
-
Makes this cookie expire when the browser session expires (which may be when the user closes their
browser).
- mapping - Variable in class io.muserver.openapi.DiscriminatorObject
-
- 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
-
- maxRequestHeadersSize() - Method in interface io.muserver.MuServer
-
The maximum allowed size of request headers.
- maxRequestSize() - Method in interface io.muserver.MuServer
-
The maximum allowed size of a request body.
- maxUrlSize() - Method in interface io.muserver.MuServer
-
The maximum allowed size of the URI sent in a request line.
- MediaTypeObject - Class in io.muserver.openapi
-
- mediaTypeObject() - Static method in class io.muserver.openapi.MediaTypeObjectBuilder
-
- MediaTypeObjectBuilder - Class in io.muserver.openapi
-
Each Media Type Object provides schema and examples for the media type identified by its key.
- MediaTypeObjectBuilder() - Constructor for class io.muserver.openapi.MediaTypeObjectBuilder
-
- MediaTypeParser - Class in io.muserver
-
A utility class to parse Media Type or Content Type values such as text/plain
and text/plain; charset=UTF-8
etc
- MediaTypeParser() - Constructor for class io.muserver.MediaTypeParser
-
- mergeResponses(ResponseObject, ResponseObject) - Static method in class io.muserver.openapi.ResponseObjectBuilder
-
Creates a new build by merging two existing response objects
- mergeResponses(ResponsesObject, ResponsesObject) - Static method in class io.muserver.openapi.ResponsesObjectBuilder
-
Creates a new build by merging two exising responses
- Method - Enum in io.muserver
-
An HTTP Method
- method() - Method in interface io.muserver.MuRequest
-
- mimeType - Variable in class io.muserver.handlers.ResourceType
-
- mimeTypesToGzip() - Method in interface io.muserver.MuServer
-
Specifies the mime-types that GZIP should be applied to.
- MIN_FRESH - Static variable in class io.muserver.HeaderValues
-
"min-fresh"
- minimum - Variable in class io.muserver.openapi.SchemaObject
-
- minimumGzipSize() - Method in interface io.muserver.MuServer
-
- 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() - Constructor for exception io.muserver.MuException
-
- 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
-
Various statistics about the current instance of a Mu Server.
- Mutils - Class in io.muserver
-
- MuWebSocket - Interface in io.muserver
-
- MuWebSocketFactory - Interface in io.muserver
-
A factory that can convert an upgrade request into a web socket.
- MuWebSocketSession - Interface in io.muserver
-
A web socket session used to send messages and events to a web socket client.
- OAuthFlowObject - Class in io.muserver.openapi
-
- oAuthFlowObject() - Static method in class io.muserver.openapi.OAuthFlowObjectBuilder
-
- 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
-
- OAuthFlowsObjectBuilder - Class in io.muserver.openapi
-
Allows configuration of the supported OAuth Flows.
- OAuthFlowsObjectBuilder() - Constructor for class io.muserver.openapi.OAuthFlowsObjectBuilder
-
- onBinary(ByteBuffer, DoneCallback) - Method in class io.muserver.BaseWebSocket
-
- onBinary(ByteBuffer, DoneCallback) - Method in interface io.muserver.MuWebSocket
-
Called when a message is received from the client.
- onClientClosed(int, String) - Method in class io.muserver.BaseWebSocket
-
- onClientClosed(int, String) - Method in interface io.muserver.MuWebSocket
-
Called when the client has closed the connection.
- onComplete(boolean) - Method in interface io.muserver.AsyncHandle.ResponseCompletedListener
-
Deprecated.
Called when it is detected that the client request is completed.
- onComplete(Throwable) - Method in interface io.muserver.DoneCallback
-
The operation has completed.
- onComplete() - Method in interface io.muserver.RequestBodyListener
-
Called when the request body is fully received.
- onComplete(ResponseInfo) - Method in interface io.muserver.ResponseCompleteListener
-
Called when a response completes (successfully or not).
- onConnect(MuWebSocketSession) - Method in class io.muserver.BaseWebSocket
-
- onConnect(MuWebSocketSession) - Method in interface io.muserver.MuWebSocket
-
Called when the websocket is connected.
- onDataReceived(ByteBuffer, DoneCallback) - Method in interface io.muserver.RequestBodyListener
-
Called when request data is received from the client.
- oneOf - Variable in class io.muserver.openapi.SchemaObject
-
- onError(Throwable) - Method in class io.muserver.BaseWebSocket
-
- onError(Throwable) - Method in interface io.muserver.MuWebSocket
-
Called when an unexpected error occurs.
- onError(Throwable) - Method in interface io.muserver.RequestBodyListener
-
Called if there is an error reading the body.
- onFailure(Throwable) - Method in interface io.muserver.WriteCallback
-
Deprecated.
Called if the write failed, for example if the user closed their browser while writing to it
- 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"
- onPing(ByteBuffer, DoneCallback) - Method in class io.muserver.BaseWebSocket
-
- onPing(ByteBuffer, DoneCallback) - Method in interface io.muserver.MuWebSocket
-
Called when a ping message is sent from a client.
- onPong(ByteBuffer, DoneCallback) - Method in class io.muserver.BaseWebSocket
-
- onPong(ByteBuffer, DoneCallback) - Method in interface io.muserver.MuWebSocket
-
Called when a pong message is sent from the client.
- 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
-
Deprecated.
Called if the write succeeds
- onText(String, DoneCallback) - Method in class io.muserver.BaseWebSocket
-
- onText(String, DoneCallback) - Method in interface io.muserver.MuWebSocket
-
Called when a message is received from the client.
- openapi - Variable in class io.muserver.openapi.OpenAPIObject
-
- OpenAPIObject - Class in io.muserver.openapi
-
- openAPIObject() - Static method in class io.muserver.openapi.OpenAPIObjectBuilder
-
- 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
-
- 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.
- RANGE - Static variable in class io.muserver.HeaderNames
-
"range"
- RateLimit - Class in io.muserver
-
Specifies the limits allowed for a single value, such as an IP address.
- rateLimit() - Static method in class io.muserver.RateLimitBuilder
-
Creates a new builder
- RateLimitBuilder - Class in io.muserver
-
- RateLimitBuilder() - Constructor for class io.muserver.RateLimitBuilder
-
- RateLimitRejectionAction - Enum in io.muserver
-
- RateLimitSelector - Interface in io.muserver
-
A function that controls how rate limits are applied.
- readBodyAsString() - Method in interface io.muserver.MuRequest
-
Returns the request body as a string.
- readOnly - Variable in class io.muserver.openapi.SchemaObject
-
- redirect(String) - Method in interface io.muserver.MuResponse
-
Redirects to the given URL.
- redirect(URI) - Method in interface io.muserver.MuResponse
-
Redirects to the given URL.
- REFERER - Static variable in class io.muserver.HeaderNames
-
"referer"
- refreshUrl - Variable in class io.muserver.openapi.OAuthFlowObject
-
- regexMatcher() - Method in class io.muserver.rest.PathMatch
-
- rejectedDueToOverload() - Method in interface io.muserver.HttpConnection
-
- rejectedDueToOverload() - Method in interface io.muserver.MuStats
-
- relativePath() - Method in interface io.muserver.MuRequest
-
The path of this request (without query string) relative to the context.
- remoteAddress() - Method in interface io.muserver.HttpConnection
-
- remoteAddress() - Method in interface io.muserver.MuRequest
-
Gets the address that the request came from.
- remoteAddress() - Method in interface io.muserver.MuWebSocketSession
-
- remove(String) - Method in interface io.muserver.Headers
-
- remove(CharSequence) - Method in interface io.muserver.Headers
-
- request - Variable in class io.muserver.AsyncContext
-
Deprecated.
- request() - Method in class io.muserver.AsyncContext
-
Deprecated.
- request() - Method in interface io.muserver.ResponseInfo
-
- 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
-
- RequestBodyObjectBuilder - Class in io.muserver.openapi
-
Describes a single request body.
- RequestBodyObjectBuilder() - Constructor for class io.muserver.openapi.RequestBodyObjectBuilder
-
- requestIdleTimeoutMillis() - Method in interface io.muserver.MuServer
-
The maximum idle timeout for reading request bodies.
- RequestParameters - Interface in io.muserver
-
Provides access to QueryString or Form values.
- required - Variable in class io.muserver.openapi.ParameterObject
-
- 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
-
- ResourceHandlerBuilder - Class in io.muserver.handlers
-
- 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.
- response() - Method in class io.muserver.AsyncContext
-
Deprecated.
- response() - Method in interface io.muserver.ResponseInfo
-
- ResponseCompleteListener - Interface in io.muserver
-
A callback for listening to response completion events.
- ResponseHeader - Annotation Type in io.muserver.rest
-
Describes an HTTP Header that is returned by a rest method.
- ResponseInfo - Interface in io.muserver
-
Information about a request and response.
- ResponseObject - Class in io.muserver.openapi
-
- responseObject() - Static method in class io.muserver.openapi.ResponseObjectBuilder
-
- 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
-
- 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_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
-
- 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
- schemaObjectFrom(Class<?>, Type) - Static method in class io.muserver.openapi.SchemaObjectBuilder
-
Creates a builder for a
SchemaObject
with the type and format based on the given class and generic type.
- schemas - Variable in class io.muserver.openapi.ComponentsObject
-
- 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"
- secure(boolean) - Method in class io.muserver.CookieBuilder
-
Instructs clients on whether or not cookies can be sent over non-secure (HTTP) connections.
- secureCookie(String, String) - Static method in class io.muserver.Cookie
-
- 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
-
- 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
-
- 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
-
- select(MuRequest) - Method in interface io.muserver.RateLimitSelector
-
Selects a rate limit bucket based on the current request.
- selectCiphers(Set<String>, List<String>) - Method in interface io.muserver.SSLCipherFilter
-
A method that returns the ciphers desired in the preferred order of use.
- 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.
- sendBinary(ByteBuffer, DoneCallback) - Method in interface io.muserver.MuWebSocketSession
-
Sends a message to the client
- sendChunk(String) - Method in interface io.muserver.MuResponse
-
Immediately sends the given text to the client as a chunk.
- sendComment(String) - Method in interface io.muserver.AsyncSsePublisher
-
Sends a comment to the client.
- sendComment(String) - Method in interface io.muserver.SsePublisher
-
Sends a comment to the client.
- sendPing(ByteBuffer, DoneCallback) - Method in interface io.muserver.MuWebSocketSession
-
Sends a ping message to the client, which is used for keeping sockets alive.
- sendPong(ByteBuffer, DoneCallback) - Method in interface io.muserver.MuWebSocketSession
-
- sendText(String, DoneCallback) - Method in interface io.muserver.MuWebSocketSession
-
Sends a message to the client asynchronously
- 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
-
- 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
-
- ServerVariableObjectBuilder - Class in io.muserver.openapi
-
An object representing a Server Variable for server URL template substitution.
- ServerVariableObjectBuilder() - Constructor for class io.muserver.openapi.ServerVariableObjectBuilder
-
- session() - Method in class io.muserver.BaseWebSocket
-
Gets the websocket session
- set(String, Object) - Method in interface io.muserver.Headers
-
- set(CharSequence, Object) - Method in interface io.muserver.Headers
-
- set(String, Iterable<?>) - Method in interface io.muserver.Headers
-
- set(CharSequence, Iterable<?>) - Method in interface io.muserver.Headers
-
- set(Headers) - Method in interface 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 interface 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 interface io.muserver.Headers
-
- setKeystoreBytes(InputStream, boolean) - Method in class io.muserver.SSLContextBuilder
-
Deprecated.
- 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
-
- setResponseCompleteHandler(ResponseCompleteListener) - 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 interface io.muserver.Headers
-
Deprecated.
- setValue(String) - Method in class io.muserver.Cookie
-
- shortCache() - Static method in class io.muserver.handlers.ResourceType
-
- size() - Method in interface io.muserver.Headers
-
- size() - Method in interface io.muserver.UploadedFile
-
Gets the size of the file.
- SsePublisher - Interface in io.muserver
-
An interface for sending Server-Sent Events (SSE) to a client.
- SSLCipherFilter - Interface in io.muserver
-
A filter allowing the selection of SSL certificates
- sslContext() - Static method in class io.muserver.SSLContextBuilder
-
Deprecated.
- SSLContextBuilder - Class in io.muserver
-
- SSLContextBuilder() - Constructor for class io.muserver.SSLContextBuilder
-
Deprecated.
- sslInfo() - Method in interface io.muserver.MuServer
-
Gets the SSL info of the server, or null if SSL is not enabled.
- SSLInfo - Interface in io.muserver
-
Information about the SSL settings being used by the server
- start(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.
- startTime() - Method in interface io.muserver.HttpConnection
-
- startTime() - Method in interface io.muserver.MuRequest
-
- state - Variable in class io.muserver.AsyncContext
-
- state() - Method in interface io.muserver.MuRequest
-
- state(Object) - Method in interface io.muserver.MuRequest
-
- stats() - Method in interface io.muserver.MuServer
-
- status() - Method in interface io.muserver.MuResponse
-
- status(int) - Method in interface io.muserver.MuResponse
-
Sets the response code for this request.
- stop() - Method in interface io.muserver.MuServer
-
Shuts down the server
- 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
-
- TagObject - Class in io.muserver.openapi
-
- tagObject() - Static method in class io.muserver.openapi.TagObjectBuilder
-
- TagObjectBuilder - Class in io.muserver.openapi
-
- 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_CALENDAR_UTF8 - Static variable in class io.muserver.ContentTypes
-
iCalendar format: "text/calendar;charset=utf-8"
- TEXT_CSS - Static variable in class io.muserver.ContentTypes
-
Cascading Style Sheets (CSS): "text/css"
- TEXT_CSS - Static variable in class io.muserver.handlers.ResourceType
-
- TEXT_CSS_UTF8 - Static variable in class io.muserver.ContentTypes
-
Cascading Style Sheets (CSS): "text/css;charset=utf-8"
- TEXT_CSV - Static variable in class io.muserver.ContentTypes
-
Comma-separated values (CSV): "text/csv"
- TEXT_CSV - Static variable in class io.muserver.handlers.ResourceType
-
- TEXT_CSV_UTF8 - Static variable in class io.muserver.ContentTypes
-
Comma-separated values (CSV): "text/csv;charset=utf-8"
- TEXT_EVENT_STREAM - Static variable in class io.muserver.ContentTypes
-
Server-Sent-Events, a.k.a.
- TEXT_HTML - Static variable in class io.muserver.ContentTypes
-
HyperText Markup Language (HTML): "text/html"
- TEXT_HTML - Static variable in class io.muserver.handlers.ResourceType
-
- TEXT_HTML_UTF8 - Static variable in class io.muserver.ContentTypes
-
HyperText Markup Language (HTML): "text/html;charset=utf-8"
- TEXT_JAVASCRIPT - Static variable in class io.muserver.handlers.ResourceType
-
- TEXT_MARKDOWN - Static variable in class io.muserver.ContentTypes
-
Markdown: "text/markdown"
- TEXT_MARKDOWN - Static variable in class io.muserver.handlers.ResourceType
-
- TEXT_MARKDOWN_UTF8 - Static variable in class io.muserver.ContentTypes
-
Markdown: "text/markdown;charset=utf-8"
- TEXT_PLAIN - Static variable in class io.muserver.ContentTypes
-
Plain text: "text/plain"
- TEXT_PLAIN - Static variable in class io.muserver.handlers.ResourceType
-
- TEXT_PLAIN_UTF8 - Static variable in class io.muserver.ContentTypes
-
Plain text: "text/plain;charset=utf-8"
- 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
- toByteBuffer(String) - Static method in class io.muserver.Mutils
-
Converts a string to a ByteBuffer with UTF-8 encoding.
- Toggles - Class in io.muserver
-
Temporary features that might be removed without notice.
- Toggles() - Constructor for class io.muserver.Toggles
-
- 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
-
- 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.ForwardedHeader
-
Converts the HeaderValue into a string, suitable for printing in an HTTP header.
- toString(List<ForwardedHeader>) - Static method in class io.muserver.ForwardedHeader
-
Converts a list of headers into a single string that can be put into a Forwarded header field.
- toString() - Method in class io.muserver.handlers.ResourceType
-
- toString() - Method in interface 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
-
- WARNING - Static variable in class io.muserver.HeaderNames
-
"warning"
- WEB_APP_MANIFEST - Static variable in class io.muserver.ContentTypes
-
Web App Manifest files "application/manifest+json"
- WEB_APP_MANIFEST - Static variable in class io.muserver.handlers.ResourceType
-
- WEBSOCKET - Static variable in class io.muserver.HeaderValues
-
"websocket"
- WEBSOCKET_LOCATION - Static variable in class io.muserver.HeaderNames
-
"websocket-location"
- WEBSOCKET_ORIGIN - Static variable in class io.muserver.HeaderNames
-
"websocket-origin"
- WEBSOCKET_PROTOCOL - Static variable in class io.muserver.HeaderNames
-
"websocket-protocol"
- WebSocketHandler - Class in io.muserver
-
A handler that can establish a web socket based on web socket upgrade requests.
- webSocketHandler() - Static method in class io.muserver.WebSocketHandlerBuilder
-
Creates a new handler builder.
- webSocketHandler(MuWebSocketFactory) - Static method in class io.muserver.WebSocketHandlerBuilder
-
Creates a new handler builder with the given factory.
- WebSocketHandlerBuilder - Class in io.muserver
-
Used to create handlers for web sockets.
- WebSocketHandlerBuilder() - Constructor for class io.muserver.WebSocketHandlerBuilder
-
- WebSocketProtocolException - Exception in io.muserver
-
Thrown when a websocket frame is received that is invalid for any reason.
- WebSocketProtocolException(String, Throwable) - Constructor for exception io.muserver.WebSocketProtocolException
-
- withAdditionalProperties(Object) - Method in class io.muserver.openapi.SchemaObjectBuilder
-
- withAllOf(List<SchemaObject>) - Method in class io.muserver.openapi.SchemaObjectBuilder
-
- withAllOriginsAllowed() - Method in class io.muserver.rest.CORSConfigBuilder
-
All origins will be allowed
- withAllowCredentials(boolean) - Method in class io.muserver.rest.CORSConfigBuilder
-
If set to true, then access-control-allow-credentials
is returned with true
on CORS responses.
- withAllowedHeaders(String...) - Method in class io.muserver.rest.CORSConfigBuilder
-
On preflight OPTIONS requests, specifies which headers are allowed to be sent on the request, aside from the "simple" headers.
- withAllowedHeaders(Collection<String>) - Method in class io.muserver.rest.CORSConfigBuilder
-
On preflight OPTIONS requests, specifies which headers are allowed to be sent on the request, aside from the "simple" headers.
- withAllowedMethods(Method...) - Method in class io.muserver.handlers.CORSHandlerBuilder
-
Specifies the headers allowed for CORS requests.
- withAllowedOriginRegex(Pattern) - Method in class io.muserver.rest.CORSConfigBuilder
-
The origin values that CORS requests are allowed for.
- withAllowedOriginRegex(String) - Method in class io.muserver.rest.CORSConfigBuilder
-
The origin values that CORS requests are allowed for.
- withAllowedOrigins(Collection<String>) - Method in class io.muserver.rest.CORSConfigBuilder
-
The origin values that CORS requests are allowed for, or null to allow all origins.
- 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
-
- withBucket(String) - Method in class io.muserver.RateLimitBuilder
-
Sets the bucket that the limit applies to.
- 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
-
- withCipherFilter(SSLCipherFilter) - Method in class io.muserver.HttpsConfigBuilder
-
Sets a filter allowing you to specify which ciphers you would like to support.
- withCipherFilter(SSLCipherFilter) - Method in class io.muserver.SSLContextBuilder
-
Deprecated.
Sets a filter allowing you to specify which ciphers you would like to support.
- withClientCredentials(OAuthFlowObject) - Method in class io.muserver.openapi.OAuthFlowsObjectBuilder
-
- withComponents(ComponentsObject) - Method in class io.muserver.openapi.OpenAPIObjectBuilder
-
- withContact(ContactObject) - Method in class io.muserver.openapi.InfoObjectBuilder
-
- withContent(Map<String, MediaTypeObject>) - Method in class io.muserver.openapi.HeaderObjectBuilder
-
- withContent(Map<String, MediaTypeObject>) - Method in class io.muserver.openapi.ParameterObjectBuilder
-
- withContent(Map<String, MediaTypeObject>) - Method in class io.muserver.openapi.RequestBodyObjectBuilder
-
- withContent(Map<String, MediaTypeObject>) - Method in class io.muserver.openapi.ResponseObjectBuilder
-
- withContentType(String) - Method in class io.muserver.openapi.EncodingObjectBuilder
-
- withCORS(CORSConfig) - Method in class io.muserver.rest.RestHandlerBuilder
-
Specifies the CORS config for the REST services.
- withCORS(CORSConfigBuilder) - Method in class io.muserver.rest.RestHandlerBuilder
-
Specifies the CORS config for the REST services.
- withCORSConfig(CORSConfig) - Method in class io.muserver.handlers.CORSHandlerBuilder
-
Sets the CORS configuration for the handler
- withCORSConfig(CORSConfigBuilder) - Method in class io.muserver.handlers.CORSHandlerBuilder
-
Sets the CORS configuration for the handler
- withDefaultFile(String) - Method in class io.muserver.handlers.ResourceHandler.Builder
-
- 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
-
- withDirectoryListing(boolean) - Method in class io.muserver.handlers.ResourceHandlerBuilder
-
Specifies whether or not to allow directory listing.
- withDirectoryListingCSS(String) - Method in class io.muserver.handlers.ResourceHandlerBuilder
-
Specifies CSS to use for the HTML directory listing page, if directory listing is enabled.
- withDirectoryListingDateFormatter(DateTimeFormatter) - Method in class io.muserver.handlers.ResourceHandlerBuilder
-
Specifies a custom date format for the "Last modified" column when directory listing is enabled.
- withDiscriminator(DiscriminatorObject) - Method in class io.muserver.openapi.SchemaObjectBuilder
-
- withDocumentation() - Method in class io.muserver.rest.RestHandlerBuilder
-
- withDomain(String) - Method in class io.muserver.CookieBuilder
-
Sets the host that clients should send the cookie over.
- withEmail(String) - Method in class io.muserver.openapi.ContactObjectBuilder
-
- withEncoding(Map<String, EncodingObject>) - Method in class io.muserver.openapi.MediaTypeObjectBuilder
-
- withEnumValue(List<Object>) - Method in class io.muserver.openapi.SchemaObjectBuilder
-
- withEnumValues(List<String>) - Method in class io.muserver.openapi.ServerVariableObjectBuilder
-
- withExample(Object) - Method in class io.muserver.openapi.HeaderObjectBuilder
-
- withExample(Object) - Method in class io.muserver.openapi.MediaTypeObjectBuilder
-
- withExample(Object) - Method in class io.muserver.openapi.ParameterObjectBuilder
-
- withExample(Object) - Method in class io.muserver.openapi.SchemaObjectBuilder
-
- withExamples(Map<String, ExampleObject>) - Method in class io.muserver.openapi.ComponentsObjectBuilder
-
- withExamples(Map<String, ExampleObject>) - Method in class io.muserver.openapi.HeaderObjectBuilder
-
- withExamples(Map<String, ExampleObject>) - Method in class io.muserver.openapi.MediaTypeObjectBuilder
-
- withExamples(Map<String, ExampleObject>) - Method in class io.muserver.openapi.ParameterObjectBuilder
-
- 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 (aside from "simple" headers) are allowed to be accessed by JavaScript in responses.
- withExposedHeaders(Collection<String>) - Method in class io.muserver.rest.CORSConfigBuilder
-
Specifies which headers (aside from "simple" headers) are allowed to be accessed by JavaScript in responses.
- withExtensionToResourceType(Map<String, ResourceType>) - Method in class io.muserver.handlers.ResourceHandler.Builder
-
- 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.
- withHandlerExecutor(ExecutorService) - Method in class io.muserver.MuServerBuilder
-
Sets the thread executor service to run requests on.
- withHeaders(Map<String, HeaderObject>) - Method in class io.muserver.openapi.ComponentsObjectBuilder
-
- withHeaders(Map<String, HeaderObject>) - Method in class io.muserver.openapi.EncodingObjectBuilder
-
- withHeaders(Map<String, HeaderObject>) - Method in class io.muserver.openapi.ResponseObjectBuilder
-
- withHSTSExpireTime(int, TimeUnit) - Method in class io.muserver.handlers.HttpsRedirectorBuilder
-
If set to a positive number, this will add a Strict-Transport-Security
header to all HTTPS
responses to indicate that clients should always use HTTPS to access this server.
- withHSTSPreload(boolean) - Method in class io.muserver.handlers.HttpsRedirectorBuilder
-
Specifies that this website can be added to the HSTS preload lists.
- withHttp2Config(Http2Config) - Method in class io.muserver.MuServerBuilder
-
Sets the configuration for HTTP2
- withHttp2Config(Http2ConfigBuilder) - Method in class io.muserver.MuServerBuilder
-
Sets the configuration for HTTP2
- withHttpConnection(int) - Method in class io.muserver.MuServerBuilder
-
- withHttpDisabled() - Method in class io.muserver.MuServerBuilder
-
- withHttpPort(int) - Method in class io.muserver.MuServerBuilder
-
- withHttpsConfig(SSLContext) - Method in class io.muserver.MuServerBuilder
-
- withHttpsConfig(SSLContextBuilder) - Method in class io.muserver.MuServerBuilder
-
- withHttpsConfig(HttpsConfigBuilder) - Method in class io.muserver.MuServerBuilder
-
Sets the HTTPS config.
- withHttpsConnection(int, SSLContext) - Method in class io.muserver.MuServerBuilder
-
- withHttpsPort(int) - Method in class io.muserver.MuServerBuilder
-
Sets the HTTPS port to use.
- withHttpStatusCodes(Map<String, ResponseObject>) - Method in class io.muserver.openapi.ResponsesObjectBuilder
-
- withIdleReadTimeout(long, TimeUnit) - Method in class io.muserver.WebSocketHandlerBuilder
-
Sets the idle timeout.
- withIdleTimeout(long, TimeUnit) - Method in class io.muserver.MuServerBuilder
-
Sets the idle timeout for requests and responses.
- withImplicit(OAuthFlowObject) - Method in class io.muserver.openapi.OAuthFlowsObjectBuilder
-
- withIn(String) - Method in class io.muserver.openapi.ParameterObjectBuilder
-
- withIn(String) - Method in class io.muserver.openapi.SecuritySchemeObjectBuilder
-
- withInfo(InfoObject) - Method in class io.muserver.openapi.OpenAPIObjectBuilder
-
- withInterface(String) - Method in class io.muserver.MuServerBuilder
-
Use this to specify which network interface to bind to.
- withItems(SchemaObject) - Method in class io.muserver.openapi.SchemaObjectBuilder
-
- withKeyManagerFactory(KeyManagerFactory) - Method in class io.muserver.HttpsConfigBuilder
-
Sets the key manager factory to use for SSL.
- withKeyManagerFactory(KeyManagerFactory) - Method in class io.muserver.SSLContextBuilder
-
Deprecated.
Sets the key manager factory to use for SSL.
- withKeyPassword(String) - Method in class io.muserver.HttpsConfigBuilder
-
- withKeyPassword(char[]) - Method in class io.muserver.HttpsConfigBuilder
-
- withKeyPassword(String) - Method in class io.muserver.SSLContextBuilder
-
Deprecated.
- withKeyPassword(char[]) - Method in class io.muserver.SSLContextBuilder
-
Deprecated.
- withKeystore(InputStream) - Method in class io.muserver.HttpsConfigBuilder
-
Loads a keystore from the given stream.
- withKeystore(File) - Method in class io.muserver.HttpsConfigBuilder
-
- withKeystore(InputStream) - Method in class io.muserver.SSLContextBuilder
-
Deprecated.
Loads a keystore from the given stream.
- withKeystore(File) - Method in class io.muserver.SSLContextBuilder
-
Deprecated.
- withKeystoreFromClasspath(String) - Method in class io.muserver.HttpsConfigBuilder
-
Loads a keystore from the classpath
- withKeystoreFromClasspath(String) - Method in class io.muserver.SSLContextBuilder
-
Deprecated.
Loads a keystore from the classpath
- withKeystorePassword(String) - Method in class io.muserver.HttpsConfigBuilder
-
- withKeystorePassword(char[]) - Method in class io.muserver.HttpsConfigBuilder
-
- withKeystorePassword(String) - Method in class io.muserver.SSLContextBuilder
-
Deprecated.
- withKeystorePassword(char[]) - Method in class io.muserver.SSLContextBuilder
-
Deprecated.
- withKeystoreType(String) - Method in class io.muserver.HttpsConfigBuilder
-
- withKeystoreType(String) - Method in class io.muserver.SSLContextBuilder
-
Deprecated.
- withLicense(LicenseObject) - Method in class io.muserver.openapi.InfoObjectBuilder
-
- withLinks(Map<String, LinkObject>) - Method in class io.muserver.openapi.ComponentsObjectBuilder
-
- withLinks(Map<String, LinkObject>) - Method in class io.muserver.openapi.ResponseObjectBuilder
-
- withLocalhostAllowed() - Method in class io.muserver.rest.CORSConfigBuilder
-
Adds all localhost URLs (whether http or https) as allowed origins.
- withMapping(Map<String, String>) - Method in class io.muserver.openapi.DiscriminatorObjectBuilder
-
- withMaxAge(long) - Method in class io.muserver.rest.CORSConfigBuilder
-
On preflight OPTIONS requests, specifies the time the response is valid for
- withMaxAgeInSeconds(long) - Method in class io.muserver.CookieBuilder
-
Specifies how long the cookie will last for.
- withMaxFramePayloadLength(int) - Method in class io.muserver.WebSocketHandlerBuilder
-
Sets the maximum size in bytes that a frame can be.
- withMaxHeadersSize(int) - Method in class io.muserver.MuServerBuilder
-
Specifies the maximum size in bytes of the HTTP request headers.
- withMaximum(Double) - Method in class io.muserver.openapi.SchemaObjectBuilder
-
- withMaxItems(Integer) - Method in class io.muserver.openapi.SchemaObjectBuilder
-
- withMaxLength(Integer) - Method in class io.muserver.openapi.SchemaObjectBuilder
-
- withMaxProperties(Integer) - Method in class io.muserver.openapi.SchemaObjectBuilder
-
- withMaxRequestSize(long) - Method in class io.muserver.MuServerBuilder
-
The maximum allowed request body size.
- withMaxUrlSize(int) - Method in class io.muserver.MuServerBuilder
-
The maximum length that a URL can be.
- withMinimum(Double) - Method in class io.muserver.openapi.SchemaObjectBuilder
-
- withMinItems(Integer) - Method in class io.muserver.openapi.SchemaObjectBuilder
-
- withMinLength(Integer) - Method in class io.muserver.openapi.SchemaObjectBuilder
-
- withMinProperties(Integer) - Method in class io.muserver.openapi.SchemaObjectBuilder
-
- withMultipleOf(Double) - Method in class io.muserver.openapi.SchemaObjectBuilder
-
- withName(String) - Method in class io.muserver.CookieBuilder
-
Sets the name of the cookie.
- withName(String) - Method in class io.muserver.openapi.ContactObjectBuilder
-
- withName(String) - Method in class io.muserver.openapi.LicenseObjectBuilder
-
- withName(String) - Method in class io.muserver.openapi.ParameterObjectBuilder
-
- withName(String) - Method in class io.muserver.openapi.SecuritySchemeObjectBuilder
-
- withName(String) - Method in class io.muserver.openapi.TagObjectBuilder
-
- withName(String) - Method in class io.muserver.openapi.XmlObjectBuilder
-
- withNamespace(URI) - Method in class io.muserver.openapi.XmlObjectBuilder
-
- 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
-
- 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.
- withPath(String) - Method in class io.muserver.CookieBuilder
-
Sets the path prefix that the cookie will be sent with, or null to send to all paths.
- withPath(String) - Method in class io.muserver.WebSocketHandlerBuilder
-
Sets the path to listen on for this handler.
- withPathItemObjects(Map<String, PathItemObject>) - Method in class io.muserver.openapi.PathsObjectBuilder
-
- withPaths(PathsObject) - Method in class io.muserver.openapi.OpenAPIObjectBuilder
-
- withPathToServeFrom(String) - Method in class io.muserver.handlers.ResourceHandler.Builder
-
- withPathToServeFrom(String) - Method in class io.muserver.handlers.ResourceHandlerBuilder
-
- withPattern(Pattern) - Method in class io.muserver.openapi.SchemaObjectBuilder
-
- withPingSentAfterNoWritesFor(int, TimeUnit) - Method in class io.muserver.WebSocketHandlerBuilder
-
Sets the amount of time to wait before sending a ping message if no messages having been sent.
- withPort(int) - Method in class io.muserver.handlers.HttpsRedirectorBuilder
-
Sets the port to redirect HTTP requests to, for example 443
- withPrefix(String) - Method in class io.muserver.openapi.XmlObjectBuilder
-
- withProperties(Map<String, SchemaObject>) - Method in class io.muserver.openapi.SchemaObjectBuilder
-
- withPropertyName(String) - Method in class io.muserver.openapi.DiscriminatorObjectBuilder
-
- withProtocols(String...) - Method in class io.muserver.HttpsConfigBuilder
-
Sets the SSL/TLS protocols to use, for example "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2", "TLSv1.3".
- withProtocols(String...) - Method in class io.muserver.SSLContextBuilder
-
Deprecated.
Sets the SSL/TLS protocols to use, for example "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2", "TLSv1.3".
- withRate(long) - Method in class io.muserver.RateLimitBuilder
-
Sets the allowed rate.
- withRateLimiter(RateLimitSelector) - Method in class io.muserver.MuServerBuilder
-
Adds a rate limiter to incoming requests.
- withReadOnly(Boolean) - Method in class io.muserver.openapi.SchemaObjectBuilder
-
- withRefreshUrl(URI) - Method in class io.muserver.openapi.OAuthFlowObjectBuilder
-
- withRejectionAction(RateLimitRejectionAction) - Method in class io.muserver.RateLimitBuilder
-
Specifies what to do when this limit is breached.
- withRequestBodies(Map<String, RequestBodyObject>) - Method in class io.muserver.openapi.ComponentsObjectBuilder
-
- withRequestBody(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
-
- withUrlEncodedValue(String) - Method in class io.muserver.CookieBuilder
-
Sets the value of the cookie by URL Encoding the given value.
- withValue(String) - Method in class io.muserver.CookieBuilder
-
Sets the value of the cookie.
- 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
-
- withWebSocketFactory(MuWebSocketFactory) - Method in class io.muserver.WebSocketHandlerBuilder
-
Sets the factory that decides whether to create a websocket connection for a request.
- withWindow(long, TimeUnit) - Method in class io.muserver.RateLimitBuilder
-
The period that the limit applies to.
- withWrapped(boolean) - Method in class io.muserver.openapi.XmlObjectBuilder
-
- withWriteOnly(Boolean) - Method in class io.muserver.openapi.SchemaObjectBuilder
-
- withXml(XmlObject) - Method in class io.muserver.openapi.SchemaObjectBuilder
-
- wrapped - Variable in class io.muserver.openapi.XmlObject
-
- write(ByteBuffer, WriteCallback) - Method in interface io.muserver.AsyncHandle
-
- write(ByteBuffer, DoneCallback) - 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
-
- WriteCallback - Interface in io.muserver
-
- writeHeaders(MuRequest, MuResponse, Set<Method>) - Method in class io.muserver.rest.CORSConfig
-
Adds CORS headers to the response, if neeeded.
- 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"