FileDocCategorySizeDatePackage
Engine.javaAPI DocGlassfish v2 API4984Fri May 04 22:31:52 BST 2007org.apache.catalina

Engine

public interface Engine implements Container
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 $

Fields Summary
Constructors Summary
Methods Summary
public voidaddDefaultContext(DefaultContext defaultContext)
Set the DefaultContext for new web applications.

param
defaultContext The new DefaultContext

public DefaultContextgetDefaultContext()
Retrieve the DefaultContext for new web applications.

public java.lang.StringgetDefaultHost()
Return the default hostname for this Engine.

public java.lang.StringgetJvmRoute()
Retrieve the JvmRouteId for this engine.

public ServicegetService()
Return the Service with which we are associated (if any).

public voidimportDefaultContext(Context context)
Import the DefaultContext config into a web application context.

param
context web application context to import default context

public voidsetDefaultHost(java.lang.String defaultHost)
Set the default hostname for this Engine.

param
defaultHost The new default host

public voidsetJvmRoute(java.lang.String jvmRouteId)
Set the JvmRouteId for this engine.

param
jvmRouteId the (new) JVM Route ID. Each Engine within a cluster must have a unique JVM Route ID.

public voidsetService(Service service)
Set the Service with which we are associated (if any).

param
service The service that owns this Engine