Index (avaje-jex 3.0-RC24 API)

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

ACCEPT - Static variable in class io.avaje.jex.core.Constants
ACCEPT_ENCODING - Static variable in class io.avaje.jex.core.Constants
ACCEPTED_202 - Enum constant in enum class io.avaje.jex.http.HttpStatus
Access Management - Search tag in Overview: Section
add(Routing) - Method in interface io.avaje.jex.Routing.HttpService: Add to the routing.
add(Routing.HttpService) - Method in interface io.avaje.jex.Routing: Add the routes provided by the given HttpService.
addAll(Collection<Routing.HttpService>) - Method in interface io.avaje.jex.Routing: Add all the routes provided by the Routing Services.
Additional Resources - Search tag in Overview: Section
Advanced Features - Search tag in Overview: Section
after(Consumer<Context>) - Method in interface io.avaje.jex.Jex: Add a post-processing filter for all matched requests.
after(Consumer<Context>) - Method in interface io.avaje.jex.Routing: Add a post-processing filter for all matched requests.
allowsForCompression(String) - Method in class io.avaje.jex.compression.CompressionConfig: Determines if a given content type is allowed for compression.
APPLICATION_7Z - Enum constant in enum class io.avaje.jex.http.ContentType
APPLICATION_BZ - Enum constant in enum class io.avaje.jex.http.ContentType
APPLICATION_BZ2 - Enum constant in enum class io.avaje.jex.http.ContentType
APPLICATION_CDN - Enum constant in enum class io.avaje.jex.http.ContentType
APPLICATION_DOC - Enum constant in enum class io.avaje.jex.http.ContentType
APPLICATION_DOCX - Enum constant in enum class io.avaje.jex.http.ContentType
APPLICATION_EPUB - Enum constant in enum class io.avaje.jex.http.ContentType
APPLICATION_GZ - Enum constant in enum class io.avaje.jex.http.ContentType
APPLICATION_JAR - Enum constant in enum class io.avaje.jex.http.ContentType
APPLICATION_JSON - Enum constant in enum class io.avaje.jex.http.ContentType
APPLICATION_JSON - Static variable in class io.avaje.jex.core.Constants
APPLICATION_MPKG - Enum constant in enum class io.avaje.jex.http.ContentType
APPLICATION_OCTET_STREAM - Enum constant in enum class io.avaje.jex.http.ContentType
APPLICATION_PDF - Enum constant in enum class io.avaje.jex.http.ContentType
APPLICATION_POM - Enum constant in enum class io.avaje.jex.http.ContentType
APPLICATION_RAR - Enum constant in enum class io.avaje.jex.http.ContentType
APPLICATION_SH - Enum constant in enum class io.avaje.jex.http.ContentType
APPLICATION_SWF - Enum constant in enum class io.avaje.jex.http.ContentType
APPLICATION_TAR - Enum constant in enum class io.avaje.jex.http.ContentType
APPLICATION_X_JSON_STREAM - Static variable in class io.avaje.jex.core.Constants
APPLICATION_XHTML - Enum constant in enum class io.avaje.jex.http.ContentType
APPLICATION_YAML - Enum constant in enum class io.avaje.jex.http.ContentType
APPLICATION_ZIP - Enum constant in enum class io.avaje.jex.http.ContentType
AppLifecycle - Interface in io.avaje.jex: Defines the lifecycle configuration for an application.
AppLifecycle.Status - Enum Class in io.avaje.jex: Represents the possible states of the application server.
apply(Jex) - Method in interface io.avaje.jex.spi.JexPlugin: Register the plugin features with jex.
attribute(String) - Method in interface io.avaje.jex.http.Context: Gets the attribute with the specified key from the request.
attribute(String, Object) - Method in interface io.avaje.jex.http.Context: Sets an attribute on the request, accessible to other handlers in the request lifecycle.
AUDIO_AAC - Enum constant in enum class io.avaje.jex.http.ContentType
AUDIO_MIDI - Enum constant in enum class io.avaje.jex.http.ContentType
AUDIO_MPEG - Enum constant in enum class io.avaje.jex.http.ContentType
AUDIO_OGA - Enum constant in enum class io.avaje.jex.http.ContentType
AUDIO_OPUS - Enum constant in enum class io.avaje.jex.http.ContentType
AUDIO_WAV - Enum constant in enum class io.avaje.jex.http.ContentType
AUDIO_WEBA - Enum constant in enum class io.avaje.jex.http.ContentType
AvajeJex - Interface in io.avaje.jex: Start Jex using avaje-inject, avaje-http, avaje-config.
Avaje Jex - Search tag in Overview: Section

B

BAD_GATEWAY_502 - Enum constant in enum class io.avaje.jex.http.HttpStatus
BAD_REQUEST_400 - Enum constant in enum class io.avaje.jex.http.HttpStatus
BadRequestException - Exception Class in io.avaje.jex.http: Thrown when request is invalid
BadRequestException(Object) - Constructor for exception class io.avaje.jex.http.BadRequestException: Create with a response that will sent as JSON.
BadRequestException(String) - Constructor for exception class io.avaje.jex.http.BadRequestException: Create with a message.
basicAuthCredentials() - Method in interface io.avaje.jex.http.Context: Gets basic-auth credentials from the request.
BasicAuthCredentials - Record Class in io.avaje.jex.security: Http Basic Auth credentials
BasicAuthCredentials(String, String) - Constructor for record class io.avaje.jex.security.BasicAuthCredentials: Creates an instance of a BasicAuthCredentials record class.
before(Consumer<Context>) - Method in interface io.avaje.jex.Jex: Add a pre-processing filter for all matched requests.
before(Consumer<Context>) - Method in interface io.avaje.jex.Routing: Add a pre-processing filter for all matched requests.
body() - Method in interface io.avaje.jex.http.Context: Return the request body as String.
bodyAsBytes() - Method in interface io.avaje.jex.http.Context: Returns the request body as a byte array.
bodyAsClass(Class<T>) - Method in interface io.avaje.jex.http.Context: Return the request body as bean.
bodyAsInputStream() - Method in interface io.avaje.jex.http.Context: Returns the request body as an input stream.
bodyAsType(Type) - Method in interface io.avaje.jex.http.Context: Return the request body as bean.
bodyStreamAsClass(Class<T>) - Method in interface io.avaje.jex.http.Context: Return the request body as bean using Context.bodyAsInputStream().
bodyStreamAsType(Type) - Method in interface io.avaje.jex.http.Context: Return the request body as bean of the given type using Context.bodyAsInputStream().
BootstrapServer - Class in io.avaje.jex.core

C

close() - Method in class io.avaje.jex.compression.CompressedOutputStream
close() - Method in class io.avaje.jex.core.json.JsonbOutput
close() - Method in interface io.avaje.jex.http.sse.SseClient: Close the SseClient and release keepAlive block if any
compress(OutputStream) - Method in interface io.avaje.jex.compression.Compressor: Compresses the provided output stream.
CompressedOutputStream - Class in io.avaje.jex.compression: OutputStream implementation that conditionally compresses the output based on configuration and request headers.
CompressedOutputStream(CompressionConfig, Context, OutputStream) - Constructor for class io.avaje.jex.compression.CompressedOutputStream
compression() - Method in interface io.avaje.jex.JexConfig: Returns the configured compression settings.
compression(Consumer<CompressionConfig>) - Method in interface io.avaje.jex.JexConfig: Configures compression settings using a consumer function.
CompressionConfig - Class in io.avaje.jex.compression: Configuration for compression settings.
CompressionConfig() - Constructor for class io.avaje.jex.compression.CompressionConfig
compressionEnabled() - Method in class io.avaje.jex.compression.CompressionConfig: Checks if compression is enabled.
compressor(Compressor) - Method in class io.avaje.jex.compression.CompressionConfig: Adds a compressor for a given encoding type.
Compressor - Interface in io.avaje.jex.compression: Compressor interface defines methods for compressing an output stream.
config() - Method in interface io.avaje.jex.Jex: Return the configuration.
config(Consumer<JexConfig>) - Method in interface io.avaje.jex.Jex: Configures the Jex instance using a functional approach.
configureWith(BeanScope) - Method in interface io.avaje.jex.Jex: Configures the Jex instance using a dependency injection scope from Avaje-Inject.
CONFLICT_409 - Enum constant in enum class io.avaje.jex.http.HttpStatus
Constants - Class in io.avaje.jex.core
CONTENT_ENCODING - Static variable in class io.avaje.jex.core.Constants
CONTENT_LENGTH - Static variable in class io.avaje.jex.core.Constants
CONTENT_TYPE - Static variable in class io.avaje.jex.core.Constants
contentLength() - Method in interface io.avaje.jex.http.Context: Return the request content length.
contentType() - Method in enum class io.avaje.jex.http.ContentType
contentType() - Method in interface io.avaje.jex.http.Context: Return the request content type.
contentType(ContentType) - Method in interface io.avaje.jex.http.Context: Set the response content type.
contentType(String) - Method in interface io.avaje.jex.http.Context: Set the response content type.
ContentType - Enum Class in io.avaje.jex.http: Common Content Types
Context - Interface in io.avaje.jex.http: Provides access to functions for handling the request and response.
Context.Cookie - Interface in io.avaje.jex.http: This interface represents a cookie used in HTTP communication.
Context.Cookie.SameSite - Enum Class in io.avaje.jex.http: Cookie SameSite options.
Context Object - Search tag in Overview: Section
contextPath() - Method in interface io.avaje.jex.http.Context: Return the request context path.
contextPath() - Method in interface io.avaje.jex.JexConfig: Return the contextPath.
contextPath(String) - Method in interface io.avaje.jex.Jex: Sets the context path for the Jex application.
contextPath(String) - Method in interface io.avaje.jex.JexConfig: Set the contextPath passed to the underlying HttpServer.
CONTINUE_100 - Enum constant in enum class io.avaje.jex.http.HttpStatus
cookie(Context.Cookie) - Method in interface io.avaje.jex.http.Context: Sets a cookie using the provided Context.Cookie object.
cookie(String) - Method in interface io.avaje.jex.http.Context: Returns the value of a cookie with the specified name from the request.
cookie(String, String) - Method in interface io.avaje.jex.http.Context: Sets a cookie with the specified name and value, with no expiration date.
cookie(String, String, int) - Method in interface io.avaje.jex.http.Context: Sets a cookie with the specified name, value, and maximum age in seconds.
cookieMap() - Method in interface io.avaje.jex.http.Context: Returns a map containing all the cookie names and their corresponding values from the request.
create() - Static method in interface io.avaje.jex.Jex: Create Jex.
CREATED_201 - Enum constant in enum class io.avaje.jex.http.HttpStatus
ctx() - Method in interface io.avaje.jex.http.sse.SseClient: Return the request Context.

D

defaultExtensions() - Method in interface io.avaje.jex.spi.TemplateRender: Return the extensions this template renders for by default.
delete(String, ExchangeHandler, Role...) - Method in interface io.avaje.jex.Jex: Adds a DELETE handler to the route configuration.
delete(String, ExchangeHandler, Role...) - Method in interface io.avaje.jex.Routing: Adds a DELETE handler to the route configuration.
DELETE - Enum constant in enum class io.avaje.jex.Routing.Type
disableCompression() - Method in class io.avaje.jex.compression.CompressionConfig: Disables compression.
domain() - Method in interface io.avaje.jex.http.Context.Cookie: Returns the domain for which this cookie is valid.
domain(String) - Method in interface io.avaje.jex.http.Context.Cookie: Sets the domain for which this cookie is valid.

E

encoding() - Method in interface io.avaje.jex.compression.Compressor: Gets the content encoding for this compressor (e.g., "gzip").
equals(Object) - Method in record class io.avaje.jex.security.BasicAuthCredentials: Indicates whether some other object is "equal to" this one.
error(Class<T>, ExceptionHandler<T>) - Method in interface io.avaje.jex.Jex: Registers an exception handler that handles the given type of exceptions.
error(Class<T>, ExceptionHandler<T>) - Method in interface io.avaje.jex.Routing: Registers an exception handler that handles the given type of exceptions.
errorHandlers() - Method in interface io.avaje.jex.Routing: Return all the registered Exception Handlers.
ExceptionHandler<T> - Interface in io.avaje.jex.http: The routing error handler.
exchange() - Method in interface io.avaje.jex.http.Context: Return the underlying JDK HttpExchange object backing the context
ExchangeHandler - Interface in io.avaje.jex.http: A functional interface representing an HTTP request handler.
executor() - Method in interface io.avaje.jex.JexConfig: Executor for serving requests.
executor(Executor) - Method in interface io.avaje.jex.JexConfig: Sets the executor service used to handle incoming requests.
EXPECTATION_FAILED_417 - Enum constant in enum class io.avaje.jex.http.HttpStatus
expired(String) - Static method in interface io.avaje.jex.http.Context.Cookie: Creates and returns a new expired cookie with the given name.
expires() - Method in interface io.avaje.jex.http.Context.Cookie: Returns the date and time when this cookie expires.
expires(ZonedDateTime) - Method in interface io.avaje.jex.http.Context.Cookie: Sets the date and time when this cookie expires.

F

FAILED_DEPENDENCY_424 - Enum constant in enum class io.avaje.jex.http.HttpStatus
filter(Filter) - Method in interface io.avaje.jex.Routing: Add a filter for all matched requests.
filter(Context, HttpFilter.FilterChain) - Method in interface io.avaje.jex.http.HttpFilter: Asks this filter to pre/post-process the given request.
filter(HttpFilter) - Method in interface io.avaje.jex.Jex: Add a filter for all matched requests.
filter(HttpFilter) - Method in interface io.avaje.jex.Routing: Add a filter for all matched requests.
filters() - Method in interface io.avaje.jex.Routing: Return all the registered filters.
flush() - Method in class io.avaje.jex.core.json.JsonbOutput
FONT_OTF - Enum constant in enum class io.avaje.jex.http.ContentType
FONT_TTF - Enum constant in enum class io.avaje.jex.http.ContentType
FONT_WOFF - Enum constant in enum class io.avaje.jex.http.ContentType
FONT_WOFF2 - Enum constant in enum class io.avaje.jex.http.ContentType
FORBIDDEN_403 - Enum constant in enum class io.avaje.jex.http.HttpStatus
formParam(String) - Method in interface io.avaje.jex.http.Context: Return the first form param value for the specified key or null.
formParam(String, String) - Method in interface io.avaje.jex.http.Context: Return the first form param value for the specified key or the default value.
formParamMap() - Method in interface io.avaje.jex.http.Context: Returns a map with all the form param keys and values.
formParams(String) - Method in interface io.avaje.jex.http.Context: Return the form params for the specified key, or empty list.
FOUND_302 - Enum constant in enum class io.avaje.jex.http.HttpStatus
fromJdkFilter(Filter) - Static method in interface io.avaje.jex.http.HttpFilter: Convert a JDK Filter into a Jex HttpFilter.
fromJson(Type, byte[]) - Method in class io.avaje.jex.core.json.JacksonJsonService
fromJson(Type, byte[]) - Method in class io.avaje.jex.core.json.JsonbJsonService
fromJson(Type, byte[]) - Method in interface io.avaje.jex.spi.JsonService: Deserializes a json byte[] into a Java object of the specified type.
fromJson(Type, InputStream) - Method in class io.avaje.jex.core.json.JacksonJsonService
fromJson(Type, InputStream) - Method in class io.avaje.jex.core.json.JsonbJsonService
fromJson(Type, InputStream) - Method in interface io.avaje.jex.spi.JsonService: Deserializes a json input stream and deserializes it into a Java object of the specified type.
fullUrl() - Method in interface io.avaje.jex.http.Context: Return the full request url, including query string (if present)

G

GATEWAY_TIMEOUT_504 - Enum constant in enum class io.avaje.jex.http.HttpStatus
get(String, ExchangeHandler, Role...) - Method in interface io.avaje.jex.Jex: Adds a GET handler to the route configuration.
get(String, ExchangeHandler, Role...) - Method in interface io.avaje.jex.Routing: Adds a GET handler to the route configuration.
GET - Enum constant in enum class io.avaje.jex.Routing.Type
getHandler() - Method in interface io.avaje.jex.Routing.Entry: Return the handler.
getPath() - Method in interface io.avaje.jex.Routing.Entry: Return the full path of the entry.
getRoles() - Method in interface io.avaje.jex.Routing.Entry: Return the roles.
Getting Started - Search tag in Overview: Section
getType() - Method in interface io.avaje.jex.Routing.Entry: Return the type of entry.
GONE_410 - Enum constant in enum class io.avaje.jex.http.HttpStatus
group(String, Routing.HttpService) - Method in interface io.avaje.jex.Jex: Add a group of route handlers with a common path prefix.
group(String, Routing.HttpService) - Method in interface io.avaje.jex.Routing: Add a group of route handlers with a common path prefix.
gzipCompressionLevel(int) - Method in class io.avaje.jex.compression.CompressionConfig: Sets the default GZIP compression level.

H

handle(Context) - Method in interface io.avaje.jex.http.ExchangeHandler: Handles the given HTTP request and generates a response.
handle(Context, T) - Method in interface io.avaje.jex.http.ExceptionHandler: Error handling consumer.
handler(Consumer<SseClient>) - Static method in interface io.avaje.jex.http.sse.SseClient: Return an SseClient handler.
handlers() - Method in interface io.avaje.jex.Routing: Return all the registered handlers.
hashCode() - Method in record class io.avaje.jex.security.BasicAuthCredentials: Returns a hash code value for this object.
head(String, ExchangeHandler, Role...) - Method in interface io.avaje.jex.Routing: Adds a HEAD handler to the route configuration.
HEAD - Enum constant in enum class io.avaje.jex.Routing.Type
header(String) - Method in interface io.avaje.jex.http.Context: Return the request header value by name.
header(String, String) - Method in interface io.avaje.jex.http.Context: Set the response header.
header(String, List<String>) - Method in interface io.avaje.jex.http.Context: Set the response header.
headerMap() - Method in interface io.avaje.jex.http.Context: Return all the request headers as a map.
headerMap(Map<String, List<String>>) - Method in interface io.avaje.jex.http.Context: Sets the response headers using the provided map.
headers(Map<String, String>) - Method in interface io.avaje.jex.http.Context: Add the response headers using the provided map.
headerValues(String) - Method in interface io.avaje.jex.http.Context: Return the request headers.
health() - Method in interface io.avaje.jex.JexConfig: Returns whether the health endpoint is enabled.
health(boolean) - Method in interface io.avaje.jex.JexConfig: Enables/Disables the default health endpoint.
host() - Method in interface io.avaje.jex.http.Context: Returns the host name of the request.
host() - Method in interface io.avaje.jex.JexConfig: Returns the configured host.
host(String) - Method in interface io.avaje.jex.JexConfig: Set the host on which the HttpServer will bind to.
HOST - Static variable in class io.avaje.jex.core.Constants
html(String) - Method in interface io.avaje.jex.http.Context: Write html content to the response.
HTTP_VERSION_NOT_SUPPORTED_505 - Enum constant in enum class io.avaje.jex.http.HttpStatus
HttpFilter - Interface in io.avaje.jex.http: A filter used to pre/post-process incoming requests.
HttpFilter.FilterChain - Interface in io.avaje.jex.http: Filter chain that contains all subsequent filters that are configured, as well as the final route.
httpOnly() - Method in interface io.avaje.jex.http.Context.Cookie: Indicates if the HttpOnly attribute is enabled for this cookie.
httpOnly(boolean) - Method in interface io.avaje.jex.http.Context.Cookie: Sets the HttpOnly attribute for this cookie.
HttpResponseException - Exception Class in io.avaje.jex.http: Throwing an uncaught HttpResponseException will interrupt http processing and set the status code and response body with the given message or json body
HttpResponseException(int, Object) - Constructor for exception class io.avaje.jex.http.HttpResponseException: Create with a status and response that will sent as JSON.
HttpResponseException(int, String) - Constructor for exception class io.avaje.jex.http.HttpResponseException: Create with a status and message.
httpsConfig() - Method in interface io.avaje.jex.JexConfig: Return the HttpsConfigurator if https is enabled.
httpsConfig(HttpsConfigurator) - Method in interface io.avaje.jex.JexConfig: Enable https with the provided HttpsConfigurator
HttpStatus - Enum Class in io.avaje.jex.http: Http Status codes

I

I_AM_A_TEAPOT_418 - Enum constant in enum class io.avaje.jex.http.HttpStatus
ignoreTrailingSlashes() - Method in interface io.avaje.jex.JexConfig: Returns whether trailing slashes in request URIs are ignored.
ignoreTrailingSlashes(boolean) - Method in interface io.avaje.jex.JexConfig: Configures whether trailing slashes in request URIs should be ignored.
IMAGE_AVIF - Enum constant in enum class io.avaje.jex.http.ContentType
IMAGE_BMP - Enum constant in enum class io.avaje.jex.http.ContentType
IMAGE_GIF - Enum constant in enum class io.avaje.jex.http.ContentType
IMAGE_ICO - Enum constant in enum class io.avaje.jex.http.ContentType
IMAGE_JPEG - Enum constant in enum class io.avaje.jex.http.ContentType
IMAGE_PNG - Enum constant in enum class io.avaje.jex.http.ContentType
IMAGE_SVG - Enum constant in enum class io.avaje.jex.http.ContentType
IMAGE_TIFF - Enum constant in enum class io.avaje.jex.http.ContentType
IMAGE_WEBP - Enum constant in enum class io.avaje.jex.http.ContentType
initialStreamBufferSize() - Method in interface io.avaje.jex.JexConfig: The initial size of the response buffer
initialStreamBufferSize(int) - Method in interface io.avaje.jex.JexConfig: Set the initial size of the response stream buffer.
INSUFFICIENT_STORAGE_507 - Enum constant in enum class io.avaje.jex.http.HttpStatus
INTERNAL_SERVER_ERROR_500 - Enum constant in enum class io.avaje.jex.http.HttpStatus
InternalServerErrorException - Exception Class in io.avaje.jex.http: Thrown when server has an internal error
InternalServerErrorException(Object) - Constructor for exception class io.avaje.jex.http.InternalServerErrorException: Create with a status and response that will sent as JSON.
InternalServerErrorException(String) - Constructor for exception class io.avaje.jex.http.InternalServerErrorException: Create with a message.
io.avaje.jex - module io.avaje.jex: Defines the Jex HTTP server API, for running a minimal HTTP server.
io.avaje.jex - package io.avaje.jex: Avaje Jex API - see Jex.
io.avaje.jex.compression - package io.avaje.jex.compression: Classes Governing Http Compression
io.avaje.jex.core - package io.avaje.jex.core
io.avaje.jex.core.json - package io.avaje.jex.core.json: Optional JsonServices
io.avaje.jex.http - package io.avaje.jex.http: Http Constructs (Handlers, Filters, etc.)
io.avaje.jex.http.sse - package io.avaje.jex.http.sse: Server Sent Event Classes
io.avaje.jex.security - package io.avaje.jex.security: Security Classes
io.avaje.jex.spi - package io.avaje.jex.spi: SPI extension interfaces
ip() - Method in interface io.avaje.jex.http.Context: Returns the IP address of the client making the request.
isAlive() - Method in interface io.avaje.jex.AppLifecycle: Indicates whether the application server is currently starting or has started.
isReady() - Method in interface io.avaje.jex.AppLifecycle: Indicates whether the application server has fully started.

J

JacksonJsonService - Class in io.avaje.jex.core.json: Jackson JsonService
JacksonJsonService() - Constructor for class io.avaje.jex.core.json.JacksonJsonService: Create with defaults for Jackson
JacksonJsonService(ObjectMapper) - Constructor for class io.avaje.jex.core.json.JacksonJsonService: Create with a Jackson instance that might have custom configuration.
Jex - Interface in io.avaje.jex: Create configure and start Jex.
Jex.Server - Interface in io.avaje.jex: The running server.
JexConfig - Interface in io.avaje.jex: Jex configuration interface.
JexExtension - Interface in io.avaje.jex.spi: Extension point for all Jex SPI interfaces
JexPlugin - Interface in io.avaje.jex.spi: A plugin that can register things like routes, exception handlers and configure the current Jex instance.
json(Object) - Method in interface io.avaje.jex.http.Context: Set the content type as application/json and write the response.
jsonb(JsonType<T>, T) - Method in interface io.avaje.jex.http.Context: Optimized json write using avaje jsonb
JsonbJsonService - Class in io.avaje.jex.core.json: Provides JsonService using avaje-jsonb.
JsonbJsonService() - Constructor for class io.avaje.jex.core.json.JsonbJsonService: Create with defaults for Jsonb.
JsonbJsonService(Jsonb) - Constructor for class io.avaje.jex.core.json.JsonbJsonService: Create with a Jsonb instance that might have custom configuration.
JsonbOutput - Class in io.avaje.jex.core.json: avaje-jsonb output that allows for writing fixed length content straight from the avaje-jsonb buffer, avoiding the jex side buffer.
jsonResponse() - Method in exception class io.avaje.jex.http.HttpResponseException: Return the response body that will sent as JSON.
jsonService() - Method in interface io.avaje.jex.http.Context: Returns the configured JsonService instance.}
jsonService() - Method in interface io.avaje.jex.JexConfig: Returns the configured JSON service.
jsonService(JsonService) - Method in interface io.avaje.jex.Jex: Sets the JSON service to use for serialization and deserialization.
jsonService(JsonService) - Method in interface io.avaje.jex.JexConfig: Sets the JSON service used for (de)serialization.
JsonService - Interface in io.avaje.jex.spi: Service responsible for handling JSON-based request and response bodies.
jsonStream(Iterator<E>) - Method in interface io.avaje.jex.http.Context: Write the stream as a JSON stream with new line delimiters application/x-json-stream.
jsonStream(Stream<E>) - Method in interface io.avaje.jex.http.Context: Write the stream as a JSON stream with new line delimiters application/x-json-stream.
JSON Support - Search tag in Overview: Section

K

keepAlive() - Method in interface io.avaje.jex.http.sse.SseClient: By blocking the SSE connection, you can share this client outside the handler to notify it from other sources.
Key Concepts - Search tag in Overview: Section

L

Lax - Enum constant in enum class io.avaje.jex.http.Context.Cookie.SameSite
LENGTH_REQUIRED_411 - Enum constant in enum class io.avaje.jex.http.HttpStatus
lifecycle() - Method in interface io.avaje.jex.Jex: Return the application lifecycle support.
LOCATION - Static variable in class io.avaje.jex.core.Constants
LOCKED_423 - Enum constant in enum class io.avaje.jex.http.HttpStatus
LOOP_DETECTED_508 - Enum constant in enum class io.avaje.jex.http.HttpStatus

M

matchedPath() - Method in interface io.avaje.jex.http.Context: Returns the matched path as a raw expression, without any parameter substitution.
maxAge() - Method in interface io.avaje.jex.http.Context.Cookie: Returns the maximum age (in seconds) of this cookie.
maxAge(Duration) - Method in interface io.avaje.jex.http.Context.Cookie: Sets the maximum age (in seconds) of this cookie.
maxStreamBufferSize() - Method in interface io.avaje.jex.JexConfig: the maximum size of the response stream buffer.
maxStreamBufferSize(long) - Method in interface io.avaje.jex.JexConfig: Set the maximum size of the response stream buffer.
method() - Method in interface io.avaje.jex.http.Context: Returns the HTTP method used in the request (e.g., GET, POST, PUT, DELETE).
METHOD_NOT_ALLOWED_405 - Enum constant in enum class io.avaje.jex.http.HttpStatus
minSizeForCompression() - Method in class io.avaje.jex.compression.CompressionConfig: Gets the minimum size for compression.
minSizeForCompression(int) - Method in class io.avaje.jex.compression.CompressionConfig: Sets the minimum size for compression and returns the updated configuration.
MISDIRECTED_REQUEST_421 - Enum constant in enum class io.avaje.jex.http.HttpStatus
MOVED_PERMANENTLY_301 - Enum constant in enum class io.avaje.jex.http.HttpStatus
MULTI_STATUS_207 - Enum constant in enum class io.avaje.jex.http.HttpStatus
MULTIPART_FORM_DATA - Enum constant in enum class io.avaje.jex.http.ContentType

N

name() - Method in interface io.avaje.jex.http.Context.Cookie: Returns the name of this cookie.
NETWORK_AUTHENTICATION_REQUIRED_511 - Enum constant in enum class io.avaje.jex.http.HttpStatus
NO_CONTENT_204 - Enum constant in enum class io.avaje.jex.http.HttpStatus
NON_AUTHORITATIVE_INFORMATION_203 - Enum constant in enum class io.avaje.jex.http.HttpStatus
None - Enum constant in enum class io.avaje.jex.http.Context.Cookie.SameSite
NOT_ACCEPTABLE_406 - Enum constant in enum class io.avaje.jex.http.HttpStatus
NOT_EXTENDED_510 - Enum constant in enum class io.avaje.jex.http.HttpStatus
NOT_FOUND_404 - Enum constant in enum class io.avaje.jex.http.HttpStatus
NOT_IMPLEMENTED_501 - Enum constant in enum class io.avaje.jex.http.HttpStatus
NOT_MODIFIED_304 - Enum constant in enum class io.avaje.jex.http.HttpStatus
NotFoundException - Exception Class in io.avaje.jex.http: Thrown when unable to find a route/resource
NotFoundException(Object) - Constructor for exception class io.avaje.jex.http.NotFoundException: Create with a response that will sent as JSON.
NotFoundException(String) - Constructor for exception class io.avaje.jex.http.NotFoundException: Create with a message.

O

of(Context) - Static method in class io.avaje.jex.core.json.JsonbOutput
of(String, String) - Static method in interface io.avaje.jex.http.Context.Cookie: Creates and returns a new cookie with the given name and value.
OK_200 - Enum constant in enum class io.avaje.jex.http.HttpStatus
onClose(Runnable) - Method in interface io.avaje.jex.http.sse.SseClient: Add a callback that will be called either when connection is closed through SseClient.close(), or when the Emitter is detected as closed.
onShutdown(Runnable) - Method in interface io.avaje.jex.AppLifecycle: Registers a runnable to be executed when the application server is shutting down.
onShutdown(Runnable) - Method in interface io.avaje.jex.Jex.Server: Register a function to execute LAST on shutdown after all the normal lifecycle shutdown functions have run.
onShutdown(Runnable, int) - Method in interface io.avaje.jex.AppLifecycle: Registers a runnable to be executed when the application server is shutting down, with a specific order.
options(String, ExchangeHandler, Role...) - Method in interface io.avaje.jex.Jex: Adds an OPTIONS handler to the route configuration.
options(String, ExchangeHandler, Role...) - Method in interface io.avaje.jex.Routing: Adds an OPTIONS handler to the route configuration.
OPTIONS - Enum constant in enum class io.avaje.jex.Routing.Type
outputStream() - Method in interface io.avaje.jex.http.Context: Return the outputStream to write content.

P

PARTIAL_CONTENT_206 - Enum constant in enum class io.avaje.jex.http.HttpStatus
partitioned() - Method in interface io.avaje.jex.http.Context.Cookie: Indicates if the Partitioned attribute is enabled for this cookie.
partitioned(boolean) - Method in interface io.avaje.jex.http.Context.Cookie: Set the Partitioned attribute for this cookie.
password() - Method in record class io.avaje.jex.security.BasicAuthCredentials: Returns the value of the password record component.
patch(String, ExchangeHandler, Role...) - Method in interface io.avaje.jex.Jex: Adds a PATCH handler to the route configuration.
patch(String, ExchangeHandler, Role...) - Method in interface io.avaje.jex.Routing: Adds a PATCH handler to the route configuration.
PATCH - Enum constant in enum class io.avaje.jex.Routing.Type
path() - Method in interface io.avaje.jex.http.Context.Cookie: Returns the path on the server for which this cookie is valid.
path() - Method in interface io.avaje.jex.http.Context: Returns the path part of the request URI.
path(String) - Method in interface io.avaje.jex.http.Context.Cookie: Sets the path on the server for which this cookie is valid.
pathParam(String) - Method in interface io.avaje.jex.http.Context: Return the path parameter.
Path Parameters - Search tag in Overview: Section
pathParamMap() - Method in interface io.avaje.jex.http.Context: Return all the path parameters as a map.
PAYMENT_REQUIRED_402 - Enum constant in enum class io.avaje.jex.http.HttpStatus
PERMANENT_REDIRECT_308 - Enum constant in enum class io.avaje.jex.http.HttpStatus
plugin(JexPlugin) - Method in interface io.avaje.jex.Jex: Adds a plugin to the Jex instance, extending its functionality.
port() - Method in interface io.avaje.jex.http.Context: Returns the port number used in the request.
port() - Method in interface io.avaje.jex.Jex.Server: The port of the server
port() - Method in interface io.avaje.jex.JexConfig: Returns the configured port number.
port(int) - Method in interface io.avaje.jex.Jex: Sets the port number on which the Jex server will listen for incoming requests.
port(int) - Method in interface io.avaje.jex.JexConfig: Sets the port number on which the HttpServer will listen for incoming requests. *
post(String, ExchangeHandler, Role...) - Method in interface io.avaje.jex.Jex: Adds a POST handler to the route configuration.
post(String, ExchangeHandler, Role...) - Method in interface io.avaje.jex.Routing: Adds a POST handler to the route configuration.
POST - Enum constant in enum class io.avaje.jex.Routing.Type
PRECONDITION_FAILED_412 - Enum constant in enum class io.avaje.jex.http.HttpStatus
PRECONDITION_REQUIRED_428 - Enum constant in enum class io.avaje.jex.http.HttpStatus
proceed() - Method in interface io.avaje.jex.http.HttpFilter.FilterChain: Calls the next filter in the chain, or else the user's exchange handler, if this is the final filter in the chain.
protocol() - Method in interface io.avaje.jex.http.Context: Returns the protocol used in the request (e.g., HTTP/1.1).
PROXY_AUTHENTICATION_REQUIRED_407 - Enum constant in enum class io.avaje.jex.http.HttpStatus
put(String, ExchangeHandler, Role...) - Method in interface io.avaje.jex.Jex: Adds a PUT handler to the route configuration.
put(String, ExchangeHandler, Role...) - Method in interface io.avaje.jex.Routing: Adds a PUT handler to the route configuration.
PUT - Enum constant in enum class io.avaje.jex.Routing.Type

Q

queryParam(String) - Method in interface io.avaje.jex.http.Context: Return the first query parameter value.
queryParam(String, String) - Method in interface io.avaje.jex.http.Context: Return the first query parameter value or the default value if it does not exist.
queryParamMap() - Method in interface io.avaje.jex.http.Context: Return all the query parameters as a map.
queryParams(String) - Method in interface io.avaje.jex.http.Context: Return all the query parameters for the given parameter name.
queryString() - Method in interface io.avaje.jex.http.Context: Return the request query string, or null.

R

redirect(String) - Method in interface io.avaje.jex.http.Context: Redirects the client to the specified location using a 302 (Found) status code.
redirect(String, int) - Method in interface io.avaje.jex.http.Context: Redirects the client to the specified location using the given HTTP status code.
RedirectException - Exception Class in io.avaje.jex.http: Thrown when redirecting
RedirectException(String) - Constructor for exception class io.avaje.jex.http.RedirectException: Create with a message.
register(TemplateRender, String...) - Method in interface io.avaje.jex.Jex: Explicitly register a template renderer.
registerShutdownHook(Runnable) - Method in interface io.avaje.jex.AppLifecycle: Registers a runnable as a shutdown hook with the JVM.
removeCookie(String) - Method in interface io.avaje.jex.http.Context: Removes a cookie with the specified name.
removeCookie(String, String) - Method in interface io.avaje.jex.http.Context: Removes a cookie with the specified name and path.
render(Context, String, Map<String, Object>) - Method in interface io.avaje.jex.spi.TemplateRender: Render the template and model typically as html to the given context.
render(String) - Method in interface io.avaje.jex.http.Context: Render a template typically as html.
render(String, Map<String, Object>) - Method in interface io.avaje.jex.http.Context: Render a template typically as html with the given model.
renderer(String, TemplateRender) - Method in interface io.avaje.jex.JexConfig: Registers a template renderer for a specific file extension.
renderers() - Method in interface io.avaje.jex.JexConfig: Returns a map of registered template renderers, keyed by file extension.
REQUEST_ENTITY_TOO_LARGE_413 - Enum constant in enum class io.avaje.jex.http.HttpStatus
REQUEST_TIMEOUT_408 - Enum constant in enum class io.avaje.jex.http.HttpStatus
REQUEST_URI_TOO_LONG_414 - Enum constant in enum class io.avaje.jex.http.HttpStatus
REQUESTED_RANGE_NOT_SATISFIABLE_416 - Enum constant in enum class io.avaje.jex.http.HttpStatus
Request Handling - Search tag in Overview: Section
requestHeaders() - Method in interface io.avaje.jex.http.Context: Return underlying request headers.
RESET_CONTENT_205 - Enum constant in enum class io.avaje.jex.http.HttpStatus
responseHeader(String) - Method in interface io.avaje.jex.http.Context: Returns the value of the specified response header.
responseHeaders() - Method in interface io.avaje.jex.http.Context: Return underlying response headers.
responseHeaderValues(String) - Method in interface io.avaje.jex.http.Context: Returns the value of the specified response header.
responseSent() - Method in interface io.avaje.jex.http.Context: Return true if the response has been sent.
Role - Interface in io.avaje.jex.security: Marker interface for roles used in route declarations.
routeRoles() - Method in interface io.avaje.jex.http.Context: Returns a set of roles associated with the current route.
routing() - Method in interface io.avaje.jex.Jex: Returns the routing configuration object, allowing for further customization.
routing(Routing.HttpService) - Method in interface io.avaje.jex.Jex: Adds a new HTTP route and its associated handler to the Jex routing configuration.
routing(Collection<Routing.HttpService>) - Method in interface io.avaje.jex.Jex: Adds multiple HTTP routes and their associated handlers to the Jex routing configuration.
Routing - Interface in io.avaje.jex: Routing abstraction.
Routing.Entry - Interface in io.avaje.jex: A routing entry.
Routing.HttpService - Interface in io.avaje.jex: Adds to the Routing.
Routing.Type - Enum Class in io.avaje.jex: The type of route entry.

S

sameSite() - Method in interface io.avaje.jex.http.Context.Cookie: Return the SameSite setting.
sameSite(Context.Cookie.SameSite) - Method in interface io.avaje.jex.http.Context.Cookie: Set the SameSite setting for this cookie.
scheme() - Method in interface io.avaje.jex.http.Context: Return the request scheme.
scheme() - Method in interface io.avaje.jex.JexConfig: Return the schema as http or https.
secure() - Method in interface io.avaje.jex.http.Context.Cookie: Indicates whether this cookie should only be sent over secure connections (HTTPS).
secure(boolean) - Method in interface io.avaje.jex.http.Context.Cookie: Sets the secure attribute for this cookie.
SEE_OTHER_303 - Enum constant in enum class io.avaje.jex.http.HttpStatus
sendComment(String) - Method in interface io.avaje.jex.http.sse.SseClient: Attempt to send a comment.
sendEvent(Object) - Method in interface io.avaje.jex.http.sse.SseClient: Calls SseClient.sendEvent(String, Object, String) with event set to "message"
sendEvent(String, Object) - Method in interface io.avaje.jex.http.sse.SseClient: Calls SseClient.sendEvent(String, Object, String) with id set to null
sendEvent(String, Object, String) - Method in interface io.avaje.jex.http.sse.SseClient: Attempt to send an event.
serverProvider() - Method in interface io.avaje.jex.JexConfig: Provide the provider used to create the HttpServer instance.
serverProvider(HttpServerProvider) - Method in interface io.avaje.jex.JexConfig: Configure Provider used to created HttpServer instances.
Server-Sent Events - Search tag in Overview: Section
SERVICE_UNAVAILABLE_503 - Enum constant in enum class io.avaje.jex.http.HttpStatus
shutdown() - Method in interface io.avaje.jex.Jex.Server: Shutdown the server.
socketBacklog() - Method in interface io.avaje.jex.JexConfig: Return the socket backlog.
socketBacklog(int) - Method in interface io.avaje.jex.JexConfig: Set the socket backlog.
sse(String, Consumer<SseClient>, Role...) - Method in interface io.avaje.jex.Jex: Adds an SSE handler to the route configuration.
sse(String, Consumer<SseClient>, Role...) - Method in interface io.avaje.jex.Routing: Adds an SSE handler to the route configuration.
SseClient - Interface in io.avaje.jex.http.sse: A client for Server-Sent Events (SSE).
sslSession() - Method in interface io.avaje.jex.http.Context: Get the SSLSession for this exchange.
start() - Static method in interface io.avaje.jex.AvajeJex: Start Jex server using @Controller with avaje-inject, avaje-http, avaje-config.
start() - Method in interface io.avaje.jex.Jex: Start the server.
start(BeanScope) - Static method in interface io.avaje.jex.AvajeJex: Start Jex server using @Controller with avaje-inject, avaje-http, avaje-config.
start(Jex) - Static method in class io.avaje.jex.core.BootstrapServer
STARTED - Enum constant in enum class io.avaje.jex.AppLifecycle.Status
STARTING - Enum constant in enum class io.avaje.jex.AppLifecycle.Status
status() - Method in interface io.avaje.jex.AppLifecycle: Returns the current status of the application server.
status() - Method in interface io.avaje.jex.http.Context: Return the current response status.
status() - Method in exception class io.avaje.jex.http.HttpResponseException: Return the status code.
status() - Method in enum class io.avaje.jex.http.HttpStatus
status(int) - Method in interface io.avaje.jex.http.Context: Set the status code on the response.
status(AppLifecycle.Status) - Method in interface io.avaje.jex.AppLifecycle: Sets the current status of the application server.
status(HttpStatus) - Method in interface io.avaje.jex.http.Context: Set the status code on the response.
STOPPED - Enum constant in enum class io.avaje.jex.AppLifecycle.Status
STOPPING - Enum constant in enum class io.avaje.jex.AppLifecycle.Status
Strict - Enum constant in enum class io.avaje.jex.http.Context.Cookie.SameSite
SWITCHING_PROTOCOLS_101 - Enum constant in enum class io.avaje.jex.http.HttpStatus

T

TemplateRender - Interface in io.avaje.jex.spi: Template rendering typically of html.
TEMPORARY_REDIRECT_307 - Enum constant in enum class io.avaje.jex.http.HttpStatus
terminated() - Method in interface io.avaje.jex.http.sse.SseClient: Returns true if SseClient.close() has been called.
text(String) - Method in interface io.avaje.jex.http.Context: Write plain text content to the response.
TEXT_CSS - Enum constant in enum class io.avaje.jex.http.ContentType
TEXT_CSV - Enum constant in enum class io.avaje.jex.http.ContentType
TEXT_HTML - Enum constant in enum class io.avaje.jex.http.ContentType
TEXT_HTML - Static variable in class io.avaje.jex.core.Constants
TEXT_HTML_UTF8 - Static variable in class io.avaje.jex.core.Constants
TEXT_JS - Enum constant in enum class io.avaje.jex.http.ContentType
TEXT_MARKDOWN - Enum constant in enum class io.avaje.jex.http.ContentType
TEXT_PLAIN - Enum constant in enum class io.avaje.jex.http.ContentType
TEXT_PLAIN - Static variable in class io.avaje.jex.core.Constants
TEXT_PLAIN_UTF8 - Static variable in class io.avaje.jex.core.Constants
TEXT_PROPERTIES - Enum constant in enum class io.avaje.jex.http.ContentType
TEXT_XML - Enum constant in enum class io.avaje.jex.http.ContentType
toJson(Object, OutputStream) - Method in class io.avaje.jex.core.json.JacksonJsonService
toJson(Object, OutputStream) - Method in class io.avaje.jex.core.json.JsonbJsonService
toJson(Object, OutputStream) - Method in interface io.avaje.jex.spi.JsonService: **Writes a Java Object as JSON to an OutputStream**
toJsonStream(Iterator<E>, OutputStream) - Method in interface io.avaje.jex.spi.JsonService: Serializes a stream of Java objects into a JSON-Stream format, using the x-json-stream media type.
toJsonStream(Iterator<T>, OutputStream) - Method in class io.avaje.jex.core.json.JacksonJsonService
toJsonStream(Iterator<T>, OutputStream) - Method in class io.avaje.jex.core.json.JsonbJsonService
toJsonString(Object) - Method in class io.avaje.jex.core.json.JacksonJsonService
toJsonString(Object) - Method in class io.avaje.jex.core.json.JsonbJsonService
toJsonString(Object) - Method in interface io.avaje.jex.spi.JsonService: **Writes a Java Object as a JSON string**
TOO_MANY_REQUESTS_429 - Enum constant in enum class io.avaje.jex.http.HttpStatus
toString() - Method in interface io.avaje.jex.http.Context.Cookie: Returns content of the cookie as a 'Set-Cookie:' header value specified by RFC6265.
toString() - Method in record class io.avaje.jex.security.BasicAuthCredentials: Returns a string representation of this record class.
trace(String, ExchangeHandler, Role...) - Method in interface io.avaje.jex.Routing: Adds a TRACE handler to the route configuration.
TRACE - Enum constant in enum class io.avaje.jex.Routing.Type

U

UNAUTHORIZED_401 - Enum constant in enum class io.avaje.jex.http.HttpStatus
UNPROCESSABLE_CONTENT_422 - Enum constant in enum class io.avaje.jex.http.HttpStatus
UNSUPPORTED_MEDIA_TYPE_415 - Enum constant in enum class io.avaje.jex.http.HttpStatus
unwrapOutputStream() - Method in class io.avaje.jex.core.json.JsonbOutput
UPGRADE_REQUIRED_426 - Enum constant in enum class io.avaje.jex.http.HttpStatus
uri() - Method in interface io.avaje.jex.http.Context: Return the request uri.
USE_PROXY_305 - Enum constant in enum class io.avaje.jex.http.HttpStatus
USER_AGENT - Static variable in class io.avaje.jex.core.Constants
userAgent() - Method in interface io.avaje.jex.http.Context: Return the request user agent, or null.
userName() - Method in record class io.avaje.jex.security.BasicAuthCredentials: Returns the value of the userName record component.

V

value() - Method in interface io.avaje.jex.http.Context.Cookie: Returns the value stored in this cookie.
valueOf(String) - Static method in enum class io.avaje.jex.AppLifecycle.Status: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.avaje.jex.http.ContentType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.avaje.jex.http.Context.Cookie.SameSite: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.avaje.jex.http.HttpStatus: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.avaje.jex.Routing.Type: Returns the enum constant of this class with the specified name.
values() - Static method in enum class io.avaje.jex.AppLifecycle.Status: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.avaje.jex.http.ContentType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.avaje.jex.http.Context.Cookie.SameSite: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.avaje.jex.http.HttpStatus: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.avaje.jex.Routing.Type: Returns an array containing the constants of this enum class, in the order they are declared.
VIDEO_AVI - Enum constant in enum class io.avaje.jex.http.ContentType
VIDEO_MP4 - Enum constant in enum class io.avaje.jex.http.ContentType
VIDEO_MPEG - Enum constant in enum class io.avaje.jex.http.ContentType
VIDEO_OGG - Enum constant in enum class io.avaje.jex.http.ContentType
VIDEO_WEBM - Enum constant in enum class io.avaje.jex.http.ContentType

W

write(byte[]) - Method in interface io.avaje.jex.http.Context: Writes the given bytes directly to the response.
write(byte[], int) - Method in interface io.avaje.jex.http.Context: Writes the given length of bytes from this buffer directly to the response.
write(byte[], int, int) - Method in class io.avaje.jex.compression.CompressedOutputStream
write(byte[], int, int) - Method in class io.avaje.jex.core.json.JsonbOutput
write(int) - Method in class io.avaje.jex.compression.CompressedOutputStream
write(InputStream) - Method in interface io.avaje.jex.http.Context: Writes the content from the given InputStream directly to the response body.
write(String) - Method in interface io.avaje.jex.http.Context: Writes the given string content directly to the response.
writeLast(byte[], int, int) - Method in class io.avaje.jex.core.json.JsonbOutput

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form