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
Base class for DeploymentManager Providers that can deploy ContextHandlers into
Jetty that have been discovered via OSGI either as bundles or services.
AbstractDatabaseLoginModule
Abstract base class for LoginModules that interact with a
database to retrieve authentication and authorization information.
AbstractDecodedMessageSink.Basic<T extends jakarta.websocket.Decoder>
AbstractDecodedMessageSink.Stream<T extends jakarta.websocket.Decoder>
DiscoverableAnnotationHandler
Base class for handling the discovery of an annotation.
Partial implementation of EndPoint that uses
FillInterest
and WriteFlusher
.AbstractHandler.
Deprecated.
This class is no longer required as ERROR dispatch is only done if there is an error page target.
Abstract Handler Container.
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.
An abstract Network Connector.
AbstractOSGiApp
Base class representing info about a webapp/ContextHandler that is deployed into Jetty.
Abstract base class for proxy servlets.
Utility class that implement transparent proxy functionalities.
Partial implementation of
Request.Content
.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
Deprecated.
use
AbstractRequestContent
instead.AbstractUserAuthentication
Base class for representing an authenticated user.
AbstractWebAppProvider
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.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
ContextHandler
s resource base which
is not protected by a protected target as defined by ContextHandler.getProtectedTargets()
at start.Deprecated.
use
SymlinkAllowedResourceAliasChecker
instead.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.
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.
Extension of WebAppContext to allow configuration via Ant environment.
AntServletHandler
AntServletHolder
AntURLClassLoader
Adapt the AntClassLoader which is not a URLClassLoader - this is needed for
jsp to be able to search the classpath.
This configuration object provides additional way to inject application
properties into the configured web application.
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
App
s to the DeploymentManager
A ByteBuffer pool where ByteBuffers are held in queues that are held in array elements.
A
RetainableByteBuffer
pool where RetainableByteBuffers are held in Pool
s that are
held in array elements.Utility methods for Array manipulation
Deprecated.
no replacement, use
Request.Content
instead.A listener that is notified of content availability
A handler wrapper that provides the framework to asynchronously
delay the handling of a request.
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
ContainerLifeCycle
Normalize Attribute to String.
Attributes.
A Wrapper of attributes
Authentication
represents a mechanism to authenticate requests for protected resources.The Authentication state of a request.
An Authentication Challenge has been sent.
A deferred authentication with methods to progress
the authentication process.
An Authentication Failure has been sent.
Structure holding information about the
WWW-Authenticate
(or Proxy-Authenticate
) header.An authentication that is capable of performing a programmatic login
operation.
An authentication that is capable of performing a programmatic
logout operation.
After a logout, the authentication reverts to a state
where it is possible to programmatically log in again.
Authentication Response sent state.
Authentication.Result
holds the information needed to authenticate a Request
via Authentication.Result.apply(org.eclipse.jetty.client.api.Request)
.A successful Authentication with User information.
A wrapped authentication with methods provide the
wrapped request/response for use by the application
A store for
Authentication
s and Authentication.Result
s.Authenticator Interface
Authenticator Configuration
Authenticator Factory
A service to query for user roles.
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.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"
FileInitializer
Implementation of the HTTP "Basic" authentication defined in RFC 2617.
Basic authentication result.
A
ServerAuthModule
implementation of HTTP Basic Authentication.The possible batch modes when enqueuing outgoing frames.
Parser for the BEGIN_REQUEST frame content.
Behavior for how the WebSocket should operate.
BindingEnumeration
A BlockingQueue backed by a circular array capable or growing.
The base parser for the frame body of HTTP/2 frames.
Default implementation of the
Decoder.Text
Message to Boolean
decoder.Default encoder for
Boolean
to Encoder.Text
Message encoderBoundDelegatingInputStream
An InputStream that delegates methods to an ObjectInput.
A Handler that can apply a
HttpOutput.Interceptor
mechanism to buffer the entire response content until the output is closed.An
HttpOutput.Interceptor
which is created by BufferedResponseHandler.newBufferedInterceptor(HttpChannel, Interceptor)
and is used by the implementation to buffer outgoing content.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.
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.
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.Deprecated.
use
ByteBufferRequestContent
instead.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
ByteBuffer
pool.ByteBuffer based RangeWriter
A
Request.Content
for ByteBuffer
s.Default implementation of the
Decoder.Text
Message to Byte
decoderDefault encoder for
Byte
to Encoder.Text
Message encoderDeprecated.
use
BytesRequestContent
instead.A
Request.Content
for byte arrays.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 CompletableFuture that is also a Callback.
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.
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.
Deprecated.
Prefer using
SslClientCertAuthenticator
Factory for client-side
Connection
instances.Wraps another ClientConnectionFactory.
A holder for a list of protocol strings identifying an application protocol
(for example
["h2", "h2-17", "h2-16"]
) and a ClientConnectionFactory
that creates connections that speak that network protocol.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.
Configures a
ClientConnector
.A pair/record holding a
SelectableChannel
and a SocketAddress
to connect to.Client specific implementation of
ProtocolSession
.The client specific implementation of
QuicConnection
.The client specific implementation of
QuicSession
.Client based UpgradeRequest API
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.
Rewrite the URI by compacting to remove //
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
ComplianceViolation
s that are allowed.A Configuration Source
Weighted List of ConfigSources.
A LoginAuthenticator that uses SPNEGO and the GSS API to authenticate requests.
A configurable (as opposed to using system properties) SPNEGO LoginService.
A pluggable Configuration for
WebAppContext
s.Experimental Wrapper mechanism for WebApp Configuration components.
ConfigurationManager
Type for allow injection of property values for replacement in jetty xml files during deployment.
A ConfigurationProcessor for non XmlConfiguration format files.
An ordered list of
Configuration
instances.Associate a JSR Endpoint with its optional
EndpointConfig
Implementation 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 Connector
s.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 being usable for a maximum number of requests.
Marks a connection as supporting multiplexed requests.
A
Connection.Listener
that tracks connection statistics.Connector
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.Specifies a jetty configuration
<connectors/>
element for Ant build file.LifeCycle wrapper for JMXConnectorServer.
A
Throwable
that may be used in static contexts.Constraint
Describe an auth and/or data constraint.
ConstraintSecurityHandler
A Container
Inherited Listener.
A listener for Container events.
The "Container Default Configurator" per the JSR-356 spec.
Deprecated.
Utility Methods for manual execution of
ServletContainerInitializer
when
using Embedded Jetty.ContainerInitializerAnnotationHandler
A ContainerLifeCycle is an
LifeCycle
implementation for a collection of contained beans.ContentDecoder
decodes content bytes of a response.Factory for
ContentDecoder
s; 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 HttpChannel
.Deprecated.
use
Request.Content
instead, or ContentProvider.toRequestContent(ContentProvider)
to convert ContentProvider to Request.Content
.Deprecated.
use
Request.Content
insteadA specialized
Response
that can hold a limited content in memory.ContextFactory
ContextHandler.
Interface to check aliases
Deprecated.
use
AllowedResourceAliasChecker
instead.Deprecated.
Listener for all threads entering context scope, including async IO callbacks
A simple implementation of ServletContext that is used when there is no
ContextHandler.
This
HandlerCollection
is creates a
Map of contexts to it's contained handlers based
on the context path and virtual hosts of any contained ContextHandler
s.Specifies
<contextHandlers/>
element in web app configuration.A protocol handler that handles the 100 response code.
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 the cookie in the response whenever the rule finds a match.
Cookie parser
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
A flexible RequestLog, which produces log strings in a customizable format.
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
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.
A Deployment binding that installs a DebugListener in all deployed contexts
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
DecoratedObjectFactory
A very basic
AuthConfigFactory
that allows for registering providers programmatically.The Default Authenticator Factory.
DefaultBundleClassLoaderHelper
DefaultCallbackHandler
An implementation of the JAAS CallbackHandler.
DefaultFileLocatorHelper
Default Handler.
Default Identity Service implementation.
DefaultJettyAtJettyHomeHelper
DefaultsDescriptor
The default servlet.
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.
Deprecated.
use
AsyncRequestContent
instead.This is extended by an
Extension
so it can intercept demand calls.This flusher can be used to mutated and fragment
Frame
s and forwarded them on towards the application using the
IncomingFrames
provided in the constructor.The Deployment Manager.
DescriptorProcessor
Destination
represents the triple made of the Destination.getScheme()
, the Destination.getHost()
and the Destination.getPort()
.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.setInitParameter(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.
Centralized logic for Dispatched Message Handling.
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.
A destination for those network transports that are duplex (e.g.
Deprecated, for removal: This API element is subject to removal in a future version.
This class has been renamed to
AdaptiveExecutionStrategy
Basic Graph Edge
Deprecated.
LoginService implementation which always denies any attempt to login.
EmptyResource
Represents a resource that does does not refer to any file, url, jar etc.
A
Future<Void>
that is already failed as a result of an Encode errorEndPoint is the abstraction for an I/O channel that transports bytes.
Marks an
EndPoint
that wraps another EndPoint
.Parser for the END_REQUEST frame content.
EnvConfiguration
EnvEntry
A Jetty specialization of EOFException.
Standard HTTP/2 error codes.
Handler for Error pages
An ErrorHandler is registered with
ContextHandler.setErrorHandler(ErrorHandler)
or
Server.setErrorHandler(ErrorHandler)
.An ErrorHandler that maps exceptions and status codes to URIs for dispatch using
the internal ERROR style of dispatch.
Utility class for emitting OSGi EventAdmin events
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
AsyncProxyServlet.Transparent
for FastCGI.A container for name/value pairs, known as fields.
A named list of string values.
A Handler that can apply a
HttpOutput.Interceptor
mechanism to buffer the entire response content until the output is closed.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.
Describes set of files matched by
<fileset/>
elements in ant configuration
file.Deprecated.
use
org.eclipse.jetty.server.StateLifeCycleListener
insteadFileSessionDataStore
A file-based store of session data.
FileSessionDataStoreFactory
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.
This Authentication represents a just completed Form authentication.
Deprecated.
use
FormRequestContent
instead.A
Request.Content
for form uploads with the
"application/x-www-form-urlencoded" content type.Customize Requests for Proxy Forwarding.
Ordered Source Enum.
Set the scheme for the request
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.
Interface for local WebSocket Endpoint Frame handling.
Factory for FrameHandler instances
Some static utility methods for validating a
Frame
based on the state of its CoreSession
.A
BufferingResponseListener
that is also a Future
, to allow applications
to block (indefinitely or for a timeout) until FutureResponseListener.onComplete(Result)
is called,
or to abort
the request/response conversation.GCloudSessionDataStore
EntityDataModel
Names of type of Entity and Entity properties for sessions.
ExpiryInfo
Information related to session expiry
GCloudSessionDataStoreFactory
Generating a frame in WebSocket land.
Provides a way of globally setting various aspects of webapp contexts.
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.
Basic directed graph implementation
Output the Graph in GraphViz Dot format.
ContentDecoder
for the "gzip" encoding.Decoder for the "gzip" content encoding.
Specialized
ContentDecoder.Factory
for the "gzip" encoding.A Handler that can dynamically GZIP uncompress requests, and compress responses.
An HttpInput Interceptor that inflates GZIP encoded request content.
A LifeCycle listener that halts the JVM with exit
code
0
when notified of the "started" event.A Jetty Server Handler.
A collection of handlers.
A Handler that contains other Handlers.
HandlerList.
A
HandlerWrapper
acts as a Handler
but delegates the handle
method and
life cycle
events to a delegate.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.
Parser for the FastCGI frame header.
The parser for the frame header of HTTP/2 frames.
Sets the header in the response whenever the rule finds a match.
Rule to add a header based on a Regex match
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.
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.
A HTTP/3 specific
QuicServerConnector
that configures QUIC parameters according to HTTP/3 requirements.HttpChannel represents a single endpoint for HTTP semantic processing.
Listener for
HttpChannel
events.Deprecated.
A
HttpChannel.Listener
that holds a collection of
other HttpChannel.Listener
instances that are efficiently
invoked without iteration.An HttpChannel customized to be transported over the HTTP/1 protocol
Implementation of AsyncContext interface that holds the state of request-response cycle.
The actions to take as the channel moves from state to state.
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.Deprecated, for removal: This API element is subject to removal in a future version.
use any
HttpClientTransport
with ClientConnector.forUnixDomain(Path)
instead (requires Java 16 or later)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.
Range Writer selection for HttpContent
Implementation of
CookieStore
that delegates to an instance created by CookieManager
via CookieManager.getCookieStore()
.An HTTP Field
Interface to pre-encode HttpFields.
Interface that represents on ordered collection of
HttpField
s.HTTP Fields.
HTTP Fields.
HttpGenerator.
While this class is-a Runnable, it should never be dispatched in it's own thread.
A content represents the production of a
HttpChannel
returned by HttpChannel.produceContent()
.EOF special content.
Error special content.
HttpInput.Content
interceptor that can be registered using HttpInput.setInterceptor(Interceptor)
or
HttpInput.addInterceptor(Interceptor)
.Abstract class that implements the standard special content behavior.
Simple non-special content wrapper allow overriding the EOF flag.
Known HTTP Methods
HttpOutput
implements ServletOutputStream
as required by the Servlet specification.The HttpOutput.Interceptor is a single intercept point for all
output written to the HttpOutput: via writer; via output stream;
asynchronously; or blocking.
A Parser for 1.0 and 1.1 as defined by RFC7230
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 HTTP Testing helper class.
HTTP constants
Abstraction of the outbound HTTP transport.
HttpUpgrader prepares a HTTP request to upgrade from one protocol to another,
and implements the upgrade mechanism.
A factory for
HttpUpgrader
s.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 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.
Utility class to maintain a set of inclusions and exclusions.
Byte range inclusive of end points.
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.
Set up the marshaller for InfinispanSessionData serialization
InfinispanSessionData
Specialization of SessionData to hold the attributes as a serialized byte
array.
InfinispanSessionDataStore
InfinispanSessionDataStoreFactory
InfinispanSessionLegacyConverter
Converts sessions saved in the old serialization
format into the new protobuf-based serialization.
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.
Deprecated.
use
InputStreamRequestContent
insteadDefault Range Writer for 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.
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.
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.
The SPI interface for implementing an HTTP/2 session.
The SPI interface for implementing an HTTP/2 stream.
An ordered list of frames belonging to the same stream.
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
JAASLoginService
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.
This manages the LifeCycle of
WebSocketContainer
instances that are created with
ContainerProvider
, if this code is being run from another ServletContainer, or if run inside a
Jetty Server with the WebSocket client classes provided by the webapp.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.
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
HttpContext
Jetty implementation of
HttpExchange
Jetty 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)
Ant task for running a Jetty server.
JettyServerServiceTracker
Tracks instances of Jetty Servers, and configures them so that they can deploy
webapps or ContextHandlers discovered from the OSGi environment.
JettyStopTask
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
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
.Lazy List creation.
A LdapLoginModule for use with JAAS setups
A facility to detect improper usage of resource pools.
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.
Deprecated.
Extension of the
ArrayByteBufferPool
whose bucket sizes increase exponentially instead of linearly.A variant of the
ArrayRetainableByteBufferPool
that
uses buckets of buffers that increase in size by a power of
2 (eg 1k, 2k, 4k, 8k, etc.).LoggedOutAuthentication
An Authentication indicating that a user has been previously, but is not currently logged in,
but may be capable of logging in after a call to Request.login(String,String)
Deprecated.
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.
Specifies a jetty configuration <loginServices/> element for Ant build file.
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 javax.mail.Reference and an ObjectFactory for javax.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
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.
A ByteBuffer pool where ByteBuffers are held in queues that are held in a Map.
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
MemcachedSessionDataMap
Uses memcached as a cache for SessionData.
SessionDataTranscoder
We override memcached deserialization to use our classloader-aware
ObjectInputStream.
MemcachedSessionDataMapFactory
MemoryUtils provides an abstraction over memory properties and operations.
A utility implementation of FrameHandler that defragments
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
OutputStream
Support class for reading a (single) WebSocket TEXT message via a Reader.
Sink consumer for messages (used for multiple frames with continuations,
and also to allow for streaming APIs)
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
Writer
MetaData
All data associated with the configuration and deployment of a web application.
Metadata regarding where a deployable element was declared:
by annotation or by descriptor.
MetaInfConfiguration
MIME Type enum and utilities
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.
MongoSessionDataStore
The document model is an outer object that contains the elements:
"id" : session_id
"created" : create_time
"accessed": last_access_time
"maxIdle" : max_idle_time setting as session was created
"expiry" : time at which session should expire
"valid" : session_valid
"context" : a nested object containing 1 nested object per context for which the session id is in use
Each of the nested objects inside the "context" element contains:
unique_context_name : nested object containing name:value pairs of the session attributes for that context
unique_context_name: vhost:contextpath, where no vhosts="0_0_0_0", root context = "", contextpath "/" replaced by "_"
MongoSessionDataStoreFactory
MongoUtils
Some utility methods for manipulating mongo data.
A
QueuedThreadPool
subclass that monitors its own activity by recording queue and task statistics.Moved ContextHandler.
Special handling for MSIE (Microsoft Internet Explorer).
Deprecated.
use MsieRule
Wraps multiple exceptions.
A multi valued Map.
MultiPartConfigAnnotationHandler
Deprecated.
use
MultiPartRequestContent
instead.The compliance level for parsing
multiPart/form-data
MultiPartInputStream
Deprecated.
Replaced by org.eclipse.jetty.http.MultiPartFormInputStream
The code for MultiPartInputStream is slower than its replacement MultiPartFormInputStream.
Handle a multipart MIME response.
A parser for MultiPart content type.
A
Request.Content
for form uploads with the "multipart/form-data"
content type.Handle a multipart MIME response.
A destination for those transports that are multiplex (e.g.
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 connectorsA listener for raw network traffic within Jetty.
A specialized version of
ServerConnector
that supports NetworkTrafficListener
s.A specialized version of
SocketChannelEndPoint
that supports NetworkTrafficListener
s.Basic Graph Node
NoSqlSessionDataStore
NullQueryManagerFactory
Trivial impl of the QueryManagerFactory that does not support doing queries.
NullSessionCache
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 tagging methods to receive connection close events.
Annotation for tagging methods to receive connection open events.
Annotation for receiving websocket errors (exceptions) that have occurred internally in the websocket implementation.
(ADVANCED) Annotation for tagging methods to receive frame events.
Annotation for tagging methods to receive Binary or Text Message events.
This class is used to wrap the
Authenticator.AuthConfiguration
given to the OpenIdAuthenticator
.Implements authentication using OpenId Connect on top of OAuth 2.0.
This Authentication represents a just completed OpenId Connect authentication.
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.
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.
OSGiWebInfConfiguration
Handle adding resources found in bundle fragments, and add them into the
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.
OSGiWebInfConfiguration
Handle adding resources found in bundle fragments, and add them into the
Interface for dealing with frames outgoing to (eventually) the network layer.
Deprecated.
use
OutputStreamRequestContent
insteadA
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.
Password utility class.
Deprecated.
use
PathRequestContent
instead.Path Mappings of PathSpec to Resource.
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 ServerEndpointConfig
A
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.
Watch a Path (and sub directories) for Path changes.
Listener that reports accumulated events in one shot
Listener for path change events
Type of an event
Abstract rule that use a
ServletPathSpec
for 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 optional support for multiplexing,
max usage count and several optimized strategies plus
an optional
ThreadLocal
cache of the last release entry.The type of the strategy to use for the pool.
PostConstructCallback
PreDestroyCallback
Pre encoded HttpField.
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.
FileConfigurationManager
Supplies properties defined in a file.
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
ProtocolHandler
s 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 proxy 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 ServletRequest.setAttribute(String, Object)
.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.A Session QPACK Exception.
A Stream QPACK exception.
A thread pool with a queue of jobs to execute.
A QUIC specific
ClientConnector.Configurator
.A 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 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 RFC7230.
Implements a quoted comma separated list of quality values
in accordance with RFC7230 and RFC7231.
StringTokenizer with Quoting support.
A
ConnectionPool
that provides connections
randomly among the ones that are available.Interface for writing sections (ranges) of a single resource (SeekableByteChannel, Resource, etc) to an outputStream.
Controls rate of events via
RateControl.onEvent(Object)
.Factory to create RateControl instances.
Counts the rate that
Long
s are added to this from the time of creation or the last call to RateCounter.reset()
.Statistics on a time sequence rate.
Deprecated, for removal: This API element is subject to removal in a future version.
Issues a (3xx) Redirect response whenever the rule finds a 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 match via regular expression.
Utility for managing redirect based rules
RegexPathSpec is a PathSpec implementation for a
PathMappings
instance.Abstract rule to use as a base class for rules that match with a regular expression.
A Set of Regular expressions strings.
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.Jetty Request.
Listener for the request begin event.
Listener for the request committed event.
A reactive model to produce request content, similar to
Flow.Publisher
.A reactive model to consume request content, similar to
Flow.Subscriber
.The link between a content producer and a content consumer.
Listener for the request content event.
Listener for the request failed event.
Listener for the request headers event.
Listener for all request events.
An empty implementation of
Request.Listener
Listener for the request queued event.
Common, empty, super-interface for request listeners.
Listener for the request succeeded event.
Implements the conversion from
ContentProvider
to Request.Content
.A
RequestLog
can be attached to a RequestLogHandler
to enable
logging of requests/responses.Writes the generated log string to a log sink
This handler provides an alternate way (other than
Server.setRequestLog(RequestLog)
)
to log request, that can be applied to a particular handler (eg context).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
Abstract resource class.
A collection of resources (dirs).
An HttpContent.Factory for transient content (not cached).
ResourceFactory.
Resource Handler.
HttpContent created from a
Resource
.Abstract resource service, used by DefaultServlet and ResourceHandler
Response
represents an HTTP response and offers methods to retrieve status code, HTTP version
and headers.Response
provides the implementation for HttpServletResponse
.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.
An empty implementation of
Response.Listener
Common, empty, super-interface for response listeners
Listener for the response succeeded event.
The parser for STDOUT frame content.
Sends the response code whenever the rule finds a match.
Specialized PrintWriter for servlet Responses
A pooled ByteBuffer which maintains a reference count that is
incremented with
RetainableByteBuffer.retain()
and decremented with RetainableByteBuffer.release()
.A
RetainableByteBuffer
pool. Rewrite handler is responsible for managing the rules.
Rewrite the URI by replacing the matched
ServletPathSpec
path with a fixed string.Rewrite the URI by matching with a regular expression.
Cookie parser
RoleInfo
Badly named class that holds the role and user data constraint info for a
path/http method combination, extracted and combined from security
constraints.
RolePrincipal
Represents a role.
RolloverFileOutputStream.
A
ConnectionPool
that attempts to provide connections using a round-robin algorithm.An abstract rule for creating rewrite rules.
Interface used to apply a changed target if
RuleContainer.setRewriteRequestURI(boolean)
is true.Base container to group rules.
Deprecated.
unused as of 9.4.28 due for removal in 10.0.0
Deprecated.
class unused as of 9.4.28 due for removal in 10.0.0
marker interface for run-as-role tokens
Deprecated.
No replacement provided or available.
Subclass of
RuntimeException
used to signal that there
was an IOException
thrown by underlying Writer
Deprecated.
use
AllowedResourceAliasChecker
instead.Statistics 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
.ScopedHandler.
SearchPattern
Fast search for patterns within strings and arrays of bytes.
SecuredRedirectHandler redirects from
http
to https
.Customizer that extracts the attribute from an
SSLContext
and sets them on the request with ServletRequest.setAttribute(String, Object)
according to Servlet Specification Requirements.Abstract SecurityHandler.
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 ManagedSelector
s 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 Callback
An executor than ensurers serial execution of submitted tasks.
Error handling task
Jetty HTTP Servlet Server.
Deprecated.
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.
ServerInstanceWrapper
Configures and starts a jetty Server instance.
Server specific implementation of
ProtocolSession
.A proxy class for interaction with Jetty server object.
WebAppScannerListener
Handle notifications that files we are interested in have changed
during execution.
The server specific implementation of
QuicConnection
.The server specific implementation of
QuicSession
.Server-side extension of
Session.Listener
that exposes additional events.Empty implementation of
ServerSessionListener
Upgrade request used for websocket negotiation.
Upgrade response used for websocket negotiation.
ServiceContextProvider
Jetty DeploymentManager Provider that is able to deploy ContextHandlers discovered via OSGi as services.
ServiceProvider
Jetty DeploymentManager Provider api for webapps or ContextHandlers that are discovered as OSGi services.
ServiceWebAppProvider
An implementation of Attributes that supports the standard async attributes.
Holds a ServletContainerInitializer.
Experimental Wrapper mechanism for ServletContainerInitializer objects.
Deprecated.
Servlet Context.
Deprecated.
Bean that is added to the ServletContextHandler to start all of the
ServletContainerInitializers by starting their corresponding
ServletContainerInitializerHolders when this bean is itself started.
Servlet HttpHandler.
A mapping of a servlet by pathSpec or by name
Servlet Instance and Context Holder.
Experimental Wrapper mechanism for Servlet objects.
Implementation of HttpServletMapping.
ServletRequestCallback
Provides access to the request associated with the authentication.
ServletRequestHttpWrapper
Class to tunnel a ServletRequest via an HttpServletRequest
ServletResponseHttpWrapper
Wrapper to tunnel a ServletResponse via an HttpServletResponse
Jetty Servlets Configuration
ServletSecurityAnnotationHandler
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.
Session
A heavy-weight Session object representing an HttpSession.
Session represents an active link of communications with a Remote WebSocket Endpoint.
The client-side HTTP/3 API representing a connection with a server.
The client-side specific
Session.Listener
.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.Empty implementation of
Stream.Listener
.The server-side HTTP/3 API representing a connection with a client.
The server-side specific
Session.Listener
.State
Validity states of a session
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
Session
objects for a context.SessionCacheFactory
SessionContext
Information about the context to which sessions belong: the Context,
the SessionHandler 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
SessionDataMarshaller
A marshaller for converting a SessionData object into protobuf format which
gives greater control over serialization/deserialization.
SessionDataStore
A store for the data contained in a Session object.
SessionDataStoreFactory
SessionHandler.
SessionIf
Interface that any session wrapper should implement so that
SessionManager may access the Jetty session implementation.
Session ID Manager.
Provides a reusable
Callback
that can block the thread
while waiting to be completed.Default implementation of the
Decoder.Text
Message to Short
decoderDefault encoder for
Short
to Encoder.Text
Message encoderA handler that shuts the server down on a valid request.
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.
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.
Helper class for SOCKS5 proxying.
A SOCKS5 authentication method.
A factory for
Socks5.Authentication
s.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.
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.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.Collect and report statistics about requests / responses / connections and more.
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
Stream.Data
instance associates a ByteBuffer
containing request bytes or response bytes with a completion event
that applications must trigger when the bytes have been
processed.A
Stream.Listener
is the passive counterpart of a Stream
and receives
events happening on an HTTP/2 stream.Empty implementation of
Stream.Listener
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.
Deprecated.
use
StringRequestContent
instead.Default implementation of the
Decoder.Text
Message to String
decoderDefault encoder for
String
to Encoder.Text
Message encoderA
Request.Content
for strings.Fast String Utilities.
Connection suspend token
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.Implementations of this interface expose a lock object
via
Synchronizable.getLock()
so that callers can synchronize
externally on that lock:Collection of Syntax validation methods.
SystemProperties
Provides logging functionality for classes without access to the Ant project
variable.
If this rule matches, terminate the processing of other rules.
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
FileInitializer
Simple common abstraction for Text files, that consist of a series of lines.
Collection of utility methods for Text content
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.
Deprecated.
Do not use it, use
CyclicTimeouts
instead.A scheduler based on the the JVM Timer class
TldBundleDiscoverer
Convert bundles that contain tlds into URL locations for consumption by jasper.
Topological sort a list or array.
Transaction
Class to represent a JTA UserTransaction impl.
This is used to iteratively transform or process a frame into one or more other frames.
A variation of Executor that can confirm if a thread is available immediately
Inspired by nginx's try_files functionality.
TYPE Utilities.
Unix Crypt.
Deprecated, for removal: This API element is subject to removal in a future version.
Use UnixDomainServerConnector from the jetty-unixdomain-server module instead (requires Java 16 or later).
Deprecated, for removal: This API element is subject to removal in a future version.
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".
URL resource class.
A Usage Error has occurred.
User object that encapsulates user identity and operations such as run-as-role actions,
checking isUserInRole and getUserPrincipal.
A UserIdentity Scope.
UserPrincipal
Represents a user with a credential.
Store of user authentication and authorization information.
Utf8 Appendable abstract base class
This abstract class wraps a standard
Appendable
and provides methods to append UTF-8 encoded bytes, that are converted into characters.OutputWriter.
Stateful parser for lines of UTF8 formatted text, looking for
"\n"
as a line termination character.UTF-8 StringBuffer.
UTF-8 StringBuilder.
Various useful functions utility methods for OSGi wide use.
A connection pool that validates connections before
making them available for use.
This rule can be used to protect against invalid unicode characters in a url making it into applications.
Utility class for parsing and comparing version strings.
Groups rules that apply only to a specific virtual host
or sets of virtual hosts
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.
The webapps directory scanning provider.
Descriptor
A web descriptor (web.xml/web-defaults.xml/web-overrides.xml).
WebFilterAnnotation
WebFilterAnnotationHandler
WebListenerAnnotation
WebServletAnnotation
WebServletAnnotationHandler
Process a WebServlet annotation on a class.
Tags a POJO as being a WebSocket class.
Default implementation of the
WebSocketListener
.Behavior for how the WebSocket should operate.
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 WebSocketCore WebSocket Connection Listener
Generic interface to the Container (server or client)
The Core WebSocket Session.
Abstract WebSocket creator interface.
A recoverable exception within the websocket framework.
A recoverable exception within the websocket framework.
WebSocket Frame Listener interface for incoming WebSocket frames.
Basic WebSocket Listener interface for incoming WebSocket message events.
Mapping of pathSpec to a tupple of
WebSocketCreator
, FrameHandlerFactory
and
Configuration.Customizer
.WebSocket Partial Message Listener interface for incoming WebSocket TEXT/BINARY/CONTINUATION frames.
WebSocket PING/PONG Listener interface for incoming WebSocket PING/PONG frames.
Settings for WebSocket operations.
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.
Configure by parsing default web.xml and web.xml
An implementation of
RateControl
that limits the number of
events within a time period.A wrapper for
Authenticator.AuthConfiguration
.Callback for Write events.
Deprecated.
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.
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.