Index

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

A

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.
addGroup() - Method in interface io.avaje.jex.Routing.Group
Add the group of entries with a common prefix.
after(Consumer<Context>) - Method in interface io.avaje.jex.Routing
Add a post-processing filter for all requests.
allowsForCompression(String) - Method in class io.avaje.jex.compression.CompressionConfig
Determines if a given content type is allowed for compression.
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(Class<T>) - Method in interface io.avaje.jex.Jex
Returns a custom attribute previously set using Jex.attribute(Class, Object).
attribute(Class<T>, T) - Method in interface io.avaje.jex.Jex
Sets a custom attribute that can be accessed later by the Jex instance or its components.
attribute(String) - Method in interface io.avaje.jex.Context
Gets the attribute with the specified key from the request.
attribute(String, Object) - Method in interface io.avaje.jex.Context
Sets an attribute on the request, accessible to other handlers in the request lifecycle.

B

BAD_GATEWAY - Enum constant in enum class io.avaje.jex.http.ErrorCode
 
BAD_REQUEST - Enum constant in enum class io.avaje.jex.http.ErrorCode
 
BadRequestException - Exception Class in io.avaje.jex.http
Thrown when unable to find a route/resource
BadRequestException(String) - Constructor for exception class io.avaje.jex.http.BadRequestException
 
BANDWIDTH_LIMIT_EXCEEDED - Enum constant in enum class io.avaje.jex.http.ErrorCode
 
basicAuthCredentials() - Method in interface io.avaje.jex.Context
Gets basic-auth credentials from the request, or throws.
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.Routing
Add a pre-processing filter for all requests.
body() - Method in interface io.avaje.jex.Context
Return the request body as String.
bodyAsBytes() - Method in interface io.avaje.jex.Context
Returns the request body as a byte array.
bodyAsClass(Class<T>) - Method in interface io.avaje.jex.Context
Return the request body as bean.
bodyAsInputStream() - Method in interface io.avaje.jex.Context
Returns the request body as an input stream.
BootJex - Interface in io.avaje.jex
Start Jex using @Controller and avaje-inject, avaje-http, avaje-config.

C

CLASS_PATH - Enum constant in enum class io.avaje.jex.StaticContentConfig.ResourceLocation
 
ClassResourceLoader - Interface in io.avaje.jex
Loading resources from the classpath or module path.
close() - Method in class io.avaje.jex.compression.CompressedOutputStream
 
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 class 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 - 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.
configure(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 - Enum constant in enum class io.avaje.jex.http.ErrorCode
 
contentLength() - Method in interface io.avaje.jex.Context
Return the request content length.
contentType() - Method in interface io.avaje.jex.Context
Return the request content type.
contentType(String) - Method in interface io.avaje.jex.Context
Set the response content type.
context(String) - Method in interface io.avaje.jex.Jex
Sets the context path for the Jex application.
Context - Interface in io.avaje.jex
Provides access to functions for handling the request and response.
Context.Cookie - Interface in io.avaje.jex
This interface represents a cookie used in HTTP communication.
contextPath() - Method in interface io.avaje.jex.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.JexConfig
Set the contextPath.
cookie(Context.Cookie) - Method in interface io.avaje.jex.Context
Sets a cookie using the provided Context.Cookie object.
cookie(String) - Method in interface io.avaje.jex.Context
Returns the value of a cookie with the specified name from the request.
cookie(String, String) - Method in interface io.avaje.jex.Context
Sets a cookie with the specified name and value, with no expiration date.
cookie(String, String, int) - Method in interface io.avaje.jex.Context
Sets a cookie with the specified name, value, and maximum age in seconds.
cookieMap() - Method in interface io.avaje.jex.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.
create() - Static method in interface io.avaje.jex.StaticContentConfig
Create and return a new static content configuration.
createHandler() - Method in interface io.avaje.jex.StaticContentConfig
Return a new ExchangeHandler that will serve the resources

D

defaultExtensions() - Method in interface io.avaje.jex.spi.TemplateRender
Return the extensions this template renders for by default.
delete(String, ExchangeHandler) - Method in interface io.avaje.jex.Routing
Add a DELETE handler.
DELETE - Enum constant in enum class io.avaje.jex.Routing.Type
 
directoryIndex(String) - Method in interface io.avaje.jex.StaticContentConfig
Sets the index file to be served when a directory is requests.
disableCompression() - Method in class io.avaje.jex.compression.CompressionConfig
Disables compression.
disableSpiPlugins() - Method in interface io.avaje.jex.JexConfig
Disables auto-configuring the current instance with JexPlugin loaded using the ServiceLoader.
domain() - Method in interface io.avaje.jex.Context.Cookie
Returns the domain for which this cookie is valid.
domain(String) - Method in interface io.avaje.jex.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.Routing
Registers an error handler that handles the given type of exceptions.
ErrorCode - Enum Class in io.avaje.jex.http
Http Error Status codes
errorHandlers() - Method in interface io.avaje.jex.Routing
Return all the registered Exception Handlers.
ExceptionHandler<T> - Interface in io.avaje.jex
The routing error handler.
exchange() - Method in interface io.avaje.jex.Context
Return the underlying JDK HttpExchange object backing the context
ExchangeHandler - Interface in io.avaje.jex
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.
expired(String) - Static method in interface io.avaje.jex.Context.Cookie
Creates and returns a new expired cookie with the given name.
expires() - Method in interface io.avaje.jex.Context.Cookie
Returns the date and time when this cookie expires.
expires(ZonedDateTime) - Method in interface io.avaje.jex.Context.Cookie
Sets the date and time when this cookie expires.

F

FILE - Enum constant in enum class io.avaje.jex.StaticContentConfig.ResourceLocation
 
filter(Context, HttpFilter.FilterChain) - Method in interface io.avaje.jex.HttpFilter
Asks this filter to pre/post-process the given request.
filter(HttpFilter) - Method in interface io.avaje.jex.Routing
Add a filter for all requests.
filters() - Method in interface io.avaje.jex.Routing
Return all the registered filters.
FORBIDDEN - Enum constant in enum class io.avaje.jex.http.ErrorCode
 
formParam(String) - Method in interface io.avaje.jex.Context
Return the first form param value for the specified key or null.
formParam(String, String) - Method in interface io.avaje.jex.Context
Return the first form param value for the specified key or the default value.
formParamMap() - Method in interface io.avaje.jex.Context
Returns a map with all the form param keys and values.
formParams(String) - Method in interface io.avaje.jex.Context
Return the form params for the specified key, or empty list.
fromClass(Class<?>) - Static method in interface io.avaje.jex.ClassResourceLoader
Create a ClassResourceLoader instance based on a given Class.
fullUrl() - Method in interface io.avaje.jex.Context
Return the full request url, including query string (if present)

G

GATEWAY_TIMEOUT - Enum constant in enum class io.avaje.jex.http.ErrorCode
 
get(String, ExchangeHandler) - Method in interface io.avaje.jex.Routing
Add a GET handler.
GET - Enum constant in enum class io.avaje.jex.Routing.Type
 
getDetails() - Method in exception class io.avaje.jex.http.HttpResponseException
 
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.
getStatus() - Method in exception class io.avaje.jex.http.HttpResponseException
 
getType() - Method in interface io.avaje.jex.Routing.Entry
Return the type of entry.
GONE - Enum constant in enum class io.avaje.jex.http.ErrorCode
 
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.ExchangeHandler
Handles the given HTTP request and generates a response.
handle(Context, T) - Method in interface io.avaje.jex.ExceptionHandler
Error handling consumer.
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) - Method in interface io.avaje.jex.Routing
Add a HEAD handler.
HEAD - Enum constant in enum class io.avaje.jex.Routing.Type
 
header(String) - Method in interface io.avaje.jex.Context
Return the request header.
header(String, String) - Method in interface io.avaje.jex.Context
Set the response header.
header(String, List<String>) - Method in interface io.avaje.jex.Context
Set the response header.
headerMap() - Method in interface io.avaje.jex.Context
Return all the request headers as a map.
headerMap(Map<String, List<String>>) - Method in interface io.avaje.jex.Context
Sets the response headers using the provided map.
headers() - Method in interface io.avaje.jex.Context
Return underlying request headers.
headers(Map<String, String>) - Method in interface io.avaje.jex.Context
Add the response headers using the provided map.
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.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.
html(String) - Method in interface io.avaje.jex.Context
Write html content to the response.
HTTP_VERSION_NOT_SUPPORTED - Enum constant in enum class io.avaje.jex.http.ErrorCode
 
HttpFilter - Interface in io.avaje.jex
A filter used to pre/post-process incoming requests.
HttpFilter.FilterChain - Interface in io.avaje.jex
Filter chain that contains all subsequent filters that are configured, as well as the final route.
httpOnly() - Method in interface io.avaje.jex.Context.Cookie
Checks if the HttpOnly attribute is enabled for this cookie.
httpOnly(boolean) - Method in interface io.avaje.jex.Context.Cookie
Sets the HttpOnly attribute for this cookie.
httpPath() - Method in interface io.avaje.jex.StaticContentConfig
Gets the current HTTP path.
httpPath(String) - Method in interface io.avaje.jex.StaticContentConfig
Sets the HTTP path for the static resource handler.
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
HttpResponseException(int, String) - Constructor for exception class io.avaje.jex.http.HttpResponseException
 
HttpResponseException(int, String, Map<String, String>) - Constructor for exception class io.avaje.jex.http.HttpResponseException
 
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

I

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.
INSUFFICIENT_STORAGE - Enum constant in enum class io.avaje.jex.http.ErrorCode
 
INTERNAL_SERVER_ERROR - Enum constant in enum class io.avaje.jex.http.ErrorCode
 
InternalServerErrorException - Exception Class in io.avaje.jex.http
Thrown when unable to find a route/resource
InternalServerErrorException(String) - Constructor for exception class io.avaje.jex.http.InternalServerErrorException
 
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.json - package io.avaje.jex.core.json
Optional JsonServices
io.avaje.jex.http - package io.avaje.jex.http
Http Exceptions
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.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.Context
Set the content type as application/json and write the response.
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.
jsonRead(Class<T>, InputStream) - Method in class io.avaje.jex.core.json.JacksonJsonService
 
jsonRead(Class<T>, InputStream) - Method in class io.avaje.jex.core.json.JsonbJsonService
 
jsonRead(Class<T>, InputStream) - Method in interface io.avaje.jex.spi.JsonService
**Reads JSON from an InputStream**
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.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.Context
Write the stream as a JSON stream with new line delimiters application/x-json-stream.
jsonWrite(Object, OutputStream) - Method in class io.avaje.jex.core.json.JacksonJsonService
 
jsonWrite(Object, OutputStream) - Method in class io.avaje.jex.core.json.JsonbJsonService
 
jsonWrite(Object, OutputStream) - Method in interface io.avaje.jex.spi.JsonService
**Writes a Java Object as JSON to an OutputStream**
jsonWriteStream(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.
jsonWriteStream(Iterator<T>, OutputStream) - Method in class io.avaje.jex.core.json.JacksonJsonService
 
jsonWriteStream(Iterator<T>, OutputStream) - Method in class io.avaje.jex.core.json.JsonbJsonService
 

L

lifecycle() - Method in interface io.avaje.jex.Jex
Return the application lifecycle support.
loadResource(String) - Method in interface io.avaje.jex.ClassResourceLoader
Loads the specified resource and returns its URL.
loadResourceAsStream(String) - Method in interface io.avaje.jex.ClassResourceLoader
Loads the specified resource and returns an input stream to read its contents.
location(StaticContentConfig.ResourceLocation) - Method in interface io.avaje.jex.StaticContentConfig
Sets the resource location (CLASSPATH or FILE).
LOOP_DETECTED - Enum constant in enum class io.avaje.jex.http.ErrorCode
 

M

matchedPath() - Method in interface io.avaje.jex.Context
Returns the matched path as a raw expression, without any parameter substitution.
maxAge() - Method in interface io.avaje.jex.Context.Cookie
Returns the maximum age (in seconds) of this cookie.
maxAge(Duration) - Method in interface io.avaje.jex.Context.Cookie
Sets the maximum age (in seconds) of this cookie.
message() - Method in enum class io.avaje.jex.http.ErrorCode
 
method() - Method in interface io.avaje.jex.Context
Returns the HTTP method used in the request (e.g., GET, POST, PUT, DELETE).
METHOD_NOT_ALLOWED - Enum constant in enum class io.avaje.jex.http.ErrorCode
 
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.

N

name() - Method in interface io.avaje.jex.Context.Cookie
Returns the name of this cookie.
NETWORK_AUTHENTICATION_REQUIRED - Enum constant in enum class io.avaje.jex.http.ErrorCode
 
NOT_EXTENDED - Enum constant in enum class io.avaje.jex.http.ErrorCode
 
NOT_FOUND - Enum constant in enum class io.avaje.jex.http.ErrorCode
 
NotFoundException - Exception Class in io.avaje.jex.http
Thrown when unable to find a route/resource
NotFoundException(String) - Constructor for exception class io.avaje.jex.http.NotFoundException
 

O

of(String, String) - Static method in interface io.avaje.jex.Context.Cookie
Creates and returns a new cookie with the given name and value.
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) - Method in interface io.avaje.jex.Routing
Add an OPTIONS handler.
OPTIONS - Enum constant in enum class io.avaje.jex.Routing.Type
 
outputStream() - Method in interface io.avaje.jex.Context
Return the outputStream to write content.

P

password() - Method in record class io.avaje.jex.security.BasicAuthCredentials
Returns the value of the password record component.
patch(String, ExchangeHandler) - Method in interface io.avaje.jex.Routing
Add a PATCH handler.
PATCH - Enum constant in enum class io.avaje.jex.Routing.Type
 
path() - Method in interface io.avaje.jex.Context.Cookie
Returns the path on the server for which this cookie is valid.
path() - Method in interface io.avaje.jex.Context
Returns the path part of the request URI.
path(String) - Method in interface io.avaje.jex.Context.Cookie
Sets the path on the server for which this cookie is valid.
path(String, Routing.Group) - Method in interface io.avaje.jex.Routing
Add a group of route handlers with a common path prefix.
pathParam(String) - Method in interface io.avaje.jex.Context
Return the path parameter.
pathParamMap() - Method in interface io.avaje.jex.Context
Return all the path parameters as a map.
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.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) - Method in interface io.avaje.jex.Routing
Add a POST handler.
POST - Enum constant in enum class io.avaje.jex.Routing.Type
 
proceed() - Method in interface io.avaje.jex.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.Context
Returns the protocol used in the request (e.g., HTTP/1.1).
put(String, ExchangeHandler) - Method in interface io.avaje.jex.Routing
Add a PUT handler.
PUT - Enum constant in enum class io.avaje.jex.Routing.Type
 
putMimeTypeMapping(String, String) - Method in interface io.avaje.jex.StaticContentConfig
Adds a new MIME type mapping to the configuration.
putResponseHeader(String, String) - Method in interface io.avaje.jex.StaticContentConfig
Adds a new response header to the configuration.

Q

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

R

redirect(String) - Method in interface io.avaje.jex.Context
Redirects the client to the specified location using a 302 (Found) status code.
redirect(String, int) - Method in interface io.avaje.jex.Context
Redirects the client to the specified location using the given HTTP status code.
REDIRECT - Enum constant in enum class io.avaje.jex.http.ErrorCode
 
RedirectException - Exception Class in io.avaje.jex.http
Thrown when redirecting
RedirectException(String) - Constructor for exception class io.avaje.jex.http.RedirectException
 
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.Context
Removes a cookie with the specified name.
removeCookie(String, String) - Method in interface io.avaje.jex.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.Context
Render a template typically as html.
render(String, Map<String, Object>) - Method in interface io.avaje.jex.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_TIMEOUT - Enum constant in enum class io.avaje.jex.http.ErrorCode
 
resource(String) - Method in interface io.avaje.jex.StaticContentConfig
Sets the file to serve, or the folder your files are located in.
resourceLoader(ClassResourceLoader) - Method in interface io.avaje.jex.StaticContentConfig
Sets a custom resource loader for loading class/module path resources.
responseHeader(String) - Method in interface io.avaje.jex.Context
Returns the value of the specified response header.
responseSent() - Method in interface io.avaje.jex.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.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.Group - Interface in io.avaje.jex
A group of routing entries prefixed by a common path.
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

scheme() - Method in interface io.avaje.jex.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.Context.Cookie
Indicates whether this cookie should only be sent over secure connections (HTTPS).
secure(boolean) - Method in interface io.avaje.jex.Context.Cookie
Sets the secure attribute for this cookie.
SERVICE_UNAVAILABLE - Enum constant in enum class io.avaje.jex.http.ErrorCode
 
shutdown() - Method in interface io.avaje.jex.Jex.Server
Shutdown the server.
skipFilePredicate(Predicate<Context>) - Method in interface io.avaje.jex.StaticContentConfig
Sets a predicate to filter files based on the request context.
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.
start() - Static method in interface io.avaje.jex.BootJex
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.BootJex
Start Jex server using @Controller with avaje-inject, avaje-http, avaje-config.
STARTED - Enum constant in enum class io.avaje.jex.AppLifecycle.Status
 
STARTING - Enum constant in enum class io.avaje.jex.AppLifecycle.Status
 
StaticContentConfig - Interface in io.avaje.jex
Builder for a static resource exchange handler.
StaticContentConfig.ResourceLocation - Enum Class in io.avaje.jex
Resource location
staticResource(StaticContentConfig) - Method in interface io.avaje.jex.Jex
Adds a static resource route using the provided configuration.
staticResource(Consumer<StaticContentConfig>) - Method in interface io.avaje.jex.Jex
Adds a static resource route using a consumer to configure the StaticContentConfig.
status() - Method in interface io.avaje.jex.AppLifecycle
Returns the current status of the application server.
status() - Method in interface io.avaje.jex.Context
Return the current response status.
status() - Method in enum class io.avaje.jex.http.ErrorCode
 
status(int) - Method in interface io.avaje.jex.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.
STOPPED - Enum constant in enum class io.avaje.jex.AppLifecycle.Status
 
STOPPING - Enum constant in enum class io.avaje.jex.AppLifecycle.Status
 

T

TemplateRender - Interface in io.avaje.jex.spi
Template rendering typically of html.
text(String) - Method in interface io.avaje.jex.Context
Write plain text content to the response.
toString() - Method in interface io.avaje.jex.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) - Method in interface io.avaje.jex.Routing
Add a TRACE handler.
TRACE - Enum constant in enum class io.avaje.jex.Routing.Type
 

U

UNAUTHORIZED - Enum constant in enum class io.avaje.jex.http.ErrorCode
 
url() - Method in interface io.avaje.jex.Context
Return the request url.
userAgent() - Method in interface io.avaje.jex.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.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.ErrorCode
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.
valueOf(String) - Static method in enum class io.avaje.jex.StaticContentConfig.ResourceLocation
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.ErrorCode
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.
values() - Static method in enum class io.avaje.jex.StaticContentConfig.ResourceLocation
Returns an array containing the constants of this enum class, in the order they are declared.
VARIANT_ALSO_NEGOTIATES - Enum constant in enum class io.avaje.jex.http.ErrorCode
 

W

withRoles(Role...) - Method in interface io.avaje.jex.Routing
Specify permittedRoles for the last added handler using varargs.
withRoles(Set<Role>) - Method in interface io.avaje.jex.Routing
Specify permittedRoles for the last added handler.
write(byte[]) - Method in interface io.avaje.jex.Context
Writes the given bytes directly to the response.
write(byte[], int, int) - Method in class io.avaje.jex.compression.CompressedOutputStream
 
write(int) - Method in class io.avaje.jex.compression.CompressedOutputStream
 
write(InputStream) - Method in interface io.avaje.jex.Context
Writes the content from the given InputStream directly to the response body.
write(String) - Method in interface io.avaje.jex.Context
Writes the given string content directly to the response.
A B C D E F G H I J L M N O P Q R S T U V W 
All Classes and Interfaces|All Packages|Serialized Form