Apache Tomcat 6.0.41

org.apache.catalina
Interface Engine

All Superinterfaces:
Container
All Known Implementing Classes:
StandardEngine

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.

Author:
Craig R. McClanahan

Field Summary
 
Fields inherited from interface org.apache.catalina.Container
ADD_CHILD_EVENT, ADD_MAPPER_EVENT, ADD_VALVE_EVENT, REMOVE_CHILD_EVENT, REMOVE_MAPPER_EVENT, REMOVE_VALVE_EVENT
 
Method Summary
 java.lang.String getDefaultHost()
          Return the default hostname for this Engine.
 java.lang.String getJvmRoute()
          Retrieve the JvmRouteId for this engine.
 Service getService()
          Return the Service with which we are associated (if any).
 void setDefaultHost(java.lang.String defaultHost)
          Set the default hostname for this Engine.
 void setJvmRoute(java.lang.String jvmRouteId)
          Set the JvmRouteId for this engine.
 void setService(Service service)
          Set the Service with which we are associated (if any).
 
Methods inherited from interface org.apache.catalina.Container
addChild, addContainerListener, addPropertyChangeListener, backgroundProcess, findChild, findChildren, findContainerListeners, getAccessLog, getBackgroundProcessorDelay, getCluster, getInfo, getLoader, getLogger, getManager, getMappingObject, getName, getObjectName, getParent, getParentClassLoader, getPipeline, getRealm, getResources, invoke, logAccess, removeChild, removeContainerListener, removePropertyChangeListener, setBackgroundProcessorDelay, setCluster, setLoader, setManager, setName, setParent, setParentClassLoader, setRealm, setResources
 

Method Detail

getDefaultHost

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


setDefaultHost

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

Parameters:
defaultHost - The new default host

getJvmRoute

java.lang.String getJvmRoute()
Retrieve the JvmRouteId for this engine.


setJvmRoute

void setJvmRoute(java.lang.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.

getService

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


setService

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

Parameters:
service - The service that owns this Engine

Apache Tomcat 6.0.41

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