All Classes and Interfaces
Class
Description
A thing which can have named attachments.
Handler responsible for checking of confidentiality is required for the requested resource and if so rejecting the request
and redirecting to a secure address.
A base class for
SecurityContext implementations predominantly focusing on the notification handling allowing the
specific implementation for focus on authentication.To reduce allocations we use a custom linked list data structure
Base class responsible for associating the
SecurityContext instance with the current request.Handler that can accept or reject a request based on an attribute of the remote peer
todo: should we support non-regex values for performance reasons?
Access log handler.
Interface that is used by the access log handler to send data to the log file manager.
Representation of an account, most likely a user account.
Handler that allows certain HTTP methods.
A thing which can have named attachments.
Handler that adds an attachment to the request
An immutable, type-safe object attachment key.
Interface that represents a persistent authenticated session.
This is the final
HttpHandler in the security chain, it's purpose is to act as a barrier at the end of the chain to
ensure authenticate is called after the mechanisms have been associated with the context and the constraint checked.Handler responsible for checking the constraints for the current request and marking authentication as required if
applicable.
Enumeration of tokens expected in a HTTP Digest 'Authentication-Info' header.
The interface to be implemented by a single authentication mechanism.
The AuthenticationOutcome is used by an AuthenticationMechanism to indicate the outcome of the call to authenticate, the
overall authentication process will then used this along with the current AuthenticationState to decide how to proceed
with the current request.
Simple class to wrap the result of requesting a mechanism sends it's challenge.
An Undertow
SecurityContext that uses Undertow AuthenticationMechanism
instances for authentication.Factory for authentication mechanisms.
Authentication handler that adds one or more authentication
mechanisms to the security context
Enumeration to indicate the authentication mode in use.
Predicate that returns true if authentication is required.
Exception that is thrown when bad request is detected
The authentication handler responsible for BASIC authentication as described by RFC2617
Basic SSL session information.
General bit-affecting utility methods.
A
HttpHandler that initiates a blocking request.Callback that allows the bytes read from or written to a stream to be tracked
Represents a byte range for a range request
Handler for Range requests.
The bytes sent
HttpHandler responsible for setting up the AuthenticatedSessionManager for cached authentications and
registering a NotificationReceiver to receive the security notifications.An
AuthenticationMechanism which uses any cached AuthenticatedSessionManager.AuthenticatedSessions.Utility class for dealing with certificates
Handler wrapper that chains several handler wrappers together.
The Client Cert based authentication mechanism.
Exchange attribute that represents a combination of attributes that should be merged into a single string.
A concurrent deque that allows direct item removal without traversal.
Handler that pushes resources based on a provided URL
This class provides the connector part of the
HttpServerExchange API.Connector level statistics
Exchange attribute that represents a fixed value
Returns true if the request header is present and contains one of the strings to match.
A HTTP cookie.
A cookie
Class that contains utility methods for dealing with cookies.
A basic copy on write map.
Representation of a users Credential.
Deprecated.
The current time
Utility for parsing and generating dates
Log Receiver that stores logs in a directory under the specified file name, and rotates them after
midnight.
A resource supplier that just delegates directly to a resource manager
Listener interface for default response handlers.
Enumeration of the supported digest algorithms.
HttpHandler to handle HTTP Digest authentication, both according to RFC-2617 and draft update to allow additional
algorithms to be used.Enumeration of tokens expected in a HTTP Digest 'Authorization' header.
An extension of
Credential to provide some additional methods needed to enable verification of a request where
DigestAuthenticationMechanism is in use.Enumeration to represent the Digest quality of protection options.
Enumeration of tokens expected in a HTTP Digest 'WWW_Authenticate' header.
A non-blocking buffer cache where entries are indexed by a path and are made up of a
subsequence of blocks in a fixed large direct buffer.
DirectByteBufferDeallocator Utility class used to free direct buffer memory.Constant Content
Handler that disables response caching by browsers and proxies.
Handler that disallows certain HTTP methods.
Handler that eagerly parses form data.
Returns true if all the provided arguments are equal to each other
Handler that dispatches to a given handler and allows mapping exceptions
to be handled by additional handlers.
Representation of a string attribute from a HTTP server exchange.
An interface that knows how to build an exchange attribute from a textual representation.
Attribute parser for exchange attributes.
Utility class for retrieving exchange attributes
Interface that can be used to wrap an exchange attribute.
Listener interface for events that are run at the completion of a request/response
cycle (i.e.
Returns true if the given attribute is not null and not an empty string
Parser that transforms an extended access log format string into a
Undertow access log format string.
Authentication mechanism that uses an externally provided principal.
Representation of an external credential.
A modified version of ConcurrentLinkedDeque which includes direct
removal.
A file resource
Serves files from the file system.
An efficient and flexible Base64 implementation.
Controls the decoding process.
An input stream which decodes bytes as they are read from a stream with Base64 encoded data.
An output stream which decodes base64 data written to it, and writes the decoded output to the
wrapped inner stream.
Controls the encoding process.
An input stream which encodes bytes as they are read from a stream.
An output stream which base64 encodes all passed data and writes it to the wrapped target output stream.
Representation of form data.
Parser for form data.
Parser definition for form encoded data.
Factory class that can create a form data parser for a given request.
Handler that implements rfc7239 Forwarded header
A authentication mechanism that requires the presence of two headers in the request.
Handler that allows for graceful server shutdown.
A listener which can be registered with the handler to be notified when all pending requests have finished.
AuthenticationMechanism for GSSAPI / SPNEGO based authentication.The GSSAPIServerSubjectFactory is a factory responsible for returning the
Subject that should be used for handing the
GSSAPI based authentication for a specific request.A
Credential to wrap an established GSSContext.Interface that provides a way of providing a textual representation of a handler.
Parser that can build a handler from a string representation.
Utility class with convenience methods for dealing with handlers
Interface that can be used to wrap the handler chains, adding additional handlers.
Deprecated.
Representation of a token allowed within a header.
Utility to parse the tokens contained within a HTTP header.
A utility class for mapping between byte arrays and their hex representation and back again.
The request scheme
Exchange attachments that have specific meaning when using the HTTP getProtocol
Class that provides support for dealing with HTTP 100 (Continue) responses.
Handler that provides support for HTTP/1.1 continue responses.
Deprecated.
A handler for an HTTP request.
An HTTP server request/response exchange.
Deprecated.
TODO: this should not be required, delete this
A handler that handles HTTP trace requests
Server side upgrade handler.
A predicate that returns true if the request is idempotent
according to the HTTP RFC.
The IdentityManager interface to be implemented by an identity manager implementation providing user verification and
identity loading to Undertow.
The ident username, not used, included for apache access log compatibility
AuthenticationMechanismFactory that simply returns a pre configured AuthenticationMechanismThe default in memory session manager.
General I/O utility methods.
Handler that can accept or reject a request based on the IP address of the remote peer.
Access log receiver that logs messages at INFO level.
Handler that appends the JVM route to the session id.
Class that contains static constants and utility methods for legacy Set-Cookie format.
A limited buffer pooled allocator.
A registry of listeners, and the services that are exposed via these listeners.
Utility methods for getting the locale from a request.
The local IP address
A handler that performs DNS lookup to resolve a local address.
The local port
The local server name
Interface that generates the header for an access log.
A non-blocking cache where entries are indexed by a key.
Exception that is thrown when multipart parsing cannot parse a request
Predicate that returns true if the Content-Size of a request is above a
given value.
Deprecated.
Handler that records some metrics
Predicate that returns true if the Content-Size of a request is below a
given value.
A
HttpHandler that implements virtual hosts based on the Host: http header
header.A NonceManager is used by the HTTP Digest authentication mechanism to request nonces and to validate the nonces sent from the
client.
The interface to be interested by classes interested in processing security related notifications.
A
HttpHandler to register a list of NotificationReceiver instances with the current SecurityContext.A cookie
A pool of objects.
Interface that represents an open listener, aka a connector.
A handler for the HTTP Origin (RFC 6454) header.
Exception that is thrown if the max query or path parameter limit is exceeded
A Credential representing the password of an Account.
Handler that dispatches to a given handler based of a prefix match of the path.
Handler that dispatches to a given handler based of a prefix match of the path.
Path parameter
Session config that is based on a path parameter and URL rewriting
A path resource
Serves files from the file system.
A handler that translates non slash separator characters in the URL into a slash.
Represents a parsed web socket path template.
A handler that matches URI templates
Deprecated.
The result of a path template match.
Utility class that provides fast path matching of path templates.
A handler that performs reverse DNS lookup to resolve a peer address
Deprecated.
Represents a generic pooled object
A modified version of ConcurrentLinkedDequeue which includes direct
removal and is portable accorss all JVMs.
A resource supplier that allows pre-compressed resources to be served if the client accepts the request.
A predicate.
An interface that knows how to build a predicate from a textual representation.
Handler that sets up the predicate context
Parser for the undertow-handlers.conf file.
Parser that can build a predicate from a string representation.
Utility class used for creating predicates
Handler that can deal with a large number of predicates.
Deprecated.
Handler that sets the peer address to the value of the X-Forwarded-For header.
Query parameter
Methods for dealing with the query string
The query string
Exchange attribute that wraps string attributes in quotes.
Utility class for parsing headers that accept q values
A resource implementation that
An exception that is thrown when an attribute is read only
Utility class for building redirects.
A redirect handler that redirects to the specified location via a 302 redirect.
A predicate that does a regex match against an exchange.
The relative path
The remote Host address (if resolved)
The remote IP address
The remote user
Handler that dumps a exchange to a log.
A request header
Represents a limit on a number of running requests.
A handler which limits the maximum number of concurrent requests.
The request line
The request method
The request getProtocol
The request scheme
The request URL
Representation of a static resource.
An event that is fired when a resource is modified
Watched file event types.
Representation of a resource manager.
Interface that allows for more flexibility when resolving a resource than is currently provided
by
ResourceManager.The request status code
A handler which simply sets a response code.
Callback that is invoked just before the response is commit
A response header
Handler that limits the download rate
The response time
This will only work if
UndertowOptions.RECORD_REQUEST_START_TIME has been setClass that contains utility methods for dealing with RFC6265 Cookies.
A Handler that handles the common case of routing via path template and method name.
Handler that will set the SameSite flag to response cookies
A utility class that can check known user agents which are known to be incompatible with SameSite=None attribute.
Sets the
Handler that will set the secure flag on all cookies that are received over a secure connection
A
SessionIdGenerator that uses a secure random to generate a
session ID.The security context.
Deprecated.
Instead extend AbstractSecurityContextAssociationHandler to provide alternative contexts.
Default
SecurityContextFactory implementation.The internal SecurityContext used to hold the state of security for the current exchange.
The security handler responsible for attaching the SecurityContext to the current
HttpServerExchange.Notification representing a security event such as a successful or failed authentication.
Represents a HTTP session.
Handler that attaches the session to the request.
Interface that abstracts the process of attaching a session to an exchange.
Encapsulation of session cookie configuration.
Strategy for generating session ID's.
A listener for session events.
Utility class that maintains the session listeners.
Interface that manages sessions.
Optional interface that can be implemented by
SessionManager
implementations that provides session manager statistics.An extension to the
NonceManager interface for Nonce managers that also support the association of a pre-prepared
hash against a currently valid nonce.Utility class for working with sessions.
Handler that can set an arbitrary attribute on the exchange.
Set a fixed response header.
Handler that generates an extremely simple no frills error page
A default
NonceManager implementation to provide reasonable single host management of nonces.Simple pool that attempts to maintain a specified number of objects in the pool.
An extension to
AbstractConfidentialityHandler that uses the Host header from the incoming message and specifies the
confidential address by just switching the port.Authenticator that can be used to configure single sign on.
Handler that sets SSL information on the connection based on the following headers:
Session config that stores the session ID in the current SSL session.
A handler that buffers the full response and attaches it to the exchange.
This valve allows to detect requests that take a long time to process, which might
indicate that the thread that is processing it is stuck.
A string keyed map that can be accessed as a substring, eliminating the need to allocate a new string
to do a key comparison against.
The thread name
The request method
An exception indicating that the response channel was prematurely closed.
Convenience class used to build an Undertow server.
log messages start at 5000
Warning this class consists of generated code.
Warning this class consists of generated code.
log messages start at 5000
Warning this class consists of generated code.
Warning this class consists of generated code.
A handler that will decode the URL and query parameters to the specified charset.
Utilities for dealing with URLs
A
Credential implementation which wraps an X.509 certificate.