Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- allowCredentials() - Element in annotation interface io.micronaut.http.server.cors.CrossOrigin
- allowedHeaders() - Element in annotation interface io.micronaut.http.server.cors.CrossOrigin
- allowedMethods() - Element in annotation interface io.micronaut.http.server.cors.CrossOrigin
- allowedOrigins() - Element in annotation interface io.micronaut.http.server.cors.CrossOrigin
- allowedOriginsRegex() - Element in annotation interface io.micronaut.http.server.cors.CrossOrigin
- allowPrivateNetwork() - Element in annotation interface io.micronaut.http.server.cors.CrossOrigin
- ANY - Static variable in class io.micronaut.http.server.cors.CorsOriginConfiguration
-
Constant to represent any value.
- ANY_METHOD - Static variable in class io.micronaut.http.server.cors.CorsOriginConfiguration
-
Constant to represent any method.
- argument() - Method in record class io.micronaut.http.server.multipart.FormRouteCompleter.SubscriptionMetadata
-
Returns the value of the
argumentrecord component. - argumentType() - Method in class io.micronaut.http.server.binding.BasicAuthArgumentBinder
- argumentType() - Method in class io.micronaut.http.server.binding.LocaleArgumentBinder
- argumentType() - Method in class io.micronaut.http.server.binding.RawFormFieldArgumentBinder
- ASYNC - Enum constant in enum class io.micronaut.http.server.multipart.FormRouteCompleter.SubscriptionMode
-
This parameter does not need to be waited for the route to execute, but at the same time, the parameter will not be consumed until the route does execute.
- ASYNC_NO_BACKPRESSURE - Enum constant in enum class io.micronaut.http.server.multipart.FormRouteCompleter.SubscriptionMode
-
This parameter does not need to be waited for the route to execute, and it applies no backpressure, meaning it won't block other fields.
- attach() - Method in class io.micronaut.http.server.types.files.SystemFile
-
Sets the file to be downloaded as an attachment.
- attach(String) - Method in class io.micronaut.http.server.types.files.StreamedFile
-
Sets the file to be downloaded as an attachment.
- attach(String) - Method in class io.micronaut.http.server.types.files.SystemFile
-
Sets the file to be downloaded as an attachment.
- ATTACHMENT_HEADER - Static variable in interface io.micronaut.http.server.types.files.FileCustomizableResponseType
-
Deprecated.Unused now, please follow RFC 6266
B
- BasicAuthArgumentBinder - Class in io.micronaut.http.server.binding
-
Responsible for binding to a
BasicAuthargument from the authorization header in the request. - BasicAuthArgumentBinder() - Constructor for class io.micronaut.http.server.binding.BasicAuthArgumentBinder
- bind(ArgumentConversionContext, HttpRequest) - Method in class io.micronaut.http.server.binding.BasicAuthArgumentBinder
- bind(ArgumentConversionContext, HttpRequest) - Method in class io.micronaut.http.server.binding.RawFormFieldArgumentBinder
- bind(ArgumentConversionContext, HttpRequest) - Method in class io.micronaut.http.server.binding.LocaleArgumentBinder
- body(ErrorContext, HttpResponse) - Method in interface io.micronaut.http.server.exceptions.response.ErrorResponseBodyProvider
- BufferLengthExceededHandler - Class in io.micronaut.http.server.exceptions
-
Default handler for
BufferLengthExceededExceptionerrors. - BufferLengthExceededHandler(ErrorResponseProcessor) - Constructor for class io.micronaut.http.server.exceptions.BufferLengthExceededHandler
-
Constructor.
- build() - Method in interface io.micronaut.http.server.exceptions.response.ErrorContext.Builder
-
Builds the context.
- builder(HttpRequest) - Static method in interface io.micronaut.http.server.exceptions.response.ErrorContext
-
Create a new context builder.
C
- CacheControlConfiguration() - Constructor for class io.micronaut.http.server.HttpServerConfiguration.FileTypeHandlerConfiguration.CacheControlConfiguration
- cause(Throwable) - Method in interface io.micronaut.http.server.exceptions.response.ErrorContext.Builder
-
Sets the root cause of the error(s).
- completeAttribute(FormCapableHttpRequest, RawFormField) - Method in class io.micronaut.http.server.multipart.FormFactory
-
Asynchronously buffer the given attribute.
- completeFileUpload(FormCapableHttpRequest, RawFormField) - Method in class io.micronaut.http.server.multipart.FormFactory
-
Buffer a streamed
RawFormFieldinto aCompletedFileUpload. - completePart(FormCapableHttpRequest, RawFormField) - Method in class io.micronaut.http.server.multipart.FormFactory
-
Asynchronously buffer the given field.
- CompositeHttpLocaleResolver - Class in io.micronaut.http.server.util.locale
- CompositeHttpLocaleResolver(HttpLocaleResolver[], HttpLocaleResolutionConfiguration) - Constructor for class io.micronaut.http.server.util.locale.CompositeHttpLocaleResolver
- concatenate(Publisher) - Method in class io.micronaut.http.server.ResponseLifecycle
- concatenateJson(Publisher) - Method in class io.micronaut.http.server.ResponseLifecycle
- configuration - Variable in class io.micronaut.http.server.body.InputStreamBodyWriter
- configuration - Variable in class io.micronaut.http.server.body.StreamFileBodyWriter
- configuration - Variable in class io.micronaut.http.server.body.SystemFileBodyWriter
- CONFIGURATION_QUALIFIER - Static variable in class io.micronaut.http.server.codec.TextStreamCodec
-
Deprecated.
- ContentLengthExceededHandler - Class in io.micronaut.http.server.exceptions
-
Default handler for
ContentLengthExceededExceptionerrors. - ContentLengthExceededHandler(ErrorResponseProcessor) - Constructor for class io.micronaut.http.server.exceptions.ContentLengthExceededHandler
-
Constructor.
- contentType() - Method in interface io.micronaut.http.server.exceptions.response.ErrorResponseBodyProvider
- contentType() - Method in interface io.micronaut.http.server.exceptions.response.HtmlErrorResponseBodyProvider
- contentType() - Method in interface io.micronaut.http.server.exceptions.response.JsonErrorResponseBodyProvider
- ConversionErrorHandler - Class in io.micronaut.http.server.exceptions
-
Handles exception of type
ConversionErrorException. - ConversionErrorHandler(ErrorResponseProcessor) - Constructor for class io.micronaut.http.server.exceptions.ConversionErrorHandler
-
Constructor.
- convert(Map, Class, ConversionContext) - Method in class io.micronaut.http.server.cors.CorsOriginConverter
- CookieLocaleResolver - Class in io.micronaut.http.server.util.locale
-
Resolves the Locale from a Cookie within an HTTP Request.
- CookieLocaleResolver(HttpLocaleResolutionConfiguration) - Constructor for class io.micronaut.http.server.util.locale.CookieLocaleResolver
- CookieSizeExceededHandler - Class in io.micronaut.http.server.exceptions
-
Default handler for
CookieSizeExceededExceptionerrors. - CookieSizeExceededHandler(ErrorResponseProcessor) - Constructor for class io.micronaut.http.server.exceptions.CookieSizeExceededHandler
-
Constructor.
- CoroutineHelper - Class in io.micronaut.http.server
-
Coroutines helper.
- CORS_FILTER_ORDER - Static variable in class io.micronaut.http.server.cors.CorsFilter
- corsConfiguration - Variable in class io.micronaut.http.server.cors.CorsFilter
- CorsConfiguration() - Constructor for class io.micronaut.http.server.HttpServerConfiguration.CorsConfiguration
- CorsFilter - Class in io.micronaut.http.server.cors
-
Responsible for handling CORS requests and responses.
- CorsFilter(HttpServerConfiguration.CorsConfiguration, StaticResourceResolver, Router, HttpHostResolver) - Constructor for class io.micronaut.http.server.cors.CorsFilter
- CorsOriginConfiguration - Class in io.micronaut.http.server.cors
-
Stores configuration for CORS.
- CorsOriginConfiguration() - Constructor for class io.micronaut.http.server.cors.CorsOriginConfiguration
- CorsOriginConverter - Class in io.micronaut.http.server.cors
-
Responsible for converting a map of configuration to an instance of
CorsOriginConfiguration. - CorsOriginConverter() - Constructor for class io.micronaut.http.server.cors.CorsOriginConverter
- CorsUtil - Class in io.micronaut.http.server.cors
-
Utility methods for CORS.
- createDefaultErrorResponse(HttpRequest, Throwable) - Method in class io.micronaut.http.server.RouteExecutor
-
Creates a default error response.
- createResponse(CookieSizeExceededException) - Method in class io.micronaut.http.server.exceptions.CookieSizeExceededHandler
- createResponse(BufferLengthExceededException) - Method in class io.micronaut.http.server.exceptions.BufferLengthExceededHandler
- createResponse(ContentLengthExceededException) - Method in class io.micronaut.http.server.exceptions.ContentLengthExceededHandler
- createResponse(HttpStatusException) - Method in class io.micronaut.http.server.exceptions.HttpStatusHandler
- createResponse(NotAllowedException) - Method in class io.micronaut.http.server.exceptions.NotAllowedExceptionHandler
- createResponse(DuplicateRouteException) - Method in class io.micronaut.http.server.exceptions.DuplicateRouteHandler
- createResponse(T) - Method in class io.micronaut.http.server.exceptions.ErrorResponseProcessorExceptionHandler
- CrossOrigin - Annotation Interface in io.micronaut.http.server.cors
-
Support CORs configuration via annotation.
- CrossOriginUtil - Class in io.micronaut.http.server.cors
-
Utility classes to work with
CrossOrigin. - CustomizableResponseType - Interface in io.micronaut.http.server.types
-
A type that needs special handling that may include modification of the response.
D
- decode(Argument, InputStream) - Method in class io.micronaut.http.server.codec.TextStreamCodec
-
Deprecated.
- decode(Class, InputStream) - Method in class io.micronaut.http.server.codec.TextStreamCodec
-
Deprecated.
- DEFAULT_ALLOW_PRIVATE_NETWORK - Static variable in class io.micronaut.http.server.cors.CorsOriginConfiguration
-
Default value for allow private network.
- DEFAULT_CACHESECONDS - Static variable in class io.micronaut.http.server.HttpServerConfiguration.FileTypeHandlerConfiguration
-
The default cache seconds.
- DEFAULT_DATEHEADER - Static variable in class io.micronaut.http.server.HttpServerConfiguration
-
The default date header.
- DEFAULT_DISK - Static variable in class io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration
-
The default disk value.
- DEFAULT_DISPATCH_OPTIONS_REQUESTS - Static variable in class io.micronaut.http.server.HttpServerConfiguration
-
The default value whether to dispatch OPTIONS Requests.
- DEFAULT_DUAL_PROTOCOL - Static variable in class io.micronaut.http.server.HttpServerConfiguration
-
The default value for enabling dual protocol (http/https).
- DEFAULT_ENABLED - Static variable in class io.micronaut.http.server.HttpServerConfiguration.CorsConfiguration
- DEFAULT_ENABLED - Static variable in class io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration
-
The default enable value.
- DEFAULT_HTTP_TO_HTTPS_REDIRECT - Static variable in class io.micronaut.http.server.HttpServerConfiguration
-
The default value for redirect HTTP to HTTPS when using dual protocal.
- DEFAULT_IDLE_TIME_MINUTES - Static variable in class io.micronaut.http.server.HttpServerConfiguration
-
The default idle time.
- DEFAULT_LOCALHOST_PASS_THROUGH - Static variable in class io.micronaut.http.server.HttpServerConfiguration.CorsConfiguration
- DEFAULT_LOG_HANDLED_EXCEPTIONS - Static variable in class io.micronaut.http.server.HttpServerConfiguration
-
The default value for log handled exceptions.
- DEFAULT_MAX_FILE_SIZE - Static variable in class io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration
-
The default max file size.
- DEFAULT_MAX_PARAMS - Static variable in class io.micronaut.http.server.HttpServerConfiguration
- DEFAULT_MAX_REQUEST_BUFFER_SIZE - Static variable in class io.micronaut.http.server.HttpServerConfiguration
-
The default max buffer size.
- DEFAULT_MAX_REQUEST_SIZE - Static variable in class io.micronaut.http.server.HttpServerConfiguration
-
The default max request size.
- DEFAULT_MIXED - Static variable in class io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration
-
The default mixed value.
- DEFAULT_PORT - Static variable in class io.micronaut.http.server.HttpServerConfiguration
-
The default port value.
- DEFAULT_RANDOM_PORT - Static variable in class io.micronaut.http.server.HttpServerConfiguration
-
The default value random port.
- DEFAULT_READ_IDLE_TIME_MINUTES - Static variable in class io.micronaut.http.server.HttpServerConfiguration
-
The default read idle time in minutes.
- DEFAULT_SEMICOLON_IS_NORMAL_CHAR - Static variable in class io.micronaut.http.server.HttpServerConfiguration
- DEFAULT_SINGLE_HEADER - Static variable in class io.micronaut.http.server.HttpServerConfiguration.CorsConfiguration
- DEFAULT_THRESHOLD - Static variable in class io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration
-
The default threshold value.
- DEFAULT_WRITE_IDLE_TIME_MINUTES - Static variable in class io.micronaut.http.server.HttpServerConfiguration
-
The default write idle time in minutes.
- DefaultHttpClientAddressResolver - Class in io.micronaut.http.server.util
-
Default implementation of
HttpClientAddressResolver. - DefaultHttpClientAddressResolver(HttpServerConfiguration) - Constructor for class io.micronaut.http.server.util.DefaultHttpClientAddressResolver
- DefaultHttpHostResolver - Class in io.micronaut.http.server.util
-
Default implementation of
HttpHostResolver. - DefaultHttpHostResolver(HttpServerConfiguration, BeanProvider) - Constructor for class io.micronaut.http.server.util.DefaultHttpHostResolver
- DuplicateRouteHandler - Class in io.micronaut.http.server.exceptions
-
Handles exceptions of type
DuplicateRouteException. - DuplicateRouteHandler(ErrorResponseProcessor) - Constructor for class io.micronaut.http.server.exceptions.DuplicateRouteHandler
-
Constructor.
E
- encode(T) - Method in class io.micronaut.http.server.codec.TextStreamCodec
-
Deprecated.
- encode(T, ByteBufferFactory) - Method in class io.micronaut.http.server.codec.TextStreamCodec
-
Deprecated.
- encode(T, OutputStream) - Method in class io.micronaut.http.server.codec.TextStreamCodec
-
Deprecated.
- encodeHttpResponseSafe(HttpRequest, HttpResponse) - Method in class io.micronaut.http.server.ResponseLifecycle
-
Encode the response.
- encodeNoBody(HttpResponse) - Method in class io.micronaut.http.server.ResponseLifecycle
-
Encode the given response without body, either because it has none or because this is a HEAD response.
- equals(Object) - Method in record class io.micronaut.http.server.multipart.FormRouteCompleter.SubscriptionMetadata
-
Indicates whether some other object is "equal to" this one.
- error(UnsatisfiedArgumentException) - Method in class io.micronaut.http.server.exceptions.UnsatisfiedArgumentHandler
- error(ConversionErrorException) - Method in class io.micronaut.http.server.exceptions.ConversionErrorHandler
- error(Error) - Method in interface io.micronaut.http.server.exceptions.response.ErrorContext.Builder
-
Adds an error to the context.
- error(UnsatisfiedRouteException) - Method in class io.micronaut.http.server.exceptions.UnsatisfiedRouteHandler
- error(URISyntaxException) - Method in class io.micronaut.http.server.exceptions.URISyntaxHandler
- error(T) - Method in class io.micronaut.http.server.exceptions.ErrorExceptionHandler
- Error - Interface in io.micronaut.http.server.exceptions.response
-
Contains information about an error that occurred.
- ErrorContext - Interface in io.micronaut.http.server.exceptions.response
- ErrorContext.Builder - Interface in io.micronaut.http.server.exceptions.response
-
A builder for a
ErrorContext. - ErrorExceptionHandler<T> - Class in io.micronaut.http.server.exceptions
-
An abstract class to handle exceptions with an
Errorand responding a Bad Request HTTP Response via theErrorResponseProcessorAPI. - ErrorExceptionHandler(ErrorResponseProcessor) - Constructor for class io.micronaut.http.server.exceptions.ErrorExceptionHandler
-
Constructor.
- errorMessage(String) - Method in interface io.micronaut.http.server.exceptions.response.ErrorContext.Builder
-
Adds an error to the context for the given message.
- errorMessages(List) - Method in interface io.micronaut.http.server.exceptions.response.ErrorContext.Builder
-
Adds errors to the context for the given messages.
- ErrorResponseBodyProvider<T> - Interface in io.micronaut.http.server.exceptions.response
-
Provides an HTTP Response body of an error response.
- ErrorResponseProcessor<T> - Interface in io.micronaut.http.server.exceptions.response
-
Creates Http responses that represent errors.
- ErrorResponseProcessorExceptionHandler<T> - Class in io.micronaut.http.server.exceptions
-
An abstract class to handle exceptions via an HTTP Response and the
ErrorResponseProcessorAPI. - ErrorResponseProcessorExceptionHandler(ErrorResponseProcessor) - Constructor for class io.micronaut.http.server.exceptions.ErrorResponseProcessorExceptionHandler
-
Constructor.
- errors(List) - Method in interface io.micronaut.http.server.exceptions.response.ErrorContext.Builder
-
Adds the errors to the context.
- ExceptionHandler<T,
R> - Interface in io.micronaut.http.server.exceptions -
A generic hook for handling exceptions that occurs during the execution of an HTTP request.
- exposedHeaders() - Element in annotation interface io.micronaut.http.server.cors.CrossOrigin
F
- FileBodyWriter - Class in io.micronaut.http.server.body
-
Body writer for
Files. - FileBodyWriter(SystemFileBodyWriter) - Constructor for class io.micronaut.http.server.body.FileBodyWriter
- FileCustomizableResponseType - Interface in io.micronaut.http.server.types.files
-
A special type for file handling.
- FileTypeHandlerConfiguration() - Constructor for class io.micronaut.http.server.HttpServerConfiguration.FileTypeHandlerConfiguration
-
Default constructor.
- FilterBodyParser - Interface in io.micronaut.http.server.filter
-
API to parse a request body within a server filter.
- filterPreFlightRequest(HttpRequest) - Method in class io.micronaut.http.server.cors.CorsFilter
- filterRequest(HttpRequest) - Method in class io.micronaut.http.server.cors.CorsFilter
- filterResponse(HttpRequest, MutableHttpResponse) - Method in class io.micronaut.http.server.cors.CorsFilter
- filterResponse(HttpRequest, MutableHttpResponse) - Method in class io.micronaut.http.server.OptionsFilter
- findFile() - Method in class io.micronaut.http.server.RequestLifecycle
-
Deprecated, for removal: This API element is subject to removal in a future version.Will be removed after 4.3.0
- findFile(HttpRequest) - Method in class io.micronaut.http.server.RequestLifecycle
-
Try to find a static file for this request.
- FormBindingDeadlockException(FormRouteCompleter.SubscriptionMetadata, List) - Constructor for exception class io.micronaut.http.server.multipart.FormRouteCompleter.FormBindingDeadlockException
- FormFactory - Class in io.micronaut.http.server.multipart
-
Global utility class for form data access.
- FormRouteCompleter - Class in io.micronaut.http.server.multipart
-
This class distributes fields from
FormCapableHttpRequest.getRawFormFields()to different argument binders by name. - FormRouteCompleter.FormBindingDeadlockException - Exception Class in io.micronaut.http.server.multipart
-
Exception thrown when a form binding deadlock is detected.
- FormRouteCompleter.SubscriptionMetadata - Record Class in io.micronaut.http.server.multipart
-
Metadata for a form field subscription.
- FormRouteCompleter.SubscriptionMode - Enum Class in io.micronaut.http.server.multipart
-
Mode of subscription for form fields.
- fulfillArgumentRequirementsAfterFilters(RouteMatch, HttpRequest) - Method in class io.micronaut.http.server.binding.RequestArgumentSatisfier
-
Attempt to satisfy the arguments of the given route with the data from the given request.
- fulfillArgumentRequirementsBeforeFilters(RouteMatch, HttpRequest) - Method in class io.micronaut.http.server.binding.RequestArgumentSatisfier
-
Attempt to satisfy the arguments of the given route with the data from the given request.
- fulfillArguments(RouteMatch, HttpRequest) - Method in class io.micronaut.http.server.RequestLifecycle
-
Fulfill the arguments of the given route with data from the request.
G
- getAcceptableContentTypes() - Method in exception class io.micronaut.http.server.exceptions.UnsupportedMediaException
- getAcceptedTypes() - Method in exception class io.micronaut.http.server.exceptions.NotAcceptableException
- getAllowedHeaders() - Method in class io.micronaut.http.server.cors.CorsOriginConfiguration
- getAllowedHosts() - Method in class io.micronaut.http.server.HttpServerConfiguration.HostResolutionConfiguration
- getAllowedMethods() - Method in class io.micronaut.http.server.cors.CorsOriginConfiguration
- getAllowedMethods() - Method in exception class io.micronaut.http.server.exceptions.NotAllowedException
- getAllowedOrigins() - Method in class io.micronaut.http.server.cors.CorsOriginConfiguration
- getAllowedOriginsRegex() - Method in class io.micronaut.http.server.cors.CorsOriginConfiguration
- getApplicationConfiguration() - Method in class io.micronaut.http.server.HttpServerConfiguration
- getBinderRegistry() - Method in class io.micronaut.http.server.binding.RequestArgumentSatisfier
- getBy() - Method in class io.micronaut.http.server.util.ProxyHeaderParser
- getCacheControl() - Method in class io.micronaut.http.server.HttpServerConfiguration.FileTypeHandlerConfiguration
- getCacheSeconds() - Method in class io.micronaut.http.server.HttpServerConfiguration.FileTypeHandlerConfiguration
- getClientAddressHeader() - Method in class io.micronaut.http.server.HttpServerConfiguration
- getCompleterOrNull(HttpRequest) - Static method in class io.micronaut.http.server.multipart.FormFactory
-
Get the completer for the given request, if it has been created by
FormFactory.getOrCreateCompleter(HttpRequest). - getConfigurations() - Method in class io.micronaut.http.server.HttpServerConfiguration.CorsConfiguration
- getConfiguredHost(HttpRequest, HttpServerConfiguration.HostResolutionConfiguration) - Method in class io.micronaut.http.server.util.DefaultHttpHostResolver
- getConfiguredHost(HttpRequest, String, String, String, boolean) - Method in class io.micronaut.http.server.util.DefaultHttpHostResolver
- getContentType() - Method in exception class io.micronaut.http.server.exceptions.UnsupportedMediaException
- getContextPath() - Method in class io.micronaut.http.server.HttpServerConfiguration
- getCookieName() - Method in class io.micronaut.http.server.HttpServerConfiguration.HttpLocaleResolutionConfigurationProperties
- getCookieName() - Method in interface io.micronaut.http.server.util.locale.HttpLocaleResolutionConfiguration
- getCoroutineHelper() - Method in class io.micronaut.http.server.RouteExecutor
- getCors() - Method in class io.micronaut.http.server.HttpServerConfiguration
- getCorsOriginConfiguration(AnnotationMetadata) - Static method in class io.micronaut.http.server.cors.CrossOriginUtil
- getCorsOriginConfigurationForRequest(HttpRequest) - Static method in class io.micronaut.http.server.cors.CrossOriginUtil
- getDefaultCharset() - Method in class io.micronaut.http.server.HttpServerConfiguration
- getDefaultHost(HttpRequest) - Method in class io.micronaut.http.server.util.DefaultHttpHostResolver
- getDefaultLocale() - Method in class io.micronaut.http.server.HttpServerConfiguration.HttpLocaleResolutionConfigurationProperties
- getDiskWriteExecutor() - Method in class io.micronaut.http.server.multipart.FormFactory
- getEmbeddedHost() - Method in class io.micronaut.http.server.util.DefaultHttpHostResolver
- getEnabled() - Method in class io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration
-
The default multipart enabled setting is false for servlets, but effectively true for Netty.
- getErrorResponseProcessor() - Method in class io.micronaut.http.server.RouteExecutor
- getErrors() - Method in interface io.micronaut.http.server.exceptions.response.ErrorContext
- getExecutorSelector() - Method in class io.micronaut.http.server.RouteExecutor
- getExposedHeaders() - Method in class io.micronaut.http.server.cors.CorsOriginConfiguration
- getFile() - Method in class io.micronaut.http.server.types.files.SystemFile
- getFixed() - Method in class io.micronaut.http.server.HttpServerConfiguration.HttpLocaleResolutionConfigurationProperties
- getFor() - Method in class io.micronaut.http.server.util.ProxyHeaderParser
- getHost() - Method in class io.micronaut.http.server.HttpServerConfiguration
- getHost() - Method in class io.micronaut.http.server.util.ProxyHeaderParser
- getHostHeader() - Method in class io.micronaut.http.server.HttpServerConfiguration.HostResolutionConfiguration
- getHostResolution() - Method in class io.micronaut.http.server.HttpServerConfiguration
- getHttpVersion() - Method in class io.micronaut.http.server.HttpServerConfiguration
-
The HTTP version to use.
- getIdleTimeout() - Method in class io.micronaut.http.server.HttpServerConfiguration
- getInputStream() - Method in class io.micronaut.http.server.types.files.StreamedFile
- getLastModified() - Method in interface io.micronaut.http.server.types.files.FileCustomizableResponseType
- getLastModified() - Method in class io.micronaut.http.server.types.files.StreamedFile
- getLastModified() - Method in class io.micronaut.http.server.types.files.SystemFile
- getLength() - Method in interface io.micronaut.http.server.types.files.FileCustomizableResponseType
- getLength() - Method in class io.micronaut.http.server.types.files.StreamedFile
- getLength() - Method in class io.micronaut.http.server.types.files.SystemFile
- getLocale() - Method in class io.micronaut.http.server.util.locale.HttpLocalizedMessageSource
- getLocaleResolution() - Method in class io.micronaut.http.server.HttpServerConfiguration
- getLocation() - Method in class io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration
- getMaxAge() - Method in class io.micronaut.http.server.cors.CorsOriginConfiguration
- getMaxFileSize() - Method in class io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration
- getMaxParams() - Method in class io.micronaut.http.server.HttpServerConfiguration
- getMaxRequestBufferSize() - Method in class io.micronaut.http.server.HttpServerConfiguration
- getMaxRequestSize() - Method in class io.micronaut.http.server.HttpServerConfiguration
- getMediaType() - Method in class io.micronaut.http.server.types.files.StreamedFile
- getMediaType() - Method in class io.micronaut.http.server.types.files.SystemFile
- getMediaTypes() - Method in class io.micronaut.http.server.codec.TextStreamCodec
-
Deprecated.
- getMessage() - Method in interface io.micronaut.http.server.exceptions.response.Error
- getMultipart() - Method in class io.micronaut.http.server.HttpServerConfiguration
- getOrCreateCompleter(HttpRequest) - Method in class io.micronaut.http.server.multipart.FormFactory
-
Create the completer for the given request if necessary.
- getOrder() - Method in class io.micronaut.http.server.cors.CorsFilter
- getOrder() - Method in class io.micronaut.http.server.OptionsFilter
- getOrder() - Method in class io.micronaut.http.server.util.locale.HttpAbstractLocaleResolver
- getOrder() - Method in class io.micronaut.http.server.util.locale.HttpFixedLocaleResolver
- getOrder() - Method in class io.micronaut.http.server.util.locale.RequestLocaleResolver
- getPath() - Method in interface io.micronaut.http.server.exceptions.response.Error
- getPort() - Method in class io.micronaut.http.server.HttpServerConfiguration
- getPort() - Method in class io.micronaut.http.server.util.ProxyHeaderParser
- getPortHeader() - Method in class io.micronaut.http.server.HttpServerConfiguration.HostResolutionConfiguration
- getProduceableContentTypes() - Method in exception class io.micronaut.http.server.exceptions.NotAcceptableException
- getProtocolHeader() - Method in class io.micronaut.http.server.HttpServerConfiguration.HostResolutionConfiguration
- getPublic() - Method in class io.micronaut.http.server.HttpServerConfiguration.FileTypeHandlerConfiguration.CacheControlConfiguration
- getReadIdleTimeout() - Method in class io.micronaut.http.server.HttpServerConfiguration
- getReadTimeout() - Method in class io.micronaut.http.server.HttpServerConfiguration
-
Deprecated.This setting does nothing
- getRequest() - Method in interface io.micronaut.http.server.exceptions.response.ErrorContext
- getRequestArgumentSatisfier() - Method in class io.micronaut.http.server.RouteExecutor
- getRequestMethod() - Method in exception class io.micronaut.http.server.exceptions.NotAllowedException
- getRootCause() - Method in interface io.micronaut.http.server.exceptions.response.ErrorContext
- getRouter() - Method in class io.micronaut.http.server.RouteExecutor
- getScheme() - Method in class io.micronaut.http.server.util.ProxyHeaderParser
- getServerHeader() - Method in class io.micronaut.http.server.HttpServerConfiguration
- getSessionAttribute() - Method in class io.micronaut.http.server.HttpServerConfiguration.HttpLocaleResolutionConfigurationProperties
- getSessionAttribute() - Method in interface io.micronaut.http.server.util.locale.HttpLocaleResolutionConfiguration
- getThreadSelection() - Method in class io.micronaut.http.server.HttpServerConfiguration
- getThreshold() - Method in class io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration
- getTitle() - Method in interface io.micronaut.http.server.exceptions.response.Error
- getUri() - Method in exception class io.micronaut.http.server.exceptions.NotAllowedException
- getWriteIdleTimeout() - Method in class io.micronaut.http.server.HttpServerConfiguration
H
- handle(HttpRequest, JacksonException) - Method in class io.micronaut.http.server.exceptions.JacksonExceptionHandler
- handle(HttpRequest, JsonSyntaxException) - Method in class io.micronaut.http.server.exceptions.JsonExceptionHandler
- handle(HttpRequest, HttpStatusException) - Method in class io.micronaut.http.server.exceptions.HttpStatusHandler
- handle(HttpRequest, T) - Method in class io.micronaut.http.server.exceptions.ErrorExceptionHandler
- handle(HttpRequest, T) - Method in class io.micronaut.http.server.exceptions.ErrorResponseProcessorExceptionHandler
- handle(HttpRequest, T) - Method in interface io.micronaut.http.server.exceptions.ExceptionHandler
-
Handles an exception and returns the result.
- handleIfModifiedAndHeaders(HttpRequest, MutableHttpResponse, FileCustomizableResponseType, MutableHttpResponse) - Method in class io.micronaut.http.server.body.InputStreamBodyWriter
- handleIfModifiedAndHeaders(HttpRequest, MutableHttpResponse, FileCustomizableResponseType, MutableHttpResponse) - Method in class io.micronaut.http.server.body.StreamFileBodyWriter
- handleIfModifiedAndHeaders(HttpRequest, MutableHttpResponse, FileCustomizableResponseType, MutableHttpResponse) - Method in class io.micronaut.http.server.body.SystemFileBodyWriter
- handleStreamingError(HttpRequest, Throwable) - Method in class io.micronaut.http.server.ResponseLifecycle
-
Handle an error that happened before the first item of a streaming response.
- hasErrors() - Method in interface io.micronaut.http.server.exceptions.response.ErrorContext
- hashCode() - Method in record class io.micronaut.http.server.multipart.FormRouteCompleter.SubscriptionMetadata
-
Returns a hash code value for this object.
- HateoasErrorResponseProcessor - Class in io.micronaut.http.server.exceptions.response
-
Deprecated, for removal: This API element is subject to removal in a future version.use
DefaultErrorResponseProcessorinstead - HateoasErrorResponseProcessor(JsonConfiguration) - Constructor for class io.micronaut.http.server.exceptions.response.HateoasErrorResponseProcessor
-
Deprecated.
- headersConfigured() - Method in class io.micronaut.http.server.HttpServerConfiguration.HostResolutionConfiguration
- HostResolutionConfiguration() - Constructor for class io.micronaut.http.server.HttpServerConfiguration.HostResolutionConfiguration
- HtmlErrorResponseBodyProvider - Interface in io.micronaut.http.server.exceptions.response
-
A
ErrorResponseBodyProviderfor HTML responses. - HttpAbstractLocaleResolver - Class in io.micronaut.http.server.util.locale
-
Provides an abstract class which implements
LocaleResolverand handles default locale resolution. - HttpAbstractLocaleResolver(HttpLocaleResolutionConfiguration) - Constructor for class io.micronaut.http.server.util.locale.HttpAbstractLocaleResolver
- HttpClientAddressResolver - Interface in io.micronaut.http.server.util
-
Resolves the client IP address from the request.
- HttpFixedLocaleResolver - Class in io.micronaut.http.server.util.locale
-
Generic implementation of
LocaleResolverfor fixed locale resolution. - HttpFixedLocaleResolver(HttpLocaleResolutionConfiguration) - Constructor for class io.micronaut.http.server.util.locale.HttpFixedLocaleResolver
- HttpHostResolver - Interface in io.micronaut.http.server.util
-
Resolves the host name of the current server.
- httpLocaleResolutionConfiguration - Variable in class io.micronaut.http.server.util.locale.HttpAbstractLocaleResolver
- HttpLocaleResolutionConfiguration - Interface in io.micronaut.http.server.util.locale
-
Configuration for Locale Resolution in a HTTP Request.
- HttpLocaleResolutionConfigurationProperties() - Constructor for class io.micronaut.http.server.HttpServerConfiguration.HttpLocaleResolutionConfigurationProperties
- HttpLocaleResolver - Interface in io.micronaut.http.server.util.locale
-
Responsible for determining the current locale from a request.
- HttpLocalizedMessageSource - Class in io.micronaut.http.server.util.locale
-
A
RequestScopewhich uses the currentHttpRequestto resolve the locale and hence return the localized messages. - HttpLocalizedMessageSource(LocaleResolver, MessageSource) - Constructor for class io.micronaut.http.server.util.locale.HttpLocalizedMessageSource
- HttpServerConfiguration - Class in io.micronaut.http.server
-
A base
ConfigurationPropertiesfor servers. - HttpServerConfiguration() - Constructor for class io.micronaut.http.server.HttpServerConfiguration
-
Default constructor.
- HttpServerConfiguration(ApplicationConfiguration) - Constructor for class io.micronaut.http.server.HttpServerConfiguration
- HttpServerConfiguration.CorsConfiguration - Class in io.micronaut.http.server
-
Configuration for CORS.
- HttpServerConfiguration.FileTypeHandlerConfiguration - Class in io.micronaut.http.server
-
Allows configuration of properties for the.
invalid reference
io.micronaut.http.server.netty.body.AbstractFileBodyWriter - HttpServerConfiguration.FileTypeHandlerConfiguration.CacheControlConfiguration - Class in io.micronaut.http.server
-
Configuration for the Cache-Control header.
- HttpServerConfiguration.HostResolutionConfiguration - Class in io.micronaut.http.server
-
Configuration for host resolution with the
HttpHostResolver. - HttpServerConfiguration.HttpLocaleResolutionConfigurationProperties - Class in io.micronaut.http.server
-
Configuration for locale resolution used by
HttpLocaleResolver. - HttpServerConfiguration.MultipartConfiguration - Class in io.micronaut.http.server
-
Configuration for multipart handling.
- HttpServerException - Exception Class in io.micronaut.http.server.exceptions
-
Exceptions related to the HTTP server.
- HttpServerException(String) - Constructor for exception class io.micronaut.http.server.exceptions.HttpServerException
- HttpServerException(String, Throwable) - Constructor for exception class io.micronaut.http.server.exceptions.HttpServerException
- HttpServerTypeConvertersRegistrar - Class in io.micronaut.http.server
-
The HTTP server type converters registrar.
- HttpServerTypeConvertersRegistrar() - Constructor for class io.micronaut.http.server.HttpServerTypeConvertersRegistrar
- HttpStatusHandler - Class in io.micronaut.http.server.exceptions
-
Handles exception of type
HttpStatusException. - HttpStatusHandler(ErrorResponseProcessor) - Constructor for class io.micronaut.http.server.exceptions.HttpStatusHandler
-
Constructor.
I
- InputStreamBodyWriter - Class in io.micronaut.http.server.body
-
Body writer for
InputStreams. - InternalServerException - Exception Class in io.micronaut.http.server.exceptions
-
Thrown for an unrecoverable server exceptions.
- InternalServerException(String) - Constructor for exception class io.micronaut.http.server.exceptions.InternalServerException
- InternalServerException(String, Throwable) - Constructor for exception class io.micronaut.http.server.exceptions.InternalServerException
- io.micronaut.http.server - package io.micronaut.http.server
-
HTTP server configuration.
- io.micronaut.http.server.annotation - package io.micronaut.http.server.annotation
- io.micronaut.http.server.binding - package io.micronaut.http.server.binding
-
HTTP server request binding.
- io.micronaut.http.server.body - package io.micronaut.http.server.body
-
HTTP server body writers.
- io.micronaut.http.server.codec - package io.micronaut.http.server.codec
-
HTTP encoders.
- io.micronaut.http.server.cors - package io.micronaut.http.server.cors
-
Contains classes specific to CORS support within Micronaut.
- io.micronaut.http.server.exceptions - package io.micronaut.http.server.exceptions
-
HTTP server exceptions.
- io.micronaut.http.server.exceptions.response - package io.micronaut.http.server.exceptions.response
-
HTTP server response exceptions.
- io.micronaut.http.server.filter - package io.micronaut.http.server.filter
-
Classes related to HTTP Server Filters.
- io.micronaut.http.server.multipart - package io.micronaut.http.server.multipart
-
Classes related to multipart requests received by a server.
- io.micronaut.http.server.types - package io.micronaut.http.server.types
-
HTTP server customizable response type.
- io.micronaut.http.server.types.files - package io.micronaut.http.server.types.files
-
Special file type handlers.
- io.micronaut.http.server.util - package io.micronaut.http.server.util
-
Utilities used in the context of an HTTP server.
- io.micronaut.http.server.util.locale - package io.micronaut.http.server.util.locale
-
Micronaut's utilities to resolve a
Localefor an HTTP request. - io.micronaut.http.server.websocket - package io.micronaut.http.server.websocket
-
Utilities used in the context of a web socket.
- ioExecutor() - Method in class io.micronaut.http.server.ResponseLifecycle
-
The IO executor for blocking writers.
- isAllowCredentials() - Method in class io.micronaut.http.server.cors.CorsOriginConfiguration
- isAllowPrivateNetwork() - Method in class io.micronaut.http.server.cors.CorsOriginConfiguration
- isClaimed(String) - Method in class io.micronaut.http.server.multipart.FormRouteCompleter
- isDateHeader() - Method in class io.micronaut.http.server.HttpServerConfiguration
- isDisk() - Method in class io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration
- isDispatchOptionsRequests() - Method in class io.micronaut.http.server.HttpServerConfiguration
-
Set to true to dispatch OPTIONS requests.
- isDualProtocol() - Method in class io.micronaut.http.server.HttpServerConfiguration
- isEnabled() - Method in class io.micronaut.http.server.HttpServerConfiguration.CorsConfiguration
- isEnabled() - Method in class io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration
- isEnabled(HttpRequest) - Method in class io.micronaut.http.server.cors.CorsFilter
- isEscapeHtmlUrl() - Method in class io.micronaut.http.server.HttpServerConfiguration
-
Browsers can send characters (such as
|) which are not permitted under RFC 3986 as part of the request path. - isHeader() - Method in class io.micronaut.http.server.HttpServerConfiguration.HttpLocaleResolutionConfigurationProperties
- isHeader() - Method in interface io.micronaut.http.server.util.locale.HttpLocaleResolutionConfiguration
- isHttpToHttpsRedirect() - Method in class io.micronaut.http.server.HttpServerConfiguration
- isLocalhostPassThrough() - Method in class io.micronaut.http.server.HttpServerConfiguration.CorsConfiguration
- isLogHandledExceptions() - Method in class io.micronaut.http.server.HttpServerConfiguration
- isMixed() - Method in class io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration
- isNotFoundOnMissingBody() - Method in class io.micronaut.http.server.HttpServerConfiguration
- isPortInHost() - Method in class io.micronaut.http.server.HttpServerConfiguration.HostResolutionConfiguration
- isPreflightRequest(HttpRequest) - Static method in class io.micronaut.http.server.cors.CorsUtil
- isRedispatchNonBlockingOnly() - Method in class io.micronaut.http.server.HttpServerConfiguration
- isSemicolonIsNormalChar() - Method in class io.micronaut.http.server.HttpServerConfiguration
-
Returns whether the semicolon is considered a normal character in the query.
- isSingleHeader() - Method in class io.micronaut.http.server.HttpServerConfiguration.CorsConfiguration
- isValidateUrl() - Method in class io.micronaut.http.server.HttpServerConfiguration
-
Deprecated, for removal: This API element is subject to removal in a future version.URLs are always validated again as of 4.9. This setting does nothing
J
- JacksonExceptionHandler - Class in io.micronaut.http.server.exceptions
-
Default exception handler for jackson processing errors.
- JacksonExceptionHandler(ErrorResponseProcessor) - Constructor for class io.micronaut.http.server.exceptions.JacksonExceptionHandler
-
Constructor.
- JsonErrorResponseBodyProvider<T> - Interface in io.micronaut.http.server.exceptions.response
-
A
ErrorResponseBodyProviderfor JSON responses. - JsonExceptionHandler - Class in io.micronaut.http.server.exceptions
-
Default exception handler for JSON processing errors.
- JsonExceptionHandler(ErrorResponseProcessor) - Constructor for class io.micronaut.http.server.exceptions.JsonExceptionHandler
-
Constructor.
L
- LocaleArgumentBinder - Class in io.micronaut.http.server.binding
-
Binds
Localearguments in controller methods using theLocaleResolver. - LocaleArgumentBinder(HttpLocaleResolver) - Constructor for class io.micronaut.http.server.binding.LocaleArgumentBinder
M
- mapForGetBody(Charset) - Method in class io.micronaut.http.server.multipart.FormRouteCompleter
-
Convert the full form data into a
MapforHttpMessage.getBody(). - mapForGetBody(Map, Charset) - Static method in class io.micronaut.http.server.multipart.FormRouteCompleter
-
Transform a map of
CloseableByteBodyinto a map of strings (and list of strings if necessary). - maxAge() - Element in annotation interface io.micronaut.http.server.cors.CrossOrigin
- MEMBER_ALLOW_CREDENTIALS - Static variable in class io.micronaut.http.server.cors.CrossOriginUtil
- MEMBER_ALLOW_PRIVATE_NETWORK - Static variable in class io.micronaut.http.server.cors.CrossOriginUtil
- MEMBER_ALLOWED_HEADERS - Static variable in class io.micronaut.http.server.cors.CrossOriginUtil
- MEMBER_ALLOWED_METHODS - Static variable in class io.micronaut.http.server.cors.CrossOriginUtil
- MEMBER_ALLOWED_ORIGINS - Static variable in class io.micronaut.http.server.cors.CrossOriginUtil
- MEMBER_ALLOWED_ORIGINS_REGEX - Static variable in class io.micronaut.http.server.cors.CrossOriginUtil
- MEMBER_EXPOSED_HEADERS - Static variable in class io.micronaut.http.server.cors.CrossOriginUtil
- MEMBER_MAX_AGE - Static variable in class io.micronaut.http.server.cors.CrossOriginUtil
- mode() - Method in record class io.micronaut.http.server.multipart.FormRouteCompleter.SubscriptionMetadata
-
Returns the value of the
moderecord component. - MultipartBody - Interface in io.micronaut.http.server.multipart
-
Represents the body of a multipart request that emits each part after it is received in its entirety.
- MultipartConfiguration() - Constructor for class io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration
N
- normalFlow() - Method in class io.micronaut.http.server.RequestLifecycle
-
Deprecated, for removal: This API element is subject to removal in a future version.Will be removed after 4.3.0
- normalFlow(HttpRequest) - Method in class io.micronaut.http.server.RequestLifecycle
-
Execute this request normally.
- NotAcceptableException - Exception Class in io.micronaut.http.server.exceptions
-
Exception thrown when none of the produceable content types matches any of the accepted types.
- NotAcceptableException(Collection, Collection) - Constructor for exception class io.micronaut.http.server.exceptions.NotAcceptableException
- NotAllowedException - Exception Class in io.micronaut.http.server.exceptions
-
Exception thrown when the request HTTP Method is not allowed.
- NotAllowedException(String, URI, Set) - Constructor for exception class io.micronaut.http.server.exceptions.NotAllowedException
- NotAllowedExceptionHandler - Class in io.micronaut.http.server.exceptions
-
Handles exception of type
NotAllowedExceptionand returns an HTTP 405 (Method Not Allowed) response with the "Allow" HTTP Header populated to the allowed headers. - NotAllowedExceptionHandler(ErrorResponseProcessor) - Constructor for class io.micronaut.http.server.exceptions.NotAllowedExceptionHandler
- NotFoundException - Exception Class in io.micronaut.http.server.exceptions
-
Exception thrown when the request uri is not found.
- NotFoundException() - Constructor for exception class io.micronaut.http.server.exceptions.NotFoundException
- notModified(ByteBodyFactory, MutableHttpResponse) - Method in class io.micronaut.http.server.body.InputStreamBodyWriter
- notModified(ByteBodyFactory, MutableHttpResponse) - Method in class io.micronaut.http.server.body.StreamFileBodyWriter
- notModified(ByteBodyFactory, MutableHttpResponse) - Method in class io.micronaut.http.server.body.SystemFileBodyWriter
- NotWebSocketRequestException - Exception Class in io.micronaut.http.server.exceptions
- NotWebSocketRequestException() - Constructor for exception class io.micronaut.http.server.exceptions.NotWebSocketRequestException
O
- onError(HttpRequest, Throwable) - Method in class io.micronaut.http.server.RequestLifecycle
-
Handle an error in this request.
- onStatusError(HttpRequest, MutableHttpResponse, String) - Method in class io.micronaut.http.server.RequestLifecycle
-
Build a status response.
- OptionsFilter - Class in io.micronaut.http.server
-
This Filter intercepts HTTP OPTIONS requests which are not CORS Preflight requests.
- OptionsFilter() - Constructor for class io.micronaut.http.server.OptionsFilter
- ORDER - Static variable in class io.micronaut.http.server.util.locale.HttpAbstractLocaleResolver
- ORDER - Static variable in class io.micronaut.http.server.util.locale.HttpFixedLocaleResolver
- ORDER - Static variable in class io.micronaut.http.server.util.locale.RequestLocaleResolver
P
- parseBody(HttpRequest) - Method in interface io.micronaut.http.server.filter.FilterBodyParser
-
Attempts to parse the request body into a Map.
- PREFIX - Static variable in class io.micronaut.http.server.HttpServerConfiguration.HttpLocaleResolutionConfigurationProperties
- PREFIX - Static variable in class io.micronaut.http.server.HttpServerConfiguration
-
The prefix used for configuration.
- PREFIX - Static variable in class io.micronaut.http.server.OptionsFilter
- PreMatching - Annotation Interface in io.micronaut.http.server.annotation
-
Annotation to mark
RequestFilterto be executed before the route has been matched. - process(MutableHttpResponse) - Method in class io.micronaut.http.server.types.files.SystemFile
- process(MutableHttpResponse) - Method in interface io.micronaut.http.server.types.CustomizableResponseType
-
Modify the response before it is written to the client.
- process(MutableHttpResponse) - Method in class io.micronaut.http.server.types.files.StreamedFile
- process(BeanDefinition, BeanContext) - Method in class io.micronaut.http.server.websocket.ServerWebSocketProcessor
- processResponse(ErrorContext, MutableHttpResponse) - Method in interface io.micronaut.http.server.exceptions.response.ErrorResponseProcessor
-
Modifies the http response representing the error.
- processResponse(ErrorContext, MutableHttpResponse) - Method in class io.micronaut.http.server.exceptions.response.HateoasErrorResponseProcessor
-
Deprecated.
- ProxyHeaderParser - Class in io.micronaut.http.server.util
-
Responsible for parsing and returning the information stored in the standard and de facto standard proxy headers.
- ProxyHeaderParser(HttpRequest) - Constructor for class io.micronaut.http.server.util.ProxyHeaderParser
R
- RawFormFieldArgumentBinder - Class in io.micronaut.http.server.binding
-
Binder for
RawFormField. - register(MutableConversionService) - Method in class io.micronaut.http.server.HttpServerTypeConvertersRegistrar
- request() - Method in class io.micronaut.http.server.RequestLifecycle
-
Deprecated, for removal: This API element is subject to removal in a future version.Will be removed after 4.3.0
- RequestArgumentSatisfier - Class in io.micronaut.http.server.binding
-
A class containing methods to aid in satisfying arguments of a
Route. - RequestArgumentSatisfier(RequestBinderRegistry) - Constructor for class io.micronaut.http.server.binding.RequestArgumentSatisfier
- RequestLifecycle - Class in io.micronaut.http.server
-
This class handles the full route processing lifecycle for a request.
- RequestLifecycle(RouteExecutor) - Constructor for class io.micronaut.http.server.RequestLifecycle
- RequestLifecycle(RouteExecutor, HttpRequest) - Constructor for class io.micronaut.http.server.RequestLifecycle
-
Deprecated, for removal: This API element is subject to removal in a future version.Will be removed after 4.3.0
- RequestLocaleResolver - Class in io.micronaut.http.server.util.locale
-
A locale resolver which resolves the locale via
HttpRequest.getLocale(). - RequestLocaleResolver(HttpLocaleResolutionConfiguration) - Constructor for class io.micronaut.http.server.util.locale.RequestLocaleResolver
- resolve(HttpRequest) - Method in class io.micronaut.http.server.util.DefaultHttpHostResolver
- resolve(HttpRequest) - Method in interface io.micronaut.http.server.util.HttpHostResolver
-
Returns the host of the current server with protocol, host name, and an optional port.
- resolve(HttpRequest) - Method in class io.micronaut.http.server.util.DefaultHttpClientAddressResolver
- resolve(HttpRequest) - Method in interface io.micronaut.http.server.util.HttpClientAddressResolver
- resolve(HttpRequest) - Method in class io.micronaut.http.server.util.locale.CompositeHttpLocaleResolver
- resolve(HttpRequest) - Method in class io.micronaut.http.server.util.locale.CookieLocaleResolver
- resolve(HttpRequest) - Method in class io.micronaut.http.server.util.locale.RequestLocaleResolver
- resolveDefaultResponseContentType(HttpRequest, RouteInfo) - Method in class io.micronaut.http.server.RouteExecutor
- ResponseLifecycle - Class in io.micronaut.http.server
-
This class handles encoding of the HTTP response in a server-agnostic way.
- ResponseLifecycle(RouteExecutor, MessageBodyHandlerRegistry, ConversionService, ByteBodyFactory) - Constructor for class io.micronaut.http.server.ResponseLifecycle
- responseProcessor - Variable in class io.micronaut.http.server.exceptions.ErrorExceptionHandler
- responseProcessor - Variable in class io.micronaut.http.server.exceptions.ErrorResponseProcessorExceptionHandler
- RouteExecutor - Class in io.micronaut.http.server
-
A class responsible for executing routes.
- RouteExecutor(Router, BeanContext, RequestArgumentSatisfier, HttpServerConfiguration, ErrorResponseProcessor, ExecutorSelector) - Constructor for class io.micronaut.http.server.RouteExecutor
-
Default constructor.
- runWithFilters(HttpRequest, BiFunction) - Method in class io.micronaut.http.server.RequestLifecycle
-
Run the filters for this request, and then run the given flow.
S
- ServerStartupException - Exception Class in io.micronaut.http.server.exceptions
-
An exception thrown on server startup.
- ServerStartupException(String) - Constructor for exception class io.micronaut.http.server.exceptions.ServerStartupException
- ServerStartupException(String, Throwable) - Constructor for exception class io.micronaut.http.server.exceptions.ServerStartupException
- ServerWebSocketProcessor - Class in io.micronaut.http.server.websocket
-
A processor that exposes WebSocket URIs via the router.
- setAllowCredentials(boolean) - Method in class io.micronaut.http.server.cors.CorsOriginConfiguration
-
Sets whether to allow credentials.
- setAllowCredentials(CorsOriginConfiguration, MutableHttpResponse) - Method in class io.micronaut.http.server.cors.CorsFilter
- setAllowedHeaders(List) - Method in class io.micronaut.http.server.cors.CorsOriginConfiguration
-
Sets the allowed headers.
- setAllowedHosts(List) - Method in class io.micronaut.http.server.HttpServerConfiguration.HostResolutionConfiguration
- setAllowedMethods(List) - Method in class io.micronaut.http.server.cors.CorsOriginConfiguration
-
Sets the allowed methods.
- setAllowedOrigins(List) - Method in class io.micronaut.http.server.cors.CorsOriginConfiguration
-
Sets the allowed origins.
- setAllowedOriginsRegex(String) - Method in class io.micronaut.http.server.cors.CorsOriginConfiguration
-
Sets a regular expression for matching Allowed Origins.
- setAllowHeaders(List, MutableHttpResponse) - Method in class io.micronaut.http.server.cors.CorsFilter
- setAllowMethods(HttpMethod, MutableHttpResponse) - Method in class io.micronaut.http.server.cors.CorsFilter
- setAllowPrivateNetwork(boolean) - Method in class io.micronaut.http.server.cors.CorsOriginConfiguration
-
Sets whether to allow private network.
- setAllowPrivateNetwork(CorsOriginConfiguration, MutableHttpResponse) - Method in class io.micronaut.http.server.cors.CorsFilter
-
Sets the HTTP Header "Access-Control-Allow-Private-Network" in the response to
true, if theCorsOriginConfiguration.isAllowPrivateNetwork()istrue. - setCacheControl(HttpServerConfiguration.FileTypeHandlerConfiguration.CacheControlConfiguration) - Method in class io.micronaut.http.server.HttpServerConfiguration.FileTypeHandlerConfiguration
-
Sets the cache control configuration.
- setCacheSeconds(int) - Method in class io.micronaut.http.server.HttpServerConfiguration.FileTypeHandlerConfiguration
-
Cache Seconds.
- setClientAddressHeader(String) - Method in class io.micronaut.http.server.HttpServerConfiguration
- setConfigurations(Map) - Method in class io.micronaut.http.server.HttpServerConfiguration.CorsConfiguration
-
Sets the CORS configurations.
- setContextPath(String) - Method in class io.micronaut.http.server.HttpServerConfiguration
-
Sets the context path for the web server.
- setCookieName(String) - Method in class io.micronaut.http.server.HttpServerConfiguration.HttpLocaleResolutionConfigurationProperties
-
Sets the name of the cookie that is used to store the locale.
- setCors(HttpServerConfiguration.CorsConfiguration) - Method in class io.micronaut.http.server.HttpServerConfiguration
-
Sets the cors configuration.
- setDateAndCacheHeaders(MutableHttpResponse, long) - Method in class io.micronaut.http.server.body.InputStreamBodyWriter
- setDateAndCacheHeaders(MutableHttpResponse, long) - Method in class io.micronaut.http.server.body.StreamFileBodyWriter
- setDateAndCacheHeaders(MutableHttpResponse, long) - Method in class io.micronaut.http.server.body.SystemFileBodyWriter
- setDateHeader(boolean) - Method in class io.micronaut.http.server.HttpServerConfiguration
-
Sets whether a date header should be sent back.
- setDateHeader(MutableHttpResponse) - Method in class io.micronaut.http.server.body.InputStreamBodyWriter
- setDateHeader(MutableHttpResponse) - Method in class io.micronaut.http.server.body.StreamFileBodyWriter
- setDateHeader(MutableHttpResponse) - Method in class io.micronaut.http.server.body.SystemFileBodyWriter
- setDefaultCharset(Charset) - Method in class io.micronaut.http.server.HttpServerConfiguration
- setDefaultLocale(Locale) - Method in class io.micronaut.http.server.HttpServerConfiguration.HttpLocaleResolutionConfigurationProperties
-
Sets the locale that will be used if the locale cannot be resolved through any means.
- setDisk(boolean) - Method in class io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration
-
Sets whether to buffer data to disk or not.
- setDispatchOptionsRequests(boolean) - Method in class io.micronaut.http.server.HttpServerConfiguration
-
Set to true to dispatch OPTIONS requests.
- setDualProtocol(boolean) - Method in class io.micronaut.http.server.HttpServerConfiguration
- setEnabled(boolean) - Method in class io.micronaut.http.server.HttpServerConfiguration.CorsConfiguration
-
Sets whether CORS is enabled.
- setEnabled(boolean) - Method in class io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration
-
Sets whether multipart processing is enabled.
- setEscapeHtmlUrl(boolean) - Method in class io.micronaut.http.server.HttpServerConfiguration
-
Browsers can send characters (such as
|) which are not permitted under RFC 3986 as part of the request path. - setExposedHeaders(List) - Method in class io.micronaut.http.server.cors.CorsOriginConfiguration
-
Sets the exposed headers.
- setExposeHeaders(List, MutableHttpResponse) - Method in class io.micronaut.http.server.cors.CorsFilter
- setFixed(Locale) - Method in class io.micronaut.http.server.HttpServerConfiguration.HttpLocaleResolutionConfigurationProperties
-
Set the language tag for the locale.
- setHeader(boolean) - Method in class io.micronaut.http.server.HttpServerConfiguration.HttpLocaleResolutionConfigurationProperties
-
Set to true if the locale should be resolved from the `Accept-Language` header.
- setHost(String) - Method in class io.micronaut.http.server.HttpServerConfiguration
-
Sets the host to bind to.
- setHostHeader(String) - Method in class io.micronaut.http.server.HttpServerConfiguration.HostResolutionConfiguration
- setHostResolution(HttpServerConfiguration.HostResolutionConfiguration) - Method in class io.micronaut.http.server.HttpServerConfiguration
- setHttpToHttpsRedirect(boolean) - Method in class io.micronaut.http.server.HttpServerConfiguration
- setHttpVersion(HttpVersion) - Method in class io.micronaut.http.server.HttpServerConfiguration
-
Sets the HTTP version to use.
- setIdleTimeout(Duration) - Method in class io.micronaut.http.server.HttpServerConfiguration
-
Sets the idle time of connections for the server.
- setLocaleResolution(HttpServerConfiguration.HttpLocaleResolutionConfigurationProperties) - Method in class io.micronaut.http.server.HttpServerConfiguration
- setLocalhostPassThrough(boolean) - Method in class io.micronaut.http.server.HttpServerConfiguration.CorsConfiguration
-
Sets whether localhost pass-through is enabled.
- setLocation(File) - Method in class io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration
-
Sets the location to store files.
- setLogHandledExceptions(boolean) - Method in class io.micronaut.http.server.HttpServerConfiguration
-
Sets whether exceptions handled by either an error route or exception handler should still be logged.
- setMaxAge(long, MutableHttpResponse) - Method in class io.micronaut.http.server.cors.CorsFilter
- setMaxAge(Long) - Method in class io.micronaut.http.server.cors.CorsOriginConfiguration
-
Sets the max age.
- setMaxFileSize(long) - Method in class io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration
-
Sets the max file size.
- setMaxParams(int) - Method in class io.micronaut.http.server.HttpServerConfiguration
- setMaxRequestBufferSize(long) - Method in class io.micronaut.http.server.HttpServerConfiguration
-
Sets the maximum number of request bytes that will be buffered.
- setMaxRequestSize(long) - Method in class io.micronaut.http.server.HttpServerConfiguration
-
Sets the maximum request size.
- setMixed(boolean) - Method in class io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration
-
Sets whether to buffer data to disk if the size is greater than the threshold.
- setMultipart(HttpServerConfiguration.MultipartConfiguration) - Method in class io.micronaut.http.server.HttpServerConfiguration
-
Sets the multipart configuration.
- setNotFoundOnMissingBody(boolean) - Method in class io.micronaut.http.server.HttpServerConfiguration
- setOrigin(String, MutableHttpResponse) - Method in class io.micronaut.http.server.cors.CorsFilter
- setPort(int) - Method in class io.micronaut.http.server.HttpServerConfiguration
-
Sets the port to bind to.
- setPortHeader(String) - Method in class io.micronaut.http.server.HttpServerConfiguration.HostResolutionConfiguration
- setPortInHost(boolean) - Method in class io.micronaut.http.server.HttpServerConfiguration.HostResolutionConfiguration
- setProtocolHeader(String) - Method in class io.micronaut.http.server.HttpServerConfiguration.HostResolutionConfiguration
- setPublic(boolean) - Method in class io.micronaut.http.server.HttpServerConfiguration.FileTypeHandlerConfiguration.CacheControlConfiguration
-
Sets whether the cache control is public.
- setReadIdleTimeout(Duration) - Method in class io.micronaut.http.server.HttpServerConfiguration
-
Sets the amount of time a connection can remain idle without any reads occurring.
- setReadTimeout(Integer) - Method in class io.micronaut.http.server.HttpServerConfiguration
-
Deprecated.This setting does nothing
- setRedispatchNonBlockingOnly(boolean) - Method in class io.micronaut.http.server.HttpServerConfiguration
-
Sets whether configured executors are used only for calls from non-blocking threads.
- setRequest(HttpRequest) - Method in class io.micronaut.http.server.util.locale.HttpLocalizedMessageSource
- setSemicolonIsNormalChar(boolean) - Method in class io.micronaut.http.server.HttpServerConfiguration
-
Sets whether the semicolon should be considered a normal character in the query.
- setServerHeader(String) - Method in class io.micronaut.http.server.HttpServerConfiguration
-
Sets the name of the server header.
- setSessionAttribute(String) - Method in class io.micronaut.http.server.HttpServerConfiguration.HttpLocaleResolutionConfigurationProperties
-
Sets the key in the session to look for the locale.
- setSingleHeader(boolean) - Method in class io.micronaut.http.server.HttpServerConfiguration.CorsConfiguration
-
Sets whether CORS header values should be joined into a single header.
- setThreadSelection(ThreadSelection) - Method in class io.micronaut.http.server.HttpServerConfiguration
-
Sets the
ThreadSelectionmodel to use for the server. - setThreshold(long) - Method in class io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration
-
Sets the amount of data that should be received that will trigger the data to be stored to disk.
- setupCoroutineContext(HttpRequest, ContextView, PropagatedContext) - Method in class io.micronaut.http.server.CoroutineHelper
- setValidateUrl(boolean) - Method in class io.micronaut.http.server.HttpServerConfiguration
-
Deprecated, for removal: This API element is subject to removal in a future version.URLs are always validated again as of 4.9. This setting does nothing
- setVary(MutableHttpResponse) - Method in class io.micronaut.http.server.cors.CorsFilter
- setWriteIdleTimeout(Duration) - Method in class io.micronaut.http.server.HttpServerConfiguration
-
Sets the amount of time a connection can remain idle without any writes occurring.
- shouldDenyToPreventDriveByLocalhostAttack(CorsOriginConfiguration, HttpRequest) - Method in class io.micronaut.http.server.cors.CorsFilter
- shouldDenyToPreventDriveByLocalhostAttack(String, HttpRequest) - Method in class io.micronaut.http.server.cors.CorsFilter
- start() - Method in class io.micronaut.http.server.multipart.FormRouteCompleter
-
Start reading the form data.
- stopDeadlockDetection() - Method in class io.micronaut.http.server.multipart.FormRouteCompleter
-
Stop deadlock detection.
- StreamedFile - Class in io.micronaut.http.server.types.files
-
A special type for streaming an
InputStreamrepresenting a file or resource. - StreamedFile(InputStream, MediaType) - Constructor for class io.micronaut.http.server.types.files.StreamedFile
- StreamedFile(InputStream, MediaType, long) - Constructor for class io.micronaut.http.server.types.files.StreamedFile
- StreamedFile(InputStream, MediaType, long, long) - Constructor for class io.micronaut.http.server.types.files.StreamedFile
- StreamedFile(URL) - Constructor for class io.micronaut.http.server.types.files.StreamedFile
-
Immediately opens a connection to the given URL to retrieve data about the connection, including the input stream.
- StreamFileBodyWriter - Class in io.micronaut.http.server.body
-
Body writer for
StreamedFiles. - streamFileUpload(RawFormField) - Method in class io.micronaut.http.server.multipart.FormFactory
-
Create a new
StreamingFileUploadfrom the given raw data. - subscribeField(String, FormRouteCompleter.SubscriptionMetadata) - Method in class io.micronaut.http.server.multipart.FormRouteCompleter
-
Subscribe to a field of a particular name.
- SubscriptionMetadata(FormRouteCompleter.SubscriptionMode, Argument) - Constructor for record class io.micronaut.http.server.multipart.FormRouteCompleter.SubscriptionMetadata
-
Creates an instance of a
SubscriptionMetadatarecord class. - SystemFile - Class in io.micronaut.http.server.types.files
-
Used as the return value of a route execution to send
Fileinstances to the client. - SystemFile(File) - Constructor for class io.micronaut.http.server.types.files.SystemFile
- SystemFile(File, MediaType) - Constructor for class io.micronaut.http.server.types.files.SystemFile
- SystemFileBodyWriter - Class in io.micronaut.http.server.body
-
Body writer for
SystemFiles. - SystemFileBodyWriter(HttpServerConfiguration.FileTypeHandlerConfiguration, ExecutorService) - Constructor for class io.micronaut.http.server.body.SystemFileBodyWriter
T
- TextStreamCodec - Class in io.micronaut.http.server.codec
-
Deprecated, for removal: This API element is subject to removal in a future version.Replaced with message body writers / readers API
- TextStreamCodec(ApplicationConfiguration, ByteBufferFactory, BeanProvider, CodecConfiguration) - Constructor for class io.micronaut.http.server.codec.TextStreamCodec
-
Deprecated.
- TextStreamCodec(Charset, ByteBufferFactory, BeanProvider, CodecConfiguration) - Constructor for class io.micronaut.http.server.codec.TextStreamCodec
-
Deprecated.
- toString() - Method in record class io.micronaut.http.server.multipart.FormRouteCompleter.SubscriptionMetadata
-
Returns a string representation of this record class.
U
- UnsatisfiedArgumentHandler - Class in io.micronaut.http.server.exceptions
-
Handles exception of type
UnsatisfiedArgumentException. - UnsatisfiedArgumentHandler(ErrorResponseProcessor) - Constructor for class io.micronaut.http.server.exceptions.UnsatisfiedArgumentHandler
-
Constructor.
- UnsatisfiedRouteHandler - Class in io.micronaut.http.server.exceptions
-
Handles exceptions of type
UnsatisfiedRouteException. - UnsatisfiedRouteHandler(ErrorResponseProcessor) - Constructor for class io.micronaut.http.server.exceptions.UnsatisfiedRouteHandler
-
Constructor.
- UnsupportedMediaException - Exception Class in io.micronaut.http.server.exceptions
-
Exception thrown when the requested Content-Type is not supported.
- UnsupportedMediaException(String, Collection) - Constructor for exception class io.micronaut.http.server.exceptions.UnsupportedMediaException
- URISyntaxHandler - Class in io.micronaut.http.server.exceptions
-
Handles exception of type
URISyntaxException. - URISyntaxHandler(ErrorResponseProcessor) - Constructor for class io.micronaut.http.server.exceptions.URISyntaxHandler
-
Constructor.
V
- validateHost(String) - Method in class io.micronaut.http.server.util.DefaultHttpHostResolver
-
Validates the host transforming the host value if necessary.
- value() - Element in annotation interface io.micronaut.http.server.cors.CrossOrigin
- valueOf(String) - Static method in enum class io.micronaut.http.server.multipart.FormRouteCompleter.SubscriptionMode
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.micronaut.http.server.multipart.FormRouteCompleter.SubscriptionMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- WAITS_FOR_FULL - Enum constant in enum class io.micronaut.http.server.multipart.FormRouteCompleter.SubscriptionMode
-
Before the route can execute, these form fields must have been fully received, including all their data.
- WAITS_FOR_START - Enum constant in enum class io.micronaut.http.server.multipart.FormRouteCompleter.SubscriptionMode
-
Before the route can execute, the headers of the first form field of this name must be received, but the field body will not be consumed until the route actually executes.
- wrap(MessageBodyWriter) - Method in class io.micronaut.http.server.ResponseLifecycle
-
Transform the given writer into a
ResponseBodyWriter. - write(ByteBodyFactory, HttpRequest, MutableHttpResponse, Argument, MediaType, StreamedFile) - Method in class io.micronaut.http.server.body.StreamFileBodyWriter
- write(ByteBodyFactory, HttpRequest, MutableHttpResponse, Argument, MediaType, SystemFile) - Method in class io.micronaut.http.server.body.SystemFileBodyWriter
- write(ByteBodyFactory, HttpRequest, MutableHttpResponse, SystemFile) - Method in class io.micronaut.http.server.body.SystemFileBodyWriter
- write(ByteBodyFactory, HttpRequest, MutableHttpResponse, Argument, MediaType, File) - Method in class io.micronaut.http.server.body.FileBodyWriter
- writeAttribute(ByteBuffer, byte[], String) - Method in class io.micronaut.http.server.codec.TextStreamCodec
-
Deprecated.
- writePiece(ByteBodyFactory, HttpRequest, HttpResponse, Argument, MediaType, StreamedFile) - Method in class io.micronaut.http.server.body.StreamFileBodyWriter
- writePiece(ByteBodyFactory, HttpRequest, HttpResponse, Argument, MediaType, SystemFile) - Method in class io.micronaut.http.server.body.SystemFileBodyWriter
- writePiece(ByteBodyFactory, HttpRequest, HttpResponse, Argument, MediaType, File) - Method in class io.micronaut.http.server.body.FileBodyWriter
- writePiece(ByteBodyFactory, HttpRequest, HttpResponse, Argument, MediaType, InputStream) - Method in class io.micronaut.http.server.body.InputStreamBodyWriter
- writePiece(ByteBodyFactory, SystemFile) - Method in class io.micronaut.http.server.body.SystemFileBodyWriter
- writeTo(Argument, MediaType, StreamedFile, MutableHeaders, OutputStream) - Method in class io.micronaut.http.server.body.StreamFileBodyWriter
- writeTo(Argument, MediaType, SystemFile, MutableHeaders, OutputStream) - Method in class io.micronaut.http.server.body.SystemFileBodyWriter
- writeTo(Argument, MediaType, File, MutableHeaders, OutputStream) - Method in class io.micronaut.http.server.body.FileBodyWriter
- writeTo(Argument, MediaType, InputStream, MutableHeaders, OutputStream) - Method in class io.micronaut.http.server.body.InputStreamBodyWriter
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form