org.apache.catalina

Interface Engine

public interface Engine extends Container

An Engine is a Container that represents the entire Catalina servlet engine. It is useful in the following types of scenarios: 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.

Version: $Revision: 467222 $ $Date: 2006-10-24 05:17:11 +0200 (Tue, 24 Oct 2006) $

Author: Craig R. McClanahan

Method Summary
StringgetDefaultHost()
Return the default hostname for this Engine.
StringgetJvmRoute()
Retrieve the JvmRouteId for this engine.
ServicegetService()
Return the Service with which we are associated (if any).
voidsetDefaultHost(String defaultHost)
Set the default hostname for this Engine.
voidsetJvmRoute(String jvmRouteId)
Set the JvmRouteId for this engine.
voidsetService(Service service)
Set the Service with which we are associated (if any).

Method Detail

getDefaultHost

public String getDefaultHost()
Return the default hostname for this Engine.

getJvmRoute

public String getJvmRoute()
Retrieve the JvmRouteId for this engine.

getService

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

setDefaultHost

public void setDefaultHost(String defaultHost)
Set the default hostname for this Engine.

Parameters: defaultHost The new default host

setJvmRoute

public void setJvmRoute(String jvmRouteId)
Set the JvmRouteId for this engine.

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

setService

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

Parameters: service The service that owns this Engine

Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.