| org.apache.catalina |
|
| Java Source File Name | Type | Comment |
| Authenticator.java | Interface | An Authenticator is a component (usually a Valve or Container) that
provides some sort of authentication service. |
| Cluster.java | Interface | A Cluster works as a Cluster client/server for the local host
Different Cluster implementations can be used to support different
ways to communicate within the Cluster. |
| CometEvent.java | Interface | The CometEvent interface. |
| CometFilter.java | Interface | A Comet filter, similar to regular filters, performs filtering tasks on either
the request to a resource (a Comet servlet), or on the response from a resource, or both.
Filters perform filtering in the doFilterEvent method. |
| CometFilterChain.java | Interface | A CometFilterChain is an object provided by the servlet container to the developer
giving a view into the invocation chain of a filtered event for a resource. |
| CometProcessor.java | Interface | This interface should be implemented by servlets which would like to handle
asynchronous IO, recieving events when data is available for reading, and
being able to output data without the need for being invoked by the container. |
| Contained.java | Interface | Decoupling interface which specifies that an implementing class is
associated with at most one Container instance.
author:
Craig R. |
| Container.java | Interface | A Container is an object that can execute requests received from
a client, and return responses based on those requests. |
| ContainerEvent.java | Class | General event for notifying listeners of significant changes on a Container.
author:
Craig R. |
| ContainerListener.java | Interface | Interface defining a listener for significant Container generated events.
Note that "container start" and "container stop" events are normally
LifecycleEvents, not ContainerEvents.
author:
Craig R. |
| ContainerServlet.java | Interface | A ContainerServlet is a servlet that has access to Catalina
internal functionality, and is loaded from the Catalina class loader
instead of the web application class loader. |
| Context.java | Interface | A Context is a Container that represents a servlet context, and
therefore an individual web application, in the Catalina servlet engine.
It is therefore useful in almost every deployment of Catalina (even if a
Connector attached to a web server (such as Apache) uses the web server's
facilities to identify the appropriate Wrapper to handle this request.
It also provides a convenient mechanism to use Interceptors that see
every request processed by this particular web application.
The parent Container attached to a Context is generally a Host, but may
be some other implementation, or may be omitted if it is not necessary.
The child containers attached to a Context are generally implementations
of Wrapper (representing individual servlet definitions).
author:
Craig R. |
| Engine.java | Interface | An Engine is a Container that represents the entire Catalina servlet
engine. |
| Executor.java | Interface | |
| Globals.java | Class | Global constants that are applicable to multiple packages within Catalina.
author:
Craig R. |
| Group.java | Interface | Abstract representation of a group of
User s in a
UserDatabase . |
| Host.java | Interface | A Host is a Container that represents a virtual host in the
Catalina servlet engine. |
| InstanceEvent.java | Class | General event for notifying listeners of significant events related to
a specific instance of a Servlet, or a specific instance of a Filter,
as opposed to the Wrapper component that manages it.
author:
Craig R. |
| InstanceListener.java | Interface | Interface defining a listener for significant events related to a
specific servlet instance, rather than to the Wrapper component that
is managing that instance.
author:
Craig R. |
| Lifecycle.java | Interface | Common interface for component life cycle methods. |
| LifecycleEvent.java | Class | General event for notifying listeners of significant changes on a component
that implements the Lifecycle interface. |
| LifecycleException.java | Class | General purpose exception that is thrown to indicate a lifecycle related
problem. |
| LifecycleListener.java | Interface | Interface defining a listener for significant events (including "component
start" and "component stop" generated by a component that implements the
Lifecycle interface.
author:
Craig R. |
| Loader.java | Interface | A Loader represents a Java ClassLoader implementation that can
be used by a Container to load class files (within a repository associated
with the Loader) that are designed to be reloaded upon request, as well as
a mechanism to detect whether changes have occurred in the underlying
repository.
In order for a Loader implementation to successfully operate
with a Context implementation that implements reloading, it
must obey the following constraints:
- Must implement
Lifecycle so that the Context can indicate
that a new class loader is required.
- The
start() method must unconditionally create a new
ClassLoader implementation.
- The
stop() method must throw away its reference to the
ClassLoader previously utilized, so that the class loader,
all classes loaded by it, and all objects of those classes, can be
garbage collected.
- Must allow a call to
stop() to be followed by a call to
start() on the same Loader instance.
- Based on a policy chosen by the implementation, must call the
Context.reload() method on the owning Context
when a change to one or more of the class files loaded by this class
loader is detected.
author:
Craig R. |
| Manager.java | Interface | A Manager manages the pool of Sessions that are associated with a
particular Container. |
| Pipeline.java | Interface | Interface describing a collection of Valves that should be executed
in sequence when the invoke() method is invoked. |
| Realm.java | Interface | A Realm is a read-only facade for an underlying security realm
used to authenticate individual users, and identify the security roles
associated with those users. |
| Role.java | Interface | Abstract representation of a security role, suitable for use in
environments like JAAS that want to deal with Principals.
author:
Craig R. |
| Server.java | Interface | A Server element represents the entire Catalina
servlet container. |
| ServerFactory.java | Class | ServerFactory allows the registration of the
(singleton) Server instance for this JVM, so that it
can be accessed independently of any existing reference to the
component hierarchy. |
| Service.java | Interface | A Service is a group of one or more
Connectors that share a single Container
to process their incoming requests. |
| Session.java | Interface | A Session is the Catalina-internal facade for an
HttpSession that is used to maintain state information
between requests for a particular user of a web application.
author:
Craig R. |
| SessionEvent.java | Class | General event for notifying listeners of significant changes on a Session.
author:
Craig R. |
| SessionListener.java | Interface | Interface defining a listener for significant Session generated events.
author:
Craig R. |
| Store.java | Interface | A Store is the abstraction of a Catalina component that provides
persistent storage and loading of Sessions and their associated user data.
Implementations are free to save and load the Sessions to any media they
wish, but it is assumed that saved Sessions are persistent across
server or context restarts.
author:
Craig R. |
| User.java | Interface | Abstract representation of a user in a
UserDatabase . |
| UserDatabase.java | Interface | Abstract representation of a database of
User s and
Group s that can be maintained by an application,
along with definitions of corresponding
Role s, and
referenced by a
Realm for authentication and access control.
author:
Craig R. |
| Valve.java | Interface | A Valve is a request processing component associated with a
particular Container. |
| Wrapper.java | Interface | A Wrapper is a Container that represents an individual servlet
definition from the deployment descriptor of the web application. |