Package org.apache.catalina
Interface Engine
- All Known Implementing Classes:
- 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.
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
- 
Nested Class SummaryNested classes/interfaces inherited from interface org.apache.catalina.LifecycleLifecycle.SingleUse
- 
Field SummaryFields inherited from interface org.apache.catalina.ContainerADD_CHILD_EVENT, ADD_VALVE_EVENT, REMOVE_CHILD_EVENT, REMOVE_VALVE_EVENTFields inherited from interface org.apache.catalina.LifecycleAFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT
- 
Method SummaryModifier and TypeMethodDescriptionvoidsetDefaultHost(String defaultHost) Set the default hostname for this Engine.voidsetJvmRoute(String jvmRouteId) Set the JvmRouteId for this engine.voidsetService(Service service) Set theServicewith which we are associated (if any).Methods inherited from interface org.apache.catalina.ContaineraddChild, addContainerListener, addPropertyChangeListener, backgroundProcess, findChild, findChildren, findContainerListeners, fireContainerEvent, getAccessLog, getBackgroundProcessorDelay, getCatalinaBase, getCatalinaHome, getCluster, getDomain, getLogger, getLogName, getMBeanKeyProperties, getName, getObjectName, getParent, getParentClassLoader, getPipeline, getRealm, getStartStopThreads, logAccess, removeChild, removeContainerListener, removePropertyChangeListener, setBackgroundProcessorDelay, setCluster, setName, setParent, setParentClassLoader, setRealm, setStartStopThreadsMethods inherited from interface org.apache.catalina.LifecycleaddLifecycleListener, destroy, findLifecycleListeners, getState, getStateName, init, removeLifecycleListener, start, stop
- 
Method Details- 
getDefaultHostString getDefaultHost()- Returns:
- the default host name for this Engine.
 
- 
setDefaultHostSet the default hostname for this Engine.- Parameters:
- defaultHost- The new default host
 
- 
getJvmRouteString getJvmRoute()- Returns:
- the JvmRouteId for this engine.
 
- 
setJvmRouteSet the JvmRouteId for this engine.- Parameters:
- jvmRouteId- the (new) JVM Route ID. Each Engine within a cluster must have a unique JVM Route ID.
 
- 
getServiceService getService()- Returns:
- the Servicewith which we are associated (if any).
 
- 
setServiceSet theServicewith which we are associated (if any).- Parameters:
- service- The service that owns this Engine
 
 
-