Home » apache-tomcat-6.0.26-src » org.apache » catalina »

org.apache.catalina

Sub Packages:

org.apache.catalina.ant   This package contains a set of Task implementations for Ant (version 1.6.x or later) that can be used to interact with the Manager application to deploy, undeploy, list, reload, start and stop web applications from a running instance of Tomcat.  
org.apache.catalina.ant.jmx   This package contains a set of JMX Task implementations for Ant (version 1.6 or later) that can be used to interact with the Remote JMX JSR 160 RMI Adaptor to get/set attributes, invoke MBean operations and query for Mbeans inside a running instance of Tomcat.  
org.apache.catalina.authenticator   This package contains Authenticator implementations for the various supported authentication methods (BASIC, DIGEST, and FORM).  
org.apache.catalina.cluster    
org.apache.catalina.cluster.deploy    
org.apache.catalina.cluster.io    
org.apache.catalina.cluster.mcast    
org.apache.catalina.cluster.session    
org.apache.catalina.cluster.tcp    
org.apache.catalina.cluster.util   This package contains code for Clustering, the base class of a Cluster is org.apache.catalina.Cluster implementations of this class is done when implementing a new Cluster protocol The only Cluster protocol currently implemented is a JavaGroups based      JGCluster.java  
org.apache.catalina.connector    
org.apache.catalina.core    
org.apache.catalina.deploy   This package contains Java objects that represent complex data structures from the web application deployment descriptor file ( web.xml ).  
org.apache.catalina.ha   This package contains code for Clustering, the base class of a Cluster is org.apache.catalina.Cluster implementations of this class is done when implementing a new Cluster protocol  
org.apache.catalina.ha.authenticator    
org.apache.catalina.ha.context    
org.apache.catalina.ha.deploy    
org.apache.catalina.ha.session    
org.apache.catalina.ha.tcp    
org.apache.catalina.ha.util    
org.apache.catalina.hostmanager    
org.apache.catalina.launcher    
org.apache.catalina.loader    
org.apache.catalina.logger    
org.apache.catalina.manager    
org.apache.catalina.manager.host    
org.apache.catalina.manager.util    
org.apache.catalina.mbeans    
org.apache.catalina.net    
org.apache.catalina.realm   This package contains Realm implementations for the various supported realm technologies for authenticating users and identifying their associated roles.  
org.apache.catalina.security    
org.apache.catalina.servlets   This package contains Servlets that implement some of the standard functionality provided by the Catalina servlet container.  
org.apache.catalina.session   This package contains the standard Manager and Session implementations that represent the collection of active sessions and the individual sessions themselves, respectively, that are associated with a Context .  
org.apache.catalina.ssi   This package contains code that is used by the SsiInvoker. This class consists of SsiMediator.java which works as a mediator between the different SsiCommands.  
org.apache.catalina.startup    
org.apache.catalina.storeconfig    
org.apache.catalina.tribes   Apache Tribes - The Tomcat Cluster Communication Module QuickStart //create a channel Channel myChannel = new GroupChannel(); //create my listeners MyMessageListener msgListener = new MyMessageListener(); MyMemberListener mbrListener = new MyMemberListener(); //attach the listeners to the channel myChannel.addMembershipListener(mbrListener); myChannel.addChannelListener(msgListener); //start the channel myChannel.start(Channel.DEFAULT); //create a message to be sent, message must implement java.io.Serializable //for performance reasons you probably want them to implement java.io.Externalizable Serializable myMsg = new MyMessage(); //retrieve my current members Member[] group = myChannel.getMembers(); //send the message channel.send(group,myMsg,Channel.SEND_OPTIONS_DEFAULT); Interfaces for the Application Developer org.apache.catalina.tribes.Channel Main component to interact with to send messages org.apache.catalina.tribes.MembershipListener Listen to membership changes org.apache.catalina.tribes.ChannelListener Listen to data messages org.apache.catalina.tribes.Member Identifies a node, implementation specific, default is org.apache.catalina.tribes.membership.MemberImpl Interfaces for the Tribes Component Developer org.apache.catalina.tribes.Channel Main component to that the application interacts with org.apache.catalina.tribes.ChannelReceiver IO Component to receive messages over some network transport org.apache.catalina.tribes.ChannelSender IO Component to send messages over some network transport org.apache.catalina.tribes.MembershipService IO Component that handles membership discovery and org.apache.catalina.tribes.ChannelInterceptor interceptors between the Channel and the IO layer org.apache.catalina.tribes.ChannelMessage The message that is sent through the interceptor stack down to the IO layer org.apache.catalina.tribes.Member Identifies a node, implementation specific to the underlying IO logic  
org.apache.catalina.tribes.group    
org.apache.catalina.tribes.group.interceptors    
org.apache.catalina.tribes.io    
org.apache.catalina.tribes.membership    
org.apache.catalina.tribes.tipis    
org.apache.catalina.tribes.transport    
org.apache.catalina.tribes.transport.bio    
org.apache.catalina.tribes.transport.bio.util    
org.apache.catalina.tribes.transport.nio    
org.apache.catalina.tribes.util    
org.apache.catalina.users    
org.apache.catalina.util    
org.apache.catalina.valves   This package contains a variety of small Valve implementations that do not warrant being packaged separately.  

Interfaces:

Auditor   Defines interface of classes which implement audit functionality.  code | html
Authenticator   An Authenticator is a component (usually a Valve or Container) that provides some sort of authentication service.  code | html
Cluster   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.  code | html
CometEvent   The CometEvent interface.  code | html
CometFilter   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.  code | html
CometFilterChain   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.  code | html
CometProcessor   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.  code | html
Connector   A Connector is a component responsible receiving requests from, and returning responses to, a client application.  code | html
Contained  

Decoupling interface which specifies that an implementing class is associated with at most one Container instance.

 
code | html
Container   A Container is an object that can execute requests received from a client, and return responses based on those requests.  code | html
ContainerListener   Interface defining a listener for significant Container generated events.  code | html
ContainerServlet   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.  code | html
Context   A Context is a Container that represents a servlet context, and therefore an individual web application, in the Catalina servlet engine.  code | html
DefaultContext   Used to store the default configuration a Host will use when creating a Context.  code | html
Deployer   A Deployer is a specialized Container into which web applications can be deployed and undeployed.  code | html
Engine   An Engine is a Container that represents the entire Catalina servlet engine.  code | html
Executor     code | html
Group  

Abstract representation of a group of User s in a UserDatabase

code | html
Host   A Host is a Container that represents a virtual host in the Catalina servlet engine.  code | html
HttpRequest   An HttpRequest is the Catalina internal facade for an HttpServletRequest that is to be processed, in order to produce the corresponding HttpResponse code | html
HttpResponse   An HttpResponse is the Catalina-internal facade for an HttpServletResponse that is to be produced, based on the processing of a corresponding HttpRequest code | html
InstanceListener   Interface defining a listener for significant events related to a specific servlet instance, rather than to the Wrapper component that is managing that instance.  code | html
Lifecycle   Common interface for component life cycle methods.  code | html
LifecycleListener   Interface defining a listener for significant events (including "component start" and "component stop" generated by a component that implements the Lifecycle interface.  code | html
Loader   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.  code | html
Logger   A Logger is a generic interface for the message and exception logging methods of the ServletContext interface.  code | html
Manager   A Manager manages the pool of Sessions that are associated with a particular Container.  code | html
Pipeline  

Interface describing a collection of Valves that should be executed in sequence when the invoke() method is invoked. 

code | html
Realm   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.  code | html
Request   A Request is the Catalina-internal facade for a ServletRequest that is to be processed, in order to produce the corresponding Response code | html
Response   A Response is the Catalina-internal facade for a ServletResponse that is to be produced, based on the processing of a corresponding Request code | html
Role  

Abstract representation of a security role, suitable for use in environments like JAAS that want to deal with Principals.

 
code | html
Server   A Server element represents the entire Catalina servlet container.  code | html
Service   A Service is a group of one or more Connectors that share a single Container to process their incoming requests.  code | html
Session   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.  code | html
SessionListener   Interface defining a listener for significant Session generated events.  code | html
SessionLocker     code | html
Store   A Store is the abstraction of a Catalina component that provides persistent storage and loading of Sessions and their associated user data.  code | html
User  

Abstract representation of a user in a UserDatabase

code | html
UserDatabase  

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.

 
code | html
Valve  

A Valve is a request processing component associated with a particular Container. 

code | html
ValveContext  

A ValveContext is the mechanism by which a Valve can trigger the execution of the next Valve in a Pipeline, without having to know anything about the internal implementation mechanisms. 

code | html
Wrapper   A Wrapper is a Container that represents an individual servlet definition from the deployment descriptor of the web application.  code | html

Classes:

CometEvent.EventSubType   Event details TIMEOUT - the connection timed out (sub type of ERROR); note that this ERROR type is not fatal, and the connection will not be closed unless the servlet uses the close method of the event CLIENT_DISCONNECT - the client connection was closed (sub type of ERROR) IOEXCEPTION - an IO exception occurred, such as invalid content, for example, an invalid chunk block (sub type of ERROR) WEBAPP_RELOAD - the webapplication is being reloaded (sub type of END) SERVER_SHUTDOWN - the server is shutting down (sub type of END) SESSION_END - the servlet ended the session (sub type of END)  code | html
CometEvent.EventType   Enumeration describing the major events that the container can invoke the CometProcessors event() method with BEGIN - will be called at the beginning of the processing of the connection.  code | html
ContainerEvent   General event for notifying listeners of significant changes on a Container.  code | html
Globals   Global constants that are applicable to multiple packages within Catalina.  code | html
InstanceEvent   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.  code | html
LifecycleEvent   General event for notifying listeners of significant changes on a component that implements the Lifecycle interface.  code | html
LifecycleException   General purpose exception that is thrown to indicate a lifecycle related problem.  code | html
ServerFactory  

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. 

code | html
SessionEvent   General event for notifying listeners of significant changes on a Session.  code | html