org.apache.catalina
Interface Engine
- Container
- 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
.
Version:
- Craig R. McClanahan
addChild , addContainerListener , addPropertyChangeListener , backgroundProcess , findChild , findChildren , findContainerListeners , getBackgroundProcessorDelay , getCluster , getInfo , getLoader , getLogger , getManager , getMappingObject , getName , getParent , getParentClassLoader , getPipeline , getRealm , getResources , invoke , removeChild , removeContainerListener , removePropertyChangeListener , setBackgroundProcessorDelay , setCluster , setLoader , setLogger , setManager , setName , setParent , setParentClassLoader , setRealm , setResources |
addDefaultContext
public void addDefaultContext(DefaultContext defaultContext)
Set the DefaultContext
for new web applications.
defaultContext
- The new DefaultContext
getDefaultContext
public DefaultContext getDefaultContext()
Retrieve the DefaultContext for new web applications.
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).
importDefaultContext
public void importDefaultContext(Context context)
Import the DefaultContext config into a web application context.
context
- web application context to import default context
setDefaultHost
public void setDefaultHost(String defaultHost)
Set the default hostname for this Engine.
defaultHost
- The new default host
setJvmRoute
public void setJvmRoute(String jvmRouteId)
Set the JvmRouteId for this engine.
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).
service
- The service that owns this Engine
Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.