All Classes and Interfaces
Class
Description
AbsoluteOrdering
A convenience base implementation of
Connection.Provides the common handling for
ConnectionFactory implementations.An abstract implementation of
Connector that provides a ConnectionFactory mechanism
for creating Connection instances for various protocols (HTTP, SSL, etc).AbstractContextProvider
AbstractDatabaseLoginModule
DiscoverableAnnotationHandler
Base class for handling the discovery of an annotation.
Partial implementation of EndPoint that uses
FillInterest and WriteFlusher.Deprecated.
Deprecated.
AbstractLeakPreventer
Abstract base class for code that seeks to avoid pinning of webapp classloaders by using the jetty classloader to
proactively call the code that pins them (generally pinned as static data members, or as static
data members that are daemon threads (which use the context classloader)).
Basic implementation of the life cycle interface for components.
Deprecated.
this class is redundant now that
LifeCycle.Listener has default methods.AbstractLoginModule
Abstract base class for all
LoginModules.AbstractLoginService
Base class for LoginServices that allows subclasses to provide the user authentication and authorization information,
but provides common behaviour such as handling authentication.
Abstract implementation of
MessageSink.An
AbstractConnection that also implements ConnectionMetaData with fixed
local and remote addresses.An abstract Network Connector.
Abstract base class for proxy servlets.
Utility class that implement transparent proxy functionalities.
Abstract implementation of
RetainableByteBuffer with
reference counting.AbstractSessionCache
A base implementation of the
SessionCache interface for managing a set of
Session objects pertaining to a context in memory.AbstractSessionCacheFactory
Base class for SessionCacheFactories.
AbstractSessionDataStore
AbstractSessionDataStoreFactory
AbstractSessionHandler
Class to implement most non-servlet-spec specific session behaviour.
A Listener that limits the rate at which new connections are accepted
An adaptive execution strategy that uses the
Invocable status
of both the task and the current thread to select an optimal strategy
that prioritizes executing the task immediately in the current
producing thread if it can be done so without thread starvation issues.A specialized transformer for
AsyncMiddleManServlet that performs
the transformation when the whole content has been received.Interface to check aliases.
An
X509ExtendedKeyManager that select a key with desired alias,
delegating other processing to a nested X509ExtendedKeyManager.This will approve any alias to anything inside of the
ContextHandlers resource base which
is not protected by a protected target as defined by the ContextHandler protected targets at start.Client-side interface used by ServiceLoader.
Server-side interface used by ServiceLoader.
Configuration for Annotations
Extend the AnnotationConfiguration to support OSGi:
Look for annotations inside WEB-INF/lib and also in the fragments and required bundles.
ParserTask
ServletContainerInitializerComparator
ServletContainerInitializerOrdering
Simple class to capture elapsed time of an operation.
AnnotationDecorator
AnnotationIntrospector
Introspects a class to find various types of
annotations as defined by the servlet specification.
AbstractIntrospectableAnnotationHandler
Base class for handlers that introspect a class to find a particular annotation.
IntrospectableAnnotationHandler
Interface for all handlers that wish to introspect a class to find a particular annotation
AnnotationParser
Convenience base class to provide no-ops for all Handler methods.
Immutable information gathered by parsing class header.
Immutable information gathered by parsing a field on a class.
Signature for all handlers that respond to parsing class files.
Immutable information gathered by parsing a method on a class.
ASM visitor for a class.
An ASM visitor for parsing Fields.
ASM Visitor for parsing a method.
The information about an App that is managed by the
DeploymentManager.AppContextLeakPreventer
Cause the classloader that is pinned by AppContext.getAppContext() to be
a container or system classloader, not a webapp classloader.
The lifecycle of an App in the
DeploymentManager.Object responsible for providing
Apps to the DeploymentManagerA
RetainableByteBuffer pool where RetainableByteBuffers are held in Pools that are
held in array elements.A variant of the
ArrayByteBufferPool that
uses buckets of buffers that increase in size by a power of
2 (e.g.A variant of
ArrayByteBufferPool that tracks buffer
acquires/releases, useful to identify buffer leaks.Utility methods for Array manipulation
A
Content.Source that is also a Content.Sink.A non-blocking JSON parser that can parse partial JSON strings.
The state of JSON parsing.
The factory that creates AsyncJSON instances.
Servlet 3.1 asynchronous proxy servlet with capability
to intercept and modify request/response content.
Allows applications to transform upstream and downstream content.
Convenience extension of
AsyncMiddleManServlet that offers transparent proxy functionalities.Servlet 3.1 asynchronous proxy servlet.
Convenience extension of
AsyncProxyServlet that offers transparent proxy functionalities.An asynchronously writing RequestLogWriter
An AtomicLong with additional methods to treat it as two hi/lo integers.
Abstract mechanism to support attachment of miscellaneous objects.
An Attributes implementation that holds it's values in an immutable
ContainerLifeCycleNormalize Attribute to String.
Attributes.
An
Attributes implementation backed by another Attributes instance, which is treated as immutable, but with a
ConcurrentHashMap used as a mutable layer over it.An
Attributes implementation that lazily creates a backing map iff it is actually needed.An Attributes implementation backed by a
ConcurrentHashMap.An abstract implementation of
Attributes.Wrapper that provides a mechanism
for synthetic attributes that can be modified or deleted.A Wrapper of attributes
Deprecated.
Authentication represents a mechanism to authenticate requests for protected resources.Structure holding information about the
WWW-Authenticate (or Proxy-Authenticate) header.Authentication.Result holds the information needed to authenticate a Request via Authentication.Result.apply(Request).The Authentication state of a request.
Authentication is Deferred, either so that credentials can later be passed
with
AuthenticationState.login(String, String, Request, Response); or that existing
credentials on the request may be validated with AuthenticationState.Deferred.authenticate(Request);
or an authentication dialog can be advanced with AuthenticationState.Deferred.authenticate(Request, Response, Callback).A tag interface used to identify a
Response that might be passed to
Authenticator.validateRequest(Request, Response, Callback) while
doing deferred authentication when a challenge cannot be sent.Authentication Response sent state.
The
SecurityHandler will use this to wrap the Request.A successful Authentication with User information.
A store for
Authentications and Authentication.Results.Authenticator Interface
Authenticator Configuration
Authenticator Factory
Reentrant lock that can be used in a try-with-resources statement.
A reentrant lock with a condition that can be used in a try-with-resources statement.
AWTLeakPreventer
See https://issues.jboss.org/browse/AS7-3733
The java.awt.Toolkit class has a static field that is the default toolkit.
Exception thrown to indicate a Bad HTTP Message has either been received
or attempted to be generated.
Exception to terminate the connection because it has received data within a frame payload that was not consistent with the requirements of that frame
payload.
Exception to terminate the connection because it has received data within a frame payload that was not consistent with the requirements of that frame
payload.
Simple abstract module implementing a Jakarta Authentication
ServerAuthModule and ServerAuthContext.Build a start configuration in
${jetty.base}, including
ini files, directories, and libs.
A catalog implementation where the
xml:base is defined externally
of the catalog XML, allowing for runtime determination of the xml:base
(such as pointing to the contents of a remote location)AbstractHolder
Base class for all servlet-related classes that may be lazily instantiated (eg servlet, filter,
listener), and/or require metadata to be held regarding their origin
(web.xml, annotation, programmatic api etc).
File access for
${jetty.home}, ${jetty.base}, directories.Copy a file found in
BaseHome from a URI of the form
"basehome:some/path"
FileInitializerImplementation of the HTTP "Basic" authentication defined in RFC 2617.
Basic authentication result.
A
ServerAuthModule implementation of HTTP Basic Authentication.Parser for the BEGIN_REQUEST frame content.
Behavior for how the WebSocket should operate.
BindingEnumeration
A shared reusable Blocking source.
A BlockingQueue backed by a circular array capable or growing.
The base parser for the frame body of HTTP/2 frames.
The base parser for the frame body of HTTP/3 frames.
Default implementation of the
Decoder.Text Message to Boolean decoder.Default encoder for
Boolean to Encoder.Text Message encoderA
Content.Sink backed by another Content.Sink.
A Handler that can apply a
mechanism to buffer the entire response content until the output is closed.
A flow control strategy that accumulates updates and emits window control
frames when the accumulated value reaches a threshold.
Implementation of
Response.Listener that buffers the content up to a maximum length
specified to the constructors.Buffer utility methods.
BundleClassLoaderHelper
BundleClassLoaderHelperFactory
Get a class loader helper adapted for the particular osgi environment.
BundleContextProvider
BundleFileLocatorHelper
BundleFileLocatorHelperFactory
Obtain a helper for locating files based on the bundle.
BundleProvider
Jetty DeploymentManager Provider api for webapps or ContextHandlers that are discovered as osgi bundles.
BundleWebAppProvider
ByteArrayEndPoint.
Byte Array ISO 8859 writer.
A
MessageSink implementation that accumulates BINARY frames
into a message that is then delivered to the application function
passed to the constructor in the form of a byte[].ByteArrayOutputStream with public internals
Accumulates data into a list of ByteBuffers which can then be combined into a single buffer or written to an OutputStream.
Aggregates data into a single ByteBuffer of a specified maximum size.
This class can be used to accumulate pairs of
ByteBuffer and Callback, and eventually copy
these into a single ByteBuffer or byte array and succeed the callbacks.A
Content.Source backed by one or more ByteBuffers.Present a ByteBuffer as an InputStream.
A
MessageSink implementation that accumulates BINARY frames
into a message that is then delivered to the application function
passed to the constructor in the form of a ByteBuffer.Simple wrapper of a ByteBuffer as an OutputStream.
This class implements an output stream in which the data is written into a list of ByteBuffer,
the buffer list automatically grows as data is written to it, the buffers are taken from the
supplied
ByteBufferPool or freshly allocated if one is not supplied.A pool for
RetainableByteBuffer instances.Accumulates a sequence of
RetainableByteBuffer that
are typically created during the generation of protocol bytes.A
ByteBufferPool that does not pool its
RetainableByteBuffers.A wrapper for
ByteBufferPool instances.A
Request.Content for ByteBuffers.Default implementation of the
Decoder.Text Message to Byte decoderDefault encoder for
Byte to Encoder.Text Message encoderA representation of a byte range as specified by
RFC 7233.
A
Request.Content for byte arrays.HttpContent.Factory implementation that wraps any other HttpContent.Factory instance
using it as a caching authority.CachingSessionDataStore
A SessionDataStore is a mechanism for (persistently) storing data associated with sessions.
CachingSessionDataStoreFactory
A WebAppClassLoader that caches
CachingWebAppClassLoader.getResource(String) results.A callback abstraction that handles completed/failed events of asynchronous operations.
A callback object that handles success/failure events of asynchronous operations.
A
CompletableFuture that is also a Callback.A
Callback that is also a CompletableFuture.A Callback implementation that calls the
Callback.Completing.completed() method when it either succeeds or fails.Nested Completing Callback that completes after
completing the nested callback
CDI Configuration
A DecoratingListener that listens for "org.eclipse.jetty.cdi.decorator"
A
ServletContainerInitializer that introspects for a CDI API
implementation within a web application and applies an integration
mode if CDI is found.A Decorator that invokes the CDI provider within a webapp to decorate objects created by
the contexts
DecoratedObjectFactory
(typically Listeners, Filters and Servlets).Convenience class to handle validation of certificates, aliases and keystores
Allows specifying Certificate Revocation List (CRL), as well as enabling
CRL Distribution Points Protocol (CRLDP) certificate extension support,
and also enabling On-Line Certificate Status Protocol (OCSP) support.
Default implementation of the
Decoder.Text Message to Character decoderDefault encoder for
Character to Encoder.Text Message encoderBuild a string from a sequence of bytes and/or characters.
Extended Utf8StringBuilder that mimics
CodingErrorAction.REPORT behaviour
for CharsetStringBuilder methods.An accumulator of
Content.Chunks used to facilitate minimal copy
aggregation of multiple chunks.A
Content.Source backed by one or more Content.Chunks.ClassInheritanceHandler
As asm scans for classes, remember the type hierarchy.
ClassLoadingObjectInputStream
For re-inflating serialized objects, this class uses the thread context classloader
rather than the jvm's default classloader selection.
A matcher for classes based on package and/or location and/or module/
Class to handle CLASSPATH construction
ClassVisibilityChecker
Interface to be implemented by classes capable of checking class visibility
for a context.
Factory for client-side
Connection instances.Wraps another ClientConnectionFactory.
A holder for a list of protocol strings identifiers
(for example
["h2", "h2-17", "h2-16"]) and a
ClientConnectionFactory that creates connections
that speak an application protocol such as HTTP.Representation of the
HTTP/2 application protocol used by HttpClientTransportDynamic.Representation of the
HTTP/3 application protocol used by HttpClientTransportDynamic.The client-side component that connects to server sockets.
Deprecated, for removal: This API element is subject to removal in a future version.
replaced by
TransportDeprecated, for removal: This API element is subject to removal in a future version.
replaced by
TransportClient specific implementation of
ProtocolSession.Client-side
QuicConfiguration with client-specific settings.The client specific implementation of
QuicConnection.The client specific implementation of
QuicSession.Client based UpgradeRequest API
This is an extension to
DoSFilter that uses Jetty APIs to
abruptly close the connection when the request times out.A record that captures error code and error reason.
The set of close states for a stream or a session.
Representation of a WebSocket Close (status code & reason)
Configuration Source representing the Command Line arguments.
Rewrites the URI by compacting to remove occurrences of
//.A
BufferingResponseListener that sends a Request
and returns a CompletableFuture that is completed when
CompletableResponseListener.onComplete(Result) is called.A
CompletableFuture that implements Runnable to perform
a one-shot task that eventually completes this CompletableFuture.A HttpStream wrapper that keeps a list of listeners.
A Compliance Violation represents a requirement of an RFC, specification or Jetty implementation
that may be allowed to be violated if it is included in a
ComplianceViolation.Mode.A listener that can be notified of violations.
A Mode is a set of
ComplianceViolations that are allowed.Common components made available via a
RequestA
Pool implementation that uses a primary pool which overflows to a secondary pool.A concurrent implementation of
Pool.A Pool entry that holds metadata and a pooled object.
The type of the strategy to use for the pool.
A
Handler.Wrapper that conditionally handles a Request.An Abstract
ConditionalHandler.A
Predicate over Request that tests the name of the
connector obtained from Request.getConnectionMetaData()An implementation of
ConditionalHandler that, if conditions are met, will not do any further
handling by returning false from ConditionalHandler.DontHandle.onConditionsMet(Request, Response, Callback).An abstract implementation of
ConditionalHandler that, if conditions are not met, will call
the ConditionalHandler.nextHandler(Request, Response, Callback) from ConditionalHandler.ElseNext.onConditionsNotMet(Request, Response, Callback).A
Predicate over Request that tests an InetAddressPattern
against the getRemoteSocketAddress() of
Request.getConnectionMetaData().An implementation of
ConditionalHandler that, if conditions are met, will reject
the request by sending a response (by default a HttpStatus.FORBIDDEN_403).An implementation of
ConditionalHandler that, if conditions are met, will skip the next Handler by
invoking its next Handler.A Configuration Source
Weighted List of ConfigSources.
Implementations allow to configure WebSocket parameters.
A pluggable Configuration for
WebAppContexts.A ConfigurationProcessor for non XmlConfiguration format files.
An ordered list of
Configuration instances.Associate a JSR Endpoint with its optional
EndpointConfigImplementation of a
Handler that supports HTTP CONNECT.Connection represent a connection to a Destination and allow applications to send
requests via Connection.send(Request, Response.CompleteListener).A
Connection is associated to an EndPoint so that I/O events
happening on the EndPoint can be processed by the Connection.A Listener for connection events.
Connection implementations implement this interface when they
can upgrade from the protocol they speak (for example HTTP/1.1)
to a different protocol (e.g.Connection implementations implement this interface when they
can be upgraded to the protocol they speak (e.g.A Factory to create
Connection instances for Connectors.A ConnectionFactory that can configure the connector.
Connections created by this factory MUST implement
Connection.UpgradeTo.The possible outcomes of the
ConnectionFactory.Detecting.detect(ByteBuffer) method.A Listener that limits the number of Connections.
Client-side connection pool abstraction.
Factory for ConnectionPool instances.
Marks a connection as supporting multiplexed requests.
Marks a connection as being usable for a maximum number of requests.
A
Connection.Listener that tracks connection statistics.A
Connector accept connections and data from remote peers,
and allows applications to send data to remote peers, by setting up
the machinery needed to handle such tasks.LifeCycle wrapper for JMXConnectorServer.
A
Throwable that may be used in static contexts.A Security constraint that is applied to a request, which contain:
A name
Authorization to specify if authentication is needed and what roles are applicable
An optional list of role names used for
Constraint.Authorization.KNOWN_ROLE
A Transport constraint, indicating if it must be secure or not.
The Authorization applied to any authentication of the request/
Builder for Constraint.
The constraints requirement for the transport
ConstraintSecurityHandler
A Container
Inherited Listener.
A listener for Container events.
The "Container Default Configurator" per the JSR-356 spec.
Utility Methods for manual execution of
ServletContainerInitializer when
using Embedded Jetty.ContainerInitializerAnnotationHandler
A ContainerLifeCycle is an
LifeCycle implementation for a collection of contained beans.Namespace class that contains the definitions of a
content source,
a content sink and a content chunk.A chunk of content indicating whether it is the last chunk.
Implementations of this interface may process
Content.Chunks being copied by the
Content.copy(Source, Sink, Processor, Callback) method, so that
Content.Chunks of unknown types can be copied.A content sink that writes the content to its implementation (a socket, a file, etc.).
A source of content that can be read with a read/demand model.
ContentDecoder decodes content bytes of a response.Factory for
ContentDecoders; subclasses must implement ContentDecoder.Factory.newContentDecoder().Parser for FastCGI frame content.
The result of the frame content parsing.
ContentProducer is the bridge between
HttpInput and Content.Source.A specialized
Response that can hold a limited content in memory.An
OutputStream backed by a Content.Sink.A
Flow.Subscriber that wraps a Content.Sink.A utility class to convert content from a
Content.Source to an instance
available via a CompletableFuture.An
InputStream that is backed by a Content.Source.Wraps a
Content.Source as a Flow.Publisher.A
Request.Content that wraps a Content.Source.This abstract
Content.Source wraps another Content.Source and implementers need only
to implement the ContentSourceTransformer.transform(Content.Chunk) method, which is used to transform Content.Chunk
read from the wrapped source.A context for handling an
Request.ContextFactory
Listener for all threads entering context scope, including async IO callbacks
Creates a
Map of contexts to it's contained handlers based
on the context path and virtual hosts of any contained
ContextHandlers.The webapps directory scanning provider.
A protocol handler that handles the 100 response code.
The HTTP/3 protocol parser.
Deprecated, for removal: This API element is subject to removal in a future version.
Use
org.eclipse.jetty.server.CookieCacheCookie parser
The compliance mode for Cookie handling.
Deprecated.
Cookie parser.
The handler of parsed cookies.
The exception thrown when a cookie cannot be parsed and
CookieCompliance.Violation.INVALID_COOKIES is not allowed.Sets a response cookie whenever the rule matches.
Represents the outgoing Frames.
Statistics on a counter value.
A callback wrapper that succeeds the wrapped callback when the count is
reached, or on first failure.
Credentials.
Unix Crypt Credentials
MD5 Credentials
Provider of credentials, it converts a String into a credential if it starts with a given prefix
CredentialValidationCallback
Store a jetty Credential for a user so that it can be
validated by jaspi
Deprecated.
Use
CrossOriginHandler insteadImplementation of the CORS protocol defined by the
fetch standard.
A flexible RequestLog, which produces log strings in a customizable format.
Record holding extra detail for logging
An abstract implementation of a timeout.
An implementation of a timeout that manages many
expirable entities whose
timeouts are mostly cancelled or re-scheduled.An entity that may expire.
DatabaseAdaptor
Handles differences between databases.
An
EndPoint implementation based on DatagramChannel.Close a DataSource.
DataSourceLoginModule
A LoginModule that uses a DataSource to retrieve user authentication
and authorisation information.
DataSourceLoginService
DBUser
Computes String representations of Dates then caches the results so
that subsequent requests within the same second will be fast.
ThreadLocal Date formatters for HTTP style dates.
ThreadLocal data parsers for HTTP style dates
Debug Handler.
A Context Listener that produces additional debug.
DeclaresRolesAnnotationHandler
An ObjectFactory enhanced by
Decorator instances.A ServletContextAttributeListener that listens for a context
attribute to obtain a decorator instance.
An extended org.eclipse.jetty.servlet.DecoratingListener.
Interface to decorate objects created by the
DecoratedObjectFactoryA very basic
AuthConfigFactory that allows for registering providers programmatically.The Default Authenticator Factory.
DefaultBundleClassLoaderHelper
DefaultCallbackHandler
An implementation of the JAAS CallbackHandler.
DefaultFileLocatorHelper
Default Handler.
The default
IdentityService, which creates and uses DefaultUserIdentitys.DefaultsDescriptor
The default Servlet, normally mapped to
/, that handles static resources.DefaultSessionCache
A session store that keeps its sessions in memory within a concurrent map
DefaultSessionCacheFactory
Factory for creating new DefaultSessionCaches.
DefaultSessionIdManager
Manages session ids to ensure each session id within a context is unique, and that
session ids can be shared across contexts (but not session contents).
The default implementation of UserIdentity.
Representing the Jetty
Request
in the UpgradeRequest interface.Representing the Jetty
Response
in the UpgradeResponse interface.This is extended by an
Extension so it can intercept demand calls.This flusher can be used to mutated and fragment
Frames and forwarded them on towards the application using the
IncomingFrames provided in the constructor.Interface that can be implemented by ContextHandlers within Environments to allow configuration
to be passed from the DeploymentManager without dependencies on the Deployment module itself.
The Deployment Manager.
DescriptorProcessor
A
Destination represents the receiver of HTTP requests, and it is
identified by an Origin.A Destroyable is an object which can be destroyed.
A
ConnectionFactory combining multiple ConnectionFactory.Detecting instances that will upgrade to
the first one recognizing the bytes in the buffer.Implementation of the HTTP "Digest" authentication defined in RFC 2617.
The nonce max age in ms can be set with the
SecurityHandler.setParameter(String, String)
using the name "maxNonceAge".A Directory based
ConfigSource.DiscoveredAnnotation
Represents an annotation that has been discovered
by scanning source code of WEB-INF/classes and WEB-INF/lib jars.
A partial implementation of
MessageSink for methods that consume WebSocket
messages using blocking stream APIs, typically via InputStream or Reader.Denial of Service filter
Listener for actions taken against specific requests.
Deprecated.
Default implementation of the
Decoder.Text Message to Double to decoderDefault encoder for
Double to Encoder.Text Message encoderDriverManagerLeakPreventer
Cause DriverManager.getCallerClassLoader() to be called, which will pin the classloader.
DumpableContainer
A Dumpable that is a container of beans can implement this
interface to allow it to refine which of its beans can be
dumped.
Handler to eagerly and asynchronously read and parse
MimeTypes.Type.FORM_ENCODED and
MimeTypes.Type.MULTIPART_FORM_DATA content prior to invoking the ServletHandler,
which can then consume them with blocking APIs but without blocking.A protocol handler that handles the 103 response code.
Deprecated, for removal: This API element is subject to removal in a future version.
This class has been renamed to
AdaptiveExecutionStrategyBasic Graph Edge
EE10Activator
ServerTracker
Tracks appearance of Server instances as OSGi services, and then configures them
for deployment of EE10 contexts and webapps.
LoginService implementation which always denies any attempt to login.
A
Future<Void> that is already failed as a result of an Encode errorEndPoint is the abstraction for I/O communication using bytes.
A communication conduit between two peers.
Interface representing bundle of SSLSession associated data.
Marks an
EndPoint that wraps another EndPoint.Parser for the END_REQUEST frame content.
EnvConfiguration
EnvEntry
A named runtime environment containing a
ClassLoader and Attributes.A Builder of
Environments intended to be used in XML
files generated by start.jar.A Jetty specialization of EOFException.
Standard HTTP/2 error codes.
Handler for Error pages
An ErrorHandler is registered with
Server.setErrorHandler(Request.Handler).An ErrorHandler that maps exceptions and status codes to URIs for dispatch using
the internal ERROR style of dispatch.
Utility classes for Entity Tag behaviors as outlined in RFC9110 : Section 8.8.3 - Entity Tag
Utility class for emitting OSGi EventAdmin events
A
Handler.Wrapper that fires events during the processing of the requests.EventSource is the passive half of an event source connection, as defined by the
EventSource Specification.EventSource.Emitter is the active half of an event source connection, and allows applications
to operate on the connection by sending events, data or comments, or by closing the connection.A servlet that implements the event source protocol,
also known as "server sent events".
Exception (or rather
Throwable utility methods.A strategy where the thread that produces will always run the resulting task.
A producer of
Runnable tasks to run.A
ThreadPool.SizedThreadPool wrapper around ThreadPoolExecutor.Interface for WebSocket Extensions.
Represents an Extension Configuration, as seen during the connection Handshake process.
Represents an Extension Configuration, as seen during the connection Handshake process.
Represents the stack of Extensions.
ExtraXmlDescriptorProcessor
Saves literal XML snippets from web.xml.
FakeURLClassLoader
Specific implementation of
ProxyHandler.Reverse for FastCGI.Specific implementation of
AsyncProxyServlet.Transparent for FastCGI.A container for name/value pairs, known as fields.
A named list of string values.
Simple, yet surprisingly common utility methods for identifying various file types commonly seen and worked with in a
deployment scenario.
Interface for initializing a file resource.
Deprecated.
use
org.eclipse.jetty.server.StateLifeCycleListener insteadFileSessionDataStore
A file-based store of session data.
FileSessionDataStoreFactory
TODO figure out if this should be a LifeCycle or not, how many instances of this class can reside in a JVM, who can call sweep and when.
Listener for pool events
Show a StackTrace
A Utility class to help implement
EndPoint.fillInterested(Callback)
by keeping state and calling the context and callback objects.Experimental Wrapper mechanism for Filter objects.
Default implementation of the Text Message to
Float decoderDefault encoder for
Float to Encoder.Text Message encoderFORM Authenticator.
A
CompletableFuture that is completed once a application/x-www-form-urlencoded
content has been parsed asynchronously from the Content.Source.A
Request.Content for form uploads with the
"application/x-www-form-urlencoded" content type.Customize Requests for Proxy Forwarding.
Ordered Source Enum.
Sets the request URI scheme, by default
https.FragmentActivator
Sets up support for jsp and jstl.
FragmentConfiguration
Fragment
A web-fragment.xml descriptor.
Fragment Extension
Used to split large data frames into multiple frames below the maxFrameSize.
An immutable websocket frame.
A Base Frame as seen in RFC 6455.
Handles incoming WebSocket frames for a given endpoint.
Factory for FrameHandler instances
Some static utility methods for validating a
Frame based on the state of its CoreSession.Deprecated.
Use
CompletableResponseListener insteadGenerating a frame in WebSocket land.
Jetty components that wish to be part of a Graceful shutdown implement this interface so that
the
Graceful.shutdown() method will be called to initiate a shutdown.A utility class to assist implementing the Graceful interface.
Handler to track active requests and allow them to gracefully complete.
Basic directed graph implementation
Output the Graph in GraphViz Dot format.
A class to support GREASE (RFC 8701) in HTTP/3.
ContentDecoder for the "gzip" encoding.Decoder for the "gzip" content encoding.
Specialized
ContentDecoder.Factory for the "gzip" encoding.A LifeCycle listener that halts the JVM with exit
code
0 when notified of the "started" event.A Jetty component that handles HTTP requests, of any version (HTTP/1.1, HTTP/2 or HTTP/3).
An abstract implementation of
Handler that is a ContainerLifeCycle.An abstract
Handler with a Invocable.InvocationType.NON_BLOCKING
invocation type.A
Handler.Abstract that implements Handler.Container.A
Handler.Container that can contain multiple other Handlers.A
Handler that contains one or more other Handlers.A
Handler.Container that contains an ordered list of children Handlers
whose Request.Handler.handle(Request, Response, Callback) method is invoked
in sequence on each child until a child returns true.A
Handler.Container that can contain one single other Handler.An implementation of
Handler.Singleton, which is a Handler.Container
that wraps one single other Handler.Deprecated.
Selects between the two Handshaker implementations,
RFC6455 (HTTP/1.1 WebSocket Upgrades)
and RFC68441 (HTTP/2 WebSocket Upgrades)
An implementation of a LoginService that stores users and roles in-memory in HashMaps.
Header Filter
Parser for the FastCGI frame header.
The parser for the frame header of HTTP/2 frames.
The parser for the frame header of HTTP/3 frames.
Puts or adds a response header whenever the rule matches a path Servlet pattern.
Puts or adds a response header whenever the rule matches a path regex pattern.
Abstract rule that matches against request headers.
Holder
Specialization of AbstractHolder for servlet-related classes that
have init-params etc
Display an optional Warning Message if the {jetty.home} and {jetty.base} are the same directory.
Adds a missing
Host header (for example, HTTP 1.0 or 2.0 requests).Parse an authority string (in the form
host:port) into
host and port, handling IPv4 and IPv6 host formats
as defined in RFC 2732An HttpField holding a preparsed Host and port number
A
HandlerContainer that allows a hot swap of a wrapped handler.HouseKeeper
There is 1 session HouseKeeper per SessionIdManager instance.
HPACK - Header Compression for HTTP/2
Hpack Decoder
A Session HPACK Exception.
A Stream HPACK exception.
A HTTP/2 specific handler of events for normal and tunnelled exchanges.
A client specific handler for events that happen after
a
HEADERS response frame is received.A server specific handler for events that happen after
a
HEADERS request frame is received.Comparator that orders non blacklisted ciphers before blacklisted ones.
HTTP2Client provides an asynchronous, non-blocking implementation
to send HTTP/2 frames to a server.
HTTP2 Clear Text Connection factory.
An ordered list of frames belonging to the same stream.
HTTP3Client provides an asynchronous, non-blocking implementation to send
HTTP/3 frames to a server.
A
ClientConnectionFactory implementation that creates HTTP/3 specific
Connection objects to be linked to a QuicStreamEndPoint.The HTTP/3 configuration parameters.
Deprecated, for removal: This API element is subject to removal in a future version.
use
QuicServerConnector insteadDefines the state of the stream for received frames,
Represents the state of an HTTP request/response cycle.
The factory that creates default implementations of
HttpChannel.A factory for
HttpChannel instances.A Channel represents a sequence of request cycles from the same connection with only a single
request cycle may be active at once for each channel.
The Channel's implementation of the
Response API.HttpClient provides an efficient, asynchronous, non-blocking implementation
to perform HTTP requests to a server through a simple API that offers also blocking semantic.
HttpClientTransport represents what transport implementations should provide
in order to plug-in a different transport for HttpClient.A
HttpClientTransport that can dynamically switch among different application protocols.HTTP compliance modes for Jetty HTTP parsing and handling.
HTTP Configuration.
An interface that allows a request object to be customized
for a particular HTTP connector configuration.
A
Connection that handles the HTTP protocol.A Connection Factory for HTTP Connections.
HttpContent interface.
HttpContent Wrapper.
Implementation of RFC6265 HTTP Cookies (with fallback support for RFC2965).
A builder for
HttpCookie instances.Immutable implementation of
HttpCookie.A
HttpCookie that wraps a HttpCookie.The possible values for the
SameSite attribute, defined
in the follow-up of RFC 6265, at the time of this writing defined at
RFC 6265bis.A wrapper for
HttpCookie instances.A container for
HttpCookies.A default implementation of
HttpCookieStore.An implementation of
HttpCookieStore that does not store any cookie.Utility methods for server-side HTTP cookie handling.
A
HttpField that holds an HttpHeader.SET_COOKIE as a
HttpCookie instance, delaying any value generation until
HttpCookieUtils.SetCookieHttpField.getValue() is called.A tagging interface for Exceptions that carry a HTTP response code and reason.
Exception thrown to indicate a Bad HTTP Message has either been received
or attempted to be generated.
Exception thrown to indicate a Bad HTTP Message has either been received
or attempted to be generated.
An immutable class representing an HTTP header or trailer.
A specialized
HttpField whose value is an int.A specialized
HttpField whose value is a long.Interface to pre-encode HttpFields.
An ordered collection of
HttpFields that represent the HTTP headers
or HTTP trailers of an HTTP request or an HTTP response.Deprecated, for removal: This API element is subject to removal in a future version.
A mutable version of
HttpFields.A wrapper of
HttpFields instances.Deprecated, for removal: This API element is subject to removal in a future version.
HttpGenerator.
While this class is-a Runnable, it should never be dispatched in it's own thread.
Known HTTP Methods
HttpOutput implements ServletOutputStream
as required by the Servlet specification.A Parser for 1.0 and 1.1 as defined by RFC7230
Client-side proxy configuration for HTTP proxying, as specified by
RFC 9110.
HttpReceiver provides the abstract code to implement the various steps of the receive of HTTP responses.Utility class that handles HTTP redirects.
HTTP and WebSocket Schemes
HttpSender abstracts the algorithm to send HTTP requests, so that subclasses only
implement the transport-specific code to send requests over the wire, implementing
HttpSender.sendHeaders(HttpExchange, ByteBuffer, boolean, Callback) and
HttpSender.sendContent(HttpExchange, ByteBuffer, boolean, Callback).Jetty handler that bridges requests to
HttpHandler.
Http Status Codes
A HttpStream is an abstraction that together with
MetaData.Request, represents the
flow of data from and to a single request and response cycle.HTTP Testing helper class.
HTTP constants
HttpUpgrader prepares a HTTP request to upgrade from one protocol to another,
and implements the upgrade mechanism.
A factory for
HttpUpgraders.Http URI.
This class contains the Huffman Codes defined in RFC7541.
Used to decoded Huffman encoded strings.
Used to encode strings Huffman encoding.
Associates UserIdentities from with threads and UserIdentity.Contexts.
An association between an identity and the current thread that can be terminated by
IdentityService.Association.close().An opaque token created by
IdentityService.newRunAsToken(String) and used by IdentityService.associate(UserIdentity, RunAsToken)An Abstract implementation of an Idle Timeout.
Handler to adjust the idle timeout of requests while dispatched.
Utility class to maintain a set of inclusions and exclusions.
Include Exclude Based Filter
Utility class to maintain a set of inclusions and exclusions.
Interface for dealing with Incoming Frames.
An immutable String lookup data structure.
Builder of
Index instances.A mutable String lookup data structure.
Builder of
Index.Mutable instances.InetAddress Access Handler
A pattern representing a single or range of
InetAddress.A set of InetAddress patterns.
Exception during initialization of the Endpoint
InitialContextFactory.java
Factory for the default InitialContext.
Injection
InjectionCollection
Map of classname to all injections requested on that class,
whether by declaration in web.xml or via equivalent annotations.
A
Content.Source that is backed by an InputStream.A
Request.Content that produces content from an InputStream.Implementation of
Response.Listener that produces an InputStream
that allows applications to read the response content.A handler for instructions issued by an
QpackEncoder or QpackDecoder.Default implementation of the
Decoder.Text Message to Integer decoderDefault encoder for
Integer to Encoder.Text Message encoderIntrospectionUtil
IntrospectorCleaner
Cleans a static cache of Methods held by java.beans.Introspector
class when a context is undeployed.
Rule that protects against invalid unicode characters in URLs,
returning a configurable status code with body message.
Indicating that the provided Class is not a valid WebSocket as defined by the API.
Indicating that the provided Class is not a valid WebSocket per the chosen API.
A task (typically either a
Runnable or Invocable.Callable
that declares how it will behave when invoked:The behavior of an
Invocable when it is invoked.A
Runnable decorated with an Invocable.InvocationType.A task with an
Invocable.InvocationType.Dynamic Servlet Invoker.
IO Utilities.
Common IO operations for
Resource content.This specialized callback implements a pattern that allows
a large asynchronous task to be broken into smaller
asynchronous sub-tasks using iteration rather than recursion.
The indication of the overall progress of the iteration
that implementations of
IteratingCallback.process() must return.Iterating Nested Callback.
IterativeDescriptorProcessor
JAAS Configuration
Implementation of jetty's LoginService that works with JAAS for
authorization and authentication.
JAASPrincipal
JAASUserPrincipal
Container for Client use of the jakarta.websocket API.
Client
ContainerProvider implementation.Websocket Configuration
Client Session for the JSR.
Attempt to determine the version of the Jar File based on common version locations.
A Jetty implementation of the
AuthConfigProvider to allow registration of a ServerAuthModule
directly without having to write a custom AuthConfigProvider.Implementation of Jetty
LoginAuthenticator that is a bridge from Jakarta Authentication to Jetty Security.Jakarta Authentication (JASPI) Authenticator Factory.
JASPI Configuration
Almost an implementation of jaspi MessageInfo.
javaNameParser
javaRootURLContext
javaURLContextFactory
Java Version Utility class.
JAAS LoginModule to retrieve user information from
a database and authenticate the user.
JDBC as a source of user authentication and authorization information.
A UserPrincipal with extra jdbc key info.
JDBCSessionDataStore
Session data stored in database
SessionTableSchema
JDBCSessionDataStoreFactory
${jetty.base} specific ConfigSource
JettyBootstrapActivator
Represents an Extension Configuration, as seen during the connection Handshake process.
${jetty.home} specific ConfigSource
Jetty implementation of
HttpContextJetty implementation of
HttpExchangeJetty implementation of
HttpServer.Jetty implementation of Java HTTP Server SPI
JettyJasperInitializer
JettyJspServlet
Wrapper for the jsp servlet that handles receiving requests mapped from
jsp-property-groups.
JettyLogger specific configuration:
<name>.LEVEL=(String:LevelName)
<name>.STACKS=(boolean)
JettyServerFactory
Configures a jetty Server instance.
JettyTldPreScanned
Change to TldPreScanned to not require that the tlds have been
pre-scanned from a jar file, but rather may be files in the
file system.
Websocket Configuration
Abstract WebSocket creator interface.
Factory to create
JettyWebSocketFrameHandler instances suitable for
use with jetty-native websocket API.Abstract Servlet used to bridge the Servlet API to the WebSocket API.
ServletContext configuration for Jetty Native WebSockets API.
JettyWebConfiguration.
JMX Configuration
JNDI Configuration
JSON parser and generator.
JSON Convertible object.
JSON Convertor.
JSON Generator.
A Literal JSON generator.
JSON Output class for use by
JSON.Convertible.A Reader source for a JSON string.
A generic source for a JSON representation.
An in-memory source for a JSON string.
Convert a
Date to JSON.Convert an
Enum to JSON.Converts an Object to JSON using reflection on getters methods.
Converts POJOs to JSON and vice versa.
JSP Configuration
Servlet handling JSP Property Group mappings
Used to decode the ID Token from the base64 encrypted JSON Web Token (JWT).
The
KeyStoreScanner is used to monitor the KeyStore file used by the SslContextFactory.A
Handler that helps recording the total latency of the requests executed by the wrapped handler.Lazy List creation.
A LdapLoginModule for use with JAAS setups
LibExtClassLoaderHelper
IFilesInJettyHomeResourcesProcessor
Interface for callback impls
Handles basic license presentation and acknowledgement.
The lifecycle interface for generic components.
Listener.
LifeCycleCallback
Holds information about a class and method
that has either been configured in web.xml to have postconstruct or
predestroy callbacks, or has the equivalent annotations.
LifeCycleCallbackCollection
This class collects the classes and methods that have been configured
in web.xml with postconstruct/predestroy callbacks, or that contain the
equivalent annotations.
ListenerHolder
Specialization of BaseHolder for servlet listeners.
Experimental Wrapper mechanism for Servlet EventListeners.
ClassLoader Helper.
A local connector, mostly for testing purposes.
localContext
Implementation of the delegate for InitialContext for the local namespace.
A
Pool.Wrapper that tracks the acquire/release/remove pool events.A receiver of
Pool events.This Authentication represents a just completed authentication, that has sent a response, typically to
redirect the client to the original request target..
Base class for representing a successful authentication state.
This is similar to the jaspi PasswordValidationCallback but includes user
principal and group info as well.
This is similar to the jaspi PasswordValidationCallback but includes user
principal and group info as well.
Login Service Interface.
Default implementation of the Text Message to
Long decoderDefault encoder for
Long to Encoder.Text Message encoderA monitor for low resources, low resources can be detected by:
ThreadPool.isLowOnThreads() if Connector.getExecutor() is
an instance of ThreadPool and LowResourceMonitor.setMonitorThreads(boolean) is true.
If LowResourceMonitor.setMaxMemory(long) is non zero then low resources is detected if the JVMs
Runtime instance has Runtime.totalMemory() minus Runtime.freeMemory()
greater than LowResourceMonitor.getMaxMemory()
MailSessionReference
This is a subclass of jakarta.mail.Reference and an ObjectFactory for jakarta.mail.Session objects.
Main start class.
The
@ManagedAttribute annotation is used to indicate that a given method
exposes a JMX attribute.Enable Jetty style JMX MBeans from within a Context
Enable Jetty style JMX MBeans from within a Context
The
@ManagedObject annotation is used on a class at the top level to
indicate that it should be exposed as an mbean.The
@ManagedOperation annotation is used to indicate that a given method
should be considered a JMX operation.ManagedSelector wraps a Selector simplifying non-blocking operations on channels.A
ManagedSelector.Selectable is an EndPoint that wish to be
notified of non-blocking events by the ManagedSelector.A selector update to be done when the selector has been woken.
Session
A heavy-weight Session object representing an HttpSession.
State of the session id
Validity states of a session
The match details when using
PathMappings.getMatched(String), used to minimize return to the PathSpec or PathMappings for subsequent details
that are now provided by the MatchedPath instance.Attempt to download a
maven:// URI, by first attempting to find
the resource in the maven repository system (starting with local, then
central)Simple parser for maven-metadata.xml files
Container class for the MBean instances
A server
Connector that allows clients to communicate via memory.Memory-based implementation of
EndPoint.Pipe.An in memory Resource created from a
URLA
Transport suitable to be used when using a MemoryConnector.MemoryUtils provides an abstraction over memory properties and operations.
A utility implementation of FrameHandler that aggregates TEXT frames
into a String message before calling
MessageHandler.onText(String, Callback).Support class for reading a WebSocket BINARY message via a InputStream.
Support for writing a single WebSocket BINARY message via a
OutputStreamThe HTTP/3 protocol parser.
Support class for reading a (single) WebSocket TEXT message via a Reader.
A consumer of WebSocket data frames (either BINARY or TEXT).
Exception when a message is too large for the internal buffers occurs and should trigger a connection close.
Exception when a message is too large for the internal buffers occurs and should trigger a connection close.
Support for writing a single WebSocket TEXT message via a
WriterMetaData
All data associated with the configuration and deployment of a web application.
Immutable common HTTP information for requests and responses.
Immutable HTTP CONNECT request information.
Metadata regarding where a deployable element was declared:
by annotation or by descriptor.
Immutable HTTP request information.
Immutable HTTP response information.
MetaInfConfiguration
MIME Type enum and utilities
Enumeration of predefined MimeTypes.
Represents a Module metadata, as defined in Jetty.
Generate a graphviz dot graph of the modules found
Access for all modules declared, as well as what is enabled.
A
QueuedThreadPool subclass that monitors its own activity by recording queue and task statistics.Java NIO Path Resource with file system pooling.
A
ContextHandler with a child Handler
that redirects to a configurable URI.A multi valued Map.
Namespace class for interrelated classes that provide
support for parsing and generating multipart bytes.
An asynchronous
Content.Source where MultiPart.Parts can
be added to it to form a multipart content.A
MultiPart.Parser.Listener that emits MultiPart.Part objects.A
MultiPart.Part that holds its content in memory,
in one or more ByteBuffers.A
MultiPart.Part that holds its content in one or more Content.Chunks.A
MultiPart.Part whose content is a Content.Source.A
multipart/form-data parser that follows
RFC 7578.A listener for events emitted by a
MultiPart.Parser.A single part of a multipart content.
A
MultiPart.Part whose content is in a file.A
CompletableFuture that is completed when a multipart/byteranges
has been parsed asynchronously from a Content.Source.The multipart/byteranges specific content source.
A specialized
InputStreamContentSource
whose content is sliced by a byte range.A
MultiPart.Part whose content is a byte range of a Resource.An ordered list of
MultiPart.Parts that can
be accessed by index, or iterated over.A specialized
PathContentSource
whose content is sliced by a byte range.The compliance mode for MultiPart handling.
MultiPartConfigAnnotationHandler
A
CompletableFuture that is completed when a multipart/form-data content
has been parsed asynchronously from a Content.Source.The multipart/form-data specific content source.
An ordered list of
MultiPart.Parts that can
be accessed by index or by name, or iterated over.Handle a multipart MIME response.
A
Request.Content for form uploads with the "multipart/form-data"
content type.Handle a multipart MIME response.
Utility class to handle a Multi Release Jar file
This annotation is used to describe variables in method
signatures so that when rendered into tools like JConsole
it is clear what the parameters are.
NameEnumeration
NamingContext
Naming Context Listener.
A utility Dumpable to dump a JNDI naming context tree.
NamingEntry
Naming Utility Methods
Utility class with methods that deal with
System.nanoTime().Natural Language Sorting
Used to decode integers as described in RFC7541.
Used to encode integers as described in RFC7541.
Used to decode string literals as described in RFC7541.
A
Connector for TCP/IP network connectorsReceives notifications of the
NetworkConnector.open()
and NetworkConnector.close() events.A listener for raw network traffic within Jetty.
A specialized version of
ServerConnector that supports NetworkTrafficListeners.A specialized version of
SocketChannelEndPoint that supports NetworkTrafficListeners.Basic Graph Node
An extension of
RequestListeners that can notify request events.Does not actually cache any Session objects.
NullSessionCacheFactory
Factory for NullSessionCaches.
NullSessionDataStore
Does not actually store anything, useful for testing.
NullSessionDataStoreFactory
ObjectCallback
A dynamic MBean that can wrap an arbitrary Object instance.
Annotation for methods to receive WebSocket close events.
Annotation for methods to receive WebSocket errors.
Annotation for methods to receive WebSocket frame events.
Annotation for methods to receive BINARY or TEXT WebSocket events.
Annotation for methods to receive WebSocket connect events.
Implements authentication using OpenId Connect on top of OAuth 2.0.
This class is used to wrap the
Authenticator.Configuration given to the OpenIdAuthenticator.Holds the configuration for an OpenID Connect service.
The credentials of an user to be authenticated with OpenID Connect.
The implementation of
LoginService required to use OpenID Connect.Deprecated.
Use
DetectorConnectionFactory with a SslConnectionFactory instead.Provides a way of forcing the ordered execution of bindings within
a declared binding target.
Ordering options for jars in WEB-INF lib.
Class that groups the elements that uniquely identify a destination.
The representation of a network protocol.
OSGiApp
Base class representing info about a WebAppContext/ContextHandler to be deployed into jetty.
OSGiClassLoader
Class loader that is aware of a bundle.
OSGiDeployer
Extension of standard Jetty deployer that emits OSGi EventAdmin
events whenever a webapp is deployed into OSGi via Jetty.
OSGiMetaInfConfiguration
Handle adding resources found in bundles.
OSGiServerConstants
Name of the properties that configure a jetty Server OSGi service.
OSGiUndeployer
Extension of the Jetty Undeployer which emits OSGi EventAdmin events
whenever a webapp is undeployed from Jetty.
OSGiWebappClassLoader
Extends the webapp classloader to also use the classloader of the Bundle defining the webapp.
OSGiWebappConstants
Constants (MANIFEST headers, service properties etc) associated with deploying
webapps into OSGi via Jetty.
Interface for dealing with frames outgoing to (eventually) the network layer.
A
Content.Source backed by an OutputStream.A
Request.Content that provides content asynchronously through an OutputStream
similar to AsyncRequestContent.OverrideDescriptor
PackageAdminServiceTracker
Parser for the PARAMS frame content.
The FastCGI protocol exchanges frames.
The HTTP/2 protocol parser.
Parsing of a frames in WebSocket land.
A
MessageSink implementation that delivers BINARY frames
to the application function passed to the constructor in the form
of a byte[].A
MessageSink implementation that delivers BINARY frames
to the application function passed to the constructor in the form
of a ByteBuffer.A
MessageSink implementation that delivers TEXT frames
to the application function passed to the constructor in the form
of a String.Password utility class.
A
Content.Source that provides the file content of the passed Path.Path Mappings of PathSpec to Resource.
A Handler that delegates to other handlers through a configured
PathMappings.Common PathMatcher implementations.
Method argument identifier for
PathParam annotations.Optional interface for custom
EndpointConfig implementations
in Jetty to expose Path Param values used during the JakartaWebSocketFrameHandler
resolution of methods.Make
PathParam information from the incoming request available
on ServerEndpointConfigA
Request.Content for files using JDK 7's java.nio.file APIs.Java NIO Path Resource.
A path specification is a URI path template that can be matched against.
Types of path spec groups.
A Set of PathSpec strings.
Abstract rule that uses the Servlet pattern syntax via
ServletPathSpec for path pattern matching.Per Message Deflate Compression extension for WebSocket.
Create a PID file for the running process.
Configuration
PlusDecorator
PlusDescriptorProcessor
Exception when a violation of policy occurs and should trigger a connection close.
A pool of objects, with support for multiplexing and several
optimized strategies plus an optional
ThreadLocal cache
of the last released entry.A
Pool entry that holds metadata and a pooled object.A wrapper for
Entry instances.A factory for
Pool instances.A wrapper for
Pool instances.PostConstructCallback
This
HttpContent.Factory populates the HttpContent.getPreCompressedContentFormats() field for any
HttpContent fetched through this factory.PreDestroyCallback
Pre encoded HttpField.
A protocol handler that handles the 102 response code.
ProcessorUtils provides access to runtime info about processors, that may be
overridden by system properties or environment variables.
A strategy where the caller thread iterates over task production, submitting each
task to an
Executor for execution.A strategy where the caller thread iterates over task production, submitting each
task to an
Executor for execution.A callback abstraction that handles completed/failed events of asynchronous operations.
Empty implementation of
Promise.A CompletableFuture that is also a Promise.
PropertyFileLoginModule
This class monitors a property file of the format mentioned below
and notifies registered listeners of the changes to the the given file.
PropertyUserStoreManager
Maintains a map of PropertyUserStores, keyed off the location of the property file containing
the authentication and authorization information.
Management of Properties.
An non-recoverable error with Props usage
Per spec, a protocol error should result in a Close frame of status code 1002 (PROTOCOL_ERROR)
Per spec, a protocol error should result in a Close frame of status code 1002 (PROTOCOL_ERROR)
A protocol handler performs HTTP protocol operations on
behalf of the application, typically like a browser would.
A container for
ProtocolHandlers accessible from HttpClient.getProtocolHandlers().A HttpUpgrader that upgrades to a given protocol.
Represents an established stateful connection with a remote peer for a specific QUIC connection ID.
A factory for protocol specific instances of
ProtocolSession.A protocol handler that handles the 401 response code
in association with the
Proxy-Authenticate header.The configuration of the forward proxies to use with
HttpClient.ConnectionFactory for the PROXY Protocol.
Customizer that extracts the real local and remote address:port pairs from a
ProxyConnectionFactory
and sets them on the request with Attributes.setAttribute(String, Object).A
Handler that can be used to implement a forward
proxy ("proxy") or a reverse proxy ("gateway") as defined by
RFC 7230.A
ProxyHandler that can be used to implement a forward proxy server.A
ProxyHandler that can be used to implement a reverse proxy.ClientConnectionFactory for the
PROXY protocol.
A ClientConnectionFactory for the PROXY protocol version 1.
PROXY protocol version 1 metadata holder to be used in conjunction
with
Request.tag(Object).A ClientConnectionFactory for the PROXY protocol version 2.
PROXY protocol version 2 metadata holder to be used in conjunction
with
Request.tag(Object).Servlet 3.0 asynchronous proxy servlet.
Convenience extension of
ProxyServlet that offers transparent proxy functionalities.Deprecated.
use
QoSHandler instead.A quality of service
Handler that conditionally
limits the number of concurrent requests, to provide more predictable
end-user experience in case descendant Handlers have limited
capacity.A Session QPACK Exception.
A Stream QPACK exception.
A thread pool with a queue of jobs to execute.
Deprecated, for removal: This API element is subject to removal in a future version.
replaced by
TransportA record that captures QUIC configuration parameters.
A
Connection implementation that receives and sends datagram packets via its associated DatagramChannelEndPoint.QuickStartConfiguration
QuickStartDescriptorProcessor
Handle extended elements for quickstart-web.xml
QuickStartGeneratorConfiguration
A server side network connector that uses a
DatagramChannel to listen on a network port for QUIC traffic.Represents a logical connection with a remote peer, identified by a QUIC connection ID.
A listener for
QuicSession events.A container that tracks
QuicSession instances.An
EndPoint implementation on top of a QUIC stream.A
Transport for QUIC that delegates to another Transport.A Quiet Exception.
A ServletException that is logged less verbosely than
a normal ServletException.
Implements a quoted comma separated list of values
in accordance with RFC7230.
Implements a quoted comma separated list parser
in accordance with RFC9110 section 5.6.
Implements a quoted comma separated list of quality values
in accordance with RFC7230 and RFC7231.
A Tokenizer that splits a string into parts, allowing for quotes.
A
ConnectionPool that provides connections
randomly among the ones that are available.Controls rate of events via
RateControl.onEvent(Object).Factory to create RateControl instances.
Counts the rate that
Longs are added to this from the time of creation or the last call to RateCounter.reset().Statistics on a time sequence rate.
Issues a (3xx) redirect response whenever the rule finds a request path Servlet pattern match.
A protocol handler that handles redirect status codes 301, 302, 303, 307 and 308.
Issues a (3xx) redirect response whenever the rule finds a request path regular expression match
RegexPathSpec is a PathSpec implementation for a
PathMappings instance.Abstract rule that uses the regular expression syntax for path pattern matching.
A Set of Regular expressions strings.
An
ErrorHandler that can re-handle a request at an error page location.An
ReHandlingErrorHandler that uses a map of error codes to select a page.Relative Fragment Ordering
Request represents an HTTP request, and offers a fluent interface to customize
various attributes such as the path, the headers, the content, etc.The representation of an HTTP request, for any protocol version (HTTP/1.1, HTTP/2, HTTP/3).
A
Request.Wrapper that separately provides the request Attributes.A minimal Authentication interface, primarily used for logging.
Listener for the request begin event.
Listener for the request committed event.
A client-side representation of HTTP request content.
Listener for the request content event.
Listener for the request failed event.
A handler for an HTTP request and response.
Listener for the request headers event.
Listener for all request events.
Listener for the request queued event.
Common, empty, super-interface for request listeners.
This interface will be detected by the
Request.ServeAs.wrap(Request, HttpURI) static method to wrap the request
changing its target to a given path.Listener for the request succeeded event.
A wrapper for
Request instances.ServletRequestCallback
Provides access to the request associated with the authentication.
A specialized container for request listeners.
TODO
Writes the generated log string to a log sink
Writer which outputs pre-formatted request log strings to a file using
RolloverFileOutputStream.RequestParameterCallback
A TryExecutor using pre-allocated/reserved threads from an external Executor.
Resource
A Resource is a wrapper over a
Path object pointing to a file or directory that can be represented by aFileSystem.ResourceFactory is the source of new
Resource instances.Resource Handler will serve static content and handle If-Modified-Since headers.
Utility class to create a ContextHandler containing a ResourceHandler.
HttpContent created from a
Resource.An HttpContent.Factory for transient content (not cached).
Utility methods to generate a List of paths.
Collection of helpful static methods for working with
Resource objects.Resource service, used by DefaultServlet and ResourceHandler
A welcome target paired with how to process it.
How welcome targets should be processed.
Specialized
UriPatternPredicate to allow filtering Resource entries by their URI.Response represents an HTTP response and offers methods to retrieve status code, HTTP version
and headers.The representation of an HTTP response, for any protocol version (HTTP/1.1, HTTP/2, HTTP/3).
Asynchronous listener for the response content events.
Listener for the response begin event.
Listener for the request and response completed event.
Synchronous listener for the response content events.
Asynchronous listener for the response content events.
Listener for the response failure event.
Listener for a response header event.
Listener for the response headers event.
Listener for all response events.
Common, empty, super-interface for response listeners
Listener for the response succeeded event.
The parser for STDOUT frame content.
A marker interface for
HttpFields that cannot be removed or cleared
from a ResponseHttpFields instance.A
HttpField that is a ResponseHttpFields.Persistent.A
PreEncodedHttpField that is a ResponseHttpFields.Persistent.A specialized container for response listeners.
Sends the response code whenever the rule finds a match.
Specialized PrintWriter for servlet Responses
A reference counted resource, for example one that is borrowed from a pool,
that may be retained an additional number of times, and released a correspondent
number of times, over its lifecycle.
A reference count implementation for a
Retainable resource.A wrapper of
Retainable instances.A pooled
ByteBuffer which maintains a reference count that is
incremented with Retainable.retain() and decremented with Retainable.release().A wrapper for
RetainableByteBuffer instancesA
RuleContainer that is an HttpConfiguration.Customizer,
so that its rules are processed at request customization time.RewriteHandler rewrites incoming requests through a set of Rules.A rule to rewrite the path and query that match a Servlet pattern with a fixed string.
A rule to rewrite the path and query that match a regular expression pattern with a fixed string.
Cookie parser
A parser for
Set-Cookie header values following
RFC 6265.An implementation of
QuotedStringTokenizer with partial handling of
RFC9110 quoted-strings.RolePrincipal
Represents a role.
RolloverFileOutputStream.
A
ConnectionPool that attempts to provide connections using a round-robin algorithm.An abstract rule that, upon matching a certain condition, may wrap
the
Request or the Handler to execute custom logic.A
Request.Wrapper used to chain a sequence of Rules together.A container that groups
Rules and is itself a Rule.Deprecated.
No replacement provided or available.
Subclass of
RuntimeException used to signal that there
was an IOException thrown by underlying WriterStatistics on a sampled value.
Scanner
Utility for scanning a directory for added, removed and changed
files and reporting these events via registered Listeners.
Notification of files that changed in the last scan.
Notification of exact file changes in the last scan.
Listener
Marker for notifications re file changes.
Listener that notifies when a scan has started and when it has ended.
Implementation of
Scheduler based on JDK's ScheduledThreadPoolExecutor.Fast search for patterns within strings, arrays of
bytes and
ByteBuffers.Forces a redirect to the secure form of the resource before allowed to access the resource.
Customizer that extracts the attribute of an
SSLContext
and makes them available via Attributes.getAttribute(String)
using the names:
EndPoint.SslSessionData.ATTRIBUTE for EndPoint.SslSessionData
SecureRequestCustomizer.X509_ATTRIBUTE for the local certificate as a X509 instance
Abstract SecurityHandler.
A concrete implementation of
SecurityHandler that uses a PathMappings to
match request to a list of Constraints, which are applied in the order of
least significant to most significant.Collections of utility methods to deal with the scheduled removal
of the security classes defined by JEP 411.
A partial
EndPoint implementation based on SelectableChannel.SelectorManager manages a number of ManagedSelectors that
simplify the non-blocking primitives provided by the JVM via the java.nio package.A listener for accept events.
Wrapper of user provided
SendHandler to Jetty internal CallbackEnsures serial execution of submitted tasks.
Error handling task
Ensures serial invocation of submitted tasks.
A server specific Authentication or Authorization exception.
This
Connector implementation is the primary connector for the
Jetty server over TCP/IP.ServerConnectorListener
This is for test support, where we need jetty to run on a random port, and we need
a client to be able to find out which port was picked.
Server specific implementation of
ProtocolSession.Server-side
QuicConfiguration with server-specific settings.The server specific implementation of
QuicConnection.The server specific implementation of
QuicSession.Server-side extension of
Session.Listener that exposes additional events.The HTTP request to upgrade to WebSocket.
Upgrade request used for websocket negotiation.
The HTTP response to upgrade to WebSocket.
Upgrade response used for websocket negotiation.
A server-side WebSocket container that allows to
map
URI paths to WebSocket endpoints and configure WebSocket parameters such as idle timeouts,
max WebSocket message sizes, etc.The Jetty implementation of the ee10
HttpServletRequest object.The Jetty implementation of the ee10
HttpServletResponse object.The ServletChannel contains the state and behaviors associated with the Servlet API
lifecycle for a single request/response cycle.
holder of the state of request-response cycle.
The actions to take as the channel moves from state to state.
Holds a ServletContainerInitializer.
Experimental Wrapper mechanism for ServletContainerInitializer objects.
Servlet Context.
Bean that is added to the ServletContextHandler to start all of the
ServletContainerInitializers by starting their corresponding
ServletContainerInitializerHolders when this bean is itself started.
Listener for all threads entering context scope, including async IO callbacks
The interface used by
ServletApiRequest to access the ServletContextRequest without
access to the unwrapped Request methods.The interface used by
ServletApiResponse to access the ServletContextResponse without
access to the unwrapped Response methods.A core request wrapper that carries the servlet related request state,
which may be used directly by the associated
ServletApiRequest.A core response wrapper that carries the servlet related response state,
which may be used directly by the associated
ServletApiResponse.Wrap a
ServletRequest as a core Request.A
HttpServletResponse wrapped as a core Response.Servlet HttpHandler.
A mapping of a servlet by pathSpec or by name
Servlet Instance and Context Holder.
Experimental Wrapper mechanism for Servlet objects.
Servlet specific class for multipart content support.
An ordered list of
Parts that can be accessed by name.Implementation of HttpServletMapping.
ServletRequestHttpWrapper
Class to tunnel a ServletRequest via an HttpServletRequest
ServletResponseHttpWrapper
Wrapper to tunnel a ServletResponse via an HttpServletResponse
Jetty Servlets Configuration
Inspect a class to see if it has an
@ServletSecurity annotation on it,
setting up the <security-constraint>s.ServletTester is not best practice and may be deprecated and eventually
removed in future Jetty versions.
A
Session represents the client-side endpoint of an HTTP/2 connection to a single origin server.The low-level HTTP/3 API representing a connection with a remote peer.
The interface to a generic session associated with a request.
Session represents an active link of
communication with a remote WebSocket endpoint.An API wrapper of the core session.
The client-side HTTP/3 API representing a connection with a server.
The client-side specific
Session.Listener.Listener interface that if implemented by a value of an attribute of an enclosing
Context at start, will be
notified of session lifecycle events.A
Session.Listener is the passive counterpart of a Session and
receives events happening on an HTTP/2 connection.A
Session.Listener is the passive counterpart of a Session and
receives events happening on an HTTP/3 connection.The passive link of communication with a remote WebSocket endpoint.
Tag interface that signals that the WebSocket endpoint
is demanding for WebSocket frames automatically.
The server-side HTTP/3 API representing a connection with a client.
The server-side specific
Session.Listener.Listener interface that if implemented by a session attribute value, will be notified of
session value events.
SessionAuthentication
When a user has been successfully authenticated with some types
of Authenticator, the Authenticator stashes a SessionAuthentication
into an HttpSession to remember that the user is authenticated.
SessionCache
A working set of
ManagedSession objects for a context.SessionCacheFactory
SessionContext
Information about the context to which sessions belong: the Context,
the SessionManager of the context, and the unique name of the node.
SessionData
The data associated with a session.
SessionDataMap
A map style access to SessionData keyed by the session id.
SessionDataMapFactory
SessionDataStore
A store for the data contained in a Session object.
SessionDataStoreFactory
A simple core SessionHandler
Session ID Manager.
SessionInactivityTimer
Each Session has a timer associated with it that fires whenever it has
been idle (ie not accessed by a request) for a configurable amount of
time, or the Session expires.
SessionManager
Non-servlet spec specific contract implemented by all SessionHandlers.
A parser for
Set-Cookie header values.Deprecated.
Default implementation of the
Decoder.Text Message to Short decoderDefault encoder for
Short to Encoder.Text Message encoder
A
Handler that initiates a Shutdown of the Jetty Server it belongs to.Shutdown/Stop Monitor thread.
ShutdownThread is a shutdown hook thread implemented as
singleton that maintains a list of lifecycle instances
that are registered with it and provides ability to stop
these lifecycles upon shutdown of the Java Virtual Machine
Deprecated.
A
Handler that can limit the size of message bodies in requests and responses.Request log writer using a Slf4jLog Logger
A
X509ExtendedKeyManager that selects a key with an alias
retrieved from SNI information, delegating other processing to a nested X509ExtendedKeyManager.Selects a certificate based on SNI information.
Creates
SocketAddress instances, returning them through a Promise.Creates
InetSocketAddress instances asynchronously in a different thread.Creates
InetSocketAddress instances synchronously in the caller thread.An
EndPoint implementation based on SocketChannel.A Connection Lister for customization of SocketConnections.
Client-side proxy configuration for SOCKS4, a de-facto standard.
Helper class for SOCKS5 proxying.
A SOCKS5 authentication method.
A factory for
Socks5.Authentications.The implementation of the
NO AUTH authentication method defined in
RFC 1928.The implementation of the
USERNAME/PASSWORD authentication method defined in
RFC 1929.Client-side proxy configuration for SOCKS5, defined by
RFC 1928.
Source
The source of a web artifact: servlet, filter, mapping etc
Implementation of the SPNEGO (or "Negotiate") authentication defined in RFC 4559.
A LoginAuthenticator that uses SPNEGO and the GSS API to authenticate requests.
A configurable (as opposed to using system properties) SPNEGO LoginService.
CLIENT-CERT authenticator.
A ClientConnectionFactory that creates client-side
SslConnection instances.A factory for
SSLEngine objects.A Connection that acts as an interceptor between an EndPoint providing SSL encrypted data
and another consumer of an EndPoint (typically an
Connection like HttpConnection) that
wants unencrypted data.SslContextFactory is used to configure SSL parameters
to be used by server and client connectors.
A provider for SNI names to send to the server during the TLS handshake.
A wrapper that delegates to another (if not
null) X509ExtendedKeyManager.A wrapper that delegates to another (if not
null) X509ExtendedTrustManager.Implementations of this interface are notified of TLS handshake events.
The event object carrying information about TLS handshake events.
A try-with-resources compatible layer for
hiding stacktraces within the scope of the try block when
logging with JettyLogger implementation.StandardDescriptorProcessor.
The Arguments required to start Jetty.
Management of the
${jetty.base}/start.d/ based configuration.A start environment that contains the configurations that will be used to
build a runtime
org.eclipse.jetty.util.component.Environment via
--env arguments passed to org.eclipse.jetty.xml.XmlConfiguration#main(java.lang.String...)Simple Start .INI handler
Management of the
${jetty.base}/start.ini based configuration.Centralized Place for logging.
A LifeCycle Listener that writes state changes to a file.
This exception can safely be stored in a static variable as suppressed exceptions are disabled,
meaning calling
Throwable.addSuppressed(Throwable) has no effect.Checks that the wrapped handler can read/write at a minimal rate of N bytes per second.
A LifeCycle that when started will stop another LifeCycle
The client side version of
Stream.A
Stream.Client.Listener is the passive counterpart of a Stream.Client
and receives client-side events happening on an HTTP/3 stream.A
Retainable wrapper of a DataFrame.A
Stream.Data instance associates a ByteBuffer
containing request bytes or response bytes.A
Stream.Listener is the passive counterpart of a Stream and receives
events happening on an HTTP/2 stream.The server side version of
Stream.A
Stream.Server.Listener is the passive counterpart of a Stream.Server
and receives server-side events happening on an HTTP/3 stream.A stream content parser parses frame bodies of type STDIN, STDOUT and STDERR.
The QUIC stream type, either client or server initiated, and either unidirectional or bidirectional.
Default implementation of the
Decoder.Text Message to String decoderDefault encoder for
String to Encoder.Text Message encoderA
MessageSink implementation that accumulates TEXT frames
into a message that is then delivered to the application function
passed to the constructor in the form of a String.A
Request.Content for strings.Fast String Utilities.
A utility class to perform periodic sweeping of resources.
A
Sweeper.Sweepable resource implements this interface to
signal to a Sweeper or to a parent container if it
needs to be swept or not.An extension of
AllowedResourceAliasChecker which will allow symlinks alias to arbitrary
targets, so long as the symlink file itself is an allowed resource.Collection of Syntax validation methods.
If this rule matches, terminates the processing of other rules, allowing
the request to be processed by the handlers after the
RewriteHandler.If this rule matches, terminate the processing of other rules.
In a start testing scenario, it is often not important to actually download
or initialize a file, this implementation is merely a no-op for the
FileInitializerSimple common abstraction for Text files, that consist of a series of lines.
Collection of utility methods for Text content
A fixed sized pool of items that uses ThreadId to avoid contention.
Handler to limit the threads per IP address for DOS protection
A pool for threads.
Specialized sub-interface of ThreadPool that allows to get/set
the minimum and maximum number of threads of the pool.
A budget of required thread usage, used to warn or error for insufficient configured threads.
A scheduler based on the the JVM Timer class
Topological sort a list or array.
This will approve an alias where the only difference is a trailing slash.
Transaction
Class to represent a JTA UserTransaction impl.
Transaction
Class to represent a JTA UserTransaction impl.
This is used to iteratively transform or process a frame into one or more other frames.
The low-level transport used by clients.
Abstract implementation of
Transport based on IP.Abstract implementation of
Transport based on sockets.The TCP/IP
Transport.The stream Unix-Domain socket
Transport.The UDP/IP
Transport.The datagram Unix-Domain socket
Transport.Abstract implementation of
Transport based on Unix-Domain sockets.A wrapper for
Transport instances to allow layering of Transports.A variation of Executor that can confirm if a thread is available immediately
Inspired by nginx's try_files functionality.
Inspired by nginx's
try_files functionality.Supports the implementation of HTTP
CONNECT tunnels.TYPE Utilities.
Unix Crypt.
A
Connector implementation for Unix-Domain server socket channels.UnreadableSessionDataException
UnwriteableSessionDataException
Exception during WebSocket Upgrade Handshake.
Exception during WebSocket Upgrade Handshake.
An immutable, feature limited, HttpServletRequest that will not be recycled by Jetty.
A protocol handler that handles HTTP 101 responses.
The HTTP Upgrade to WebSocket Request
The HTTP Upgrade to WebSocket Response
Provide for a Uptime class that is compatible with Android, GAE, and the new Java 8 compact profiles
URI compliance modes for Jetty request handling.
These are URI compliance "violations", which may be allowed by the compliance mode.
PathSpec for URI Template based declarations
URI Utility methods.
Handles coding of MIME "x-www-form-urlencoded".
ResourceFactory for URL based resources.A Usage Error has occurred.
User object that encapsulates user identity and operations such as run-as-role actions,
checking isUserInRole and getUserPrincipal.
UserPrincipal
Represents a user with a credential.
Store of user authentication and authorization information.
Stateful parser for lines of UTF8 formatted text, looking for
"\n" as a line termination character.UTF-8 StringBuilder.
Various useful functions utility methods for OSGi wide use.
HttpContent.Factory implementation of CachingHttpContentFactory which evicts invalid entries from the cache.A connection pool that validates connections before
making them available for use.
Utility class for parsing and comparing version strings.
Groups rules that apply only to one or more specific virtual hosts.
An
HttpContent.Factory implementation which takes a Resource and fakes this resource as
an entry in every directory.Utility class to use to query the runtime for virtual thread support,
and, if virtual threads are supported, to start virtual threads.
Implementations of this interface can be configured to use virtual threads.
ClassLoader for HttpContext.
The Context in which the classloader operates.
WebApp Configuration
Web Application Context Handler.
Descriptor
A web descriptor (web.xml/web-defaults.xml/web-overrides.xml).
WebFilterAnnotation
WebFilterAnnotationHandler
WebListenerAnnotation
WebServletAnnotation
WebServletAnnotationHandler
Process a WebServlet annotation on a class.
Annotation for classes to be WebSocket endpoints.
A collection of components which are the resources needed for websockets such as
ByteBufferPool, WebSocketExtensionRegistry, and DecoratedObjectFactory.Provides the implementation of
Connection that is suitable for WebSocketGeneric interface to the Container (server or client)
The Core WebSocket Session.
Abstract WebSocket creator interface.
Allows to create (custom) WebSocket endpoints instances given the HTTP request and HTTP response.
A recoverable exception within the websocket framework.
A recoverable exception within the websocket framework.
Mapping of pathSpec to a tupple of
WebSocketCreator, FrameHandlerFactory and
Configuration.Customizer.A collection of components which are the resources needed for websockets such as
ByteBufferPool, WebSocketExtensionRegistry, and DecoratedObjectFactory.Interface for Listeners that are interested in knowing about the Session history.
Atomic Connection State
Exception thrown to indicate a connection I/O timeout.
Exception thrown to indicate a connection I/O timeout.
Inline Servlet Filter to capture WebSocket upgrade requests.
A
Handler that may perform the upgrade from HTTP to WebSocket.Configure by parsing default web.xml and web.xml
An implementation of
RateControl that limits the number of
events within a time period.A Utility class to help implement
EndPoint.write(Callback, ByteBuffer...) by calling
EndPoint.flush(ByteBuffer...) until all content is written.A listener of
WriteFlusher events.Wrap a Writer as an OutputStream.
An alternate to
OutputStreamWriter that supports
several optimized implementation for well known Charsets,
specifically StandardCharsets.UTF_8 and StandardCharsets.ISO_8859_1.Utility methods for converting a
URI between a HTTP(S) and WS(S) URI.A protocol handler that handles the 401 response code
in association with the
WWW-Authenticate header.Configures objects from XML.
XML Parser wrapper.
XML Attribute.
XML Node.
Handler.Abstract