org.apache.catalina: public interface: Engine

org.apache.catalina
public interface: Engine [javadoc | source]

All Implemented Interfaces:
Container

All Known Implementing Classes:
WebEngine, StandardEngine

An Engine is a Container that represents the entire Catalina servlet engine. It is useful in the following types of scenarios:

You wish to use Interceptors that see every single request processed by the entire engine.
You wish to run Catalina in with a standalone HTTP connector, but still want support for multiple virtual hosts.

In general, you would not use an Engine when deploying Catalina connected to a web server (such as Apache), because the Connector will have utilized the web server's facilities to determine which Context (or perhaps even which Wrapper) should be utilized to process this request.

The child containers attached to an Engine are generally implementations of Host (representing a virtual host) or Context (representing individual an individual servlet context), depending upon the Engine implementation.

If used, an Engine is always the top level Container in a Catalina hierarchy. Therefore, the implementation's setParent() method should throw IllegalArgumentException.

author: Craig - R. McClanahan

version: $ - Revision: 1.3 $ $Date: 2007/05/05 05:31:51 $

Method from org.apache.catalina.Engine Summary:
addDefaultContext, getDefaultContext, getDefaultHost, getJvmRoute, getService, importDefaultContext, setDefaultHost, setJvmRoute, setService

Method from org.apache.catalina.Engine Detail:
public void addDefaultContext(DefaultContext defaultContext) Set the DefaultContext for new web applications.
public DefaultContext getDefaultContext() Retrieve the DefaultContext for new web applications.
public String getDefaultHost() Return the default hostname for this Engine.
public String getJvmRoute() Retrieve the JvmRouteId for this engine.
public Service getService() Return the `Service` with which we are associated (if any).
public void importDefaultContext(Context context) Import the DefaultContext config into a web application context.
public void setDefaultHost(String defaultHost) Set the default hostname for this Engine.
public void setJvmRoute(String jvmRouteId) Set the JvmRouteId for this engine.
public void setService(Service service) Set the `Service` with which we are associated (if any).