Engine (Catalina Internal API Documentation)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An Engine is a Container that represents the entire Catalina servlet engine. It is useful in the following types of scenarios:
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
.
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 | |
void |
addDefaultContext(DefaultContext defaultContext)
Set the DefaultContext for new web applications. |
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 |
importDefaultContext(Context context)
Import the DefaultContext config into a web application context. |
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, addMapper, addPropertyChangeListener, findChild, findChildren, findMapper, findMappers, getCluster, getInfo, getLoader, getLogger, getManager, getName, getParent, getParentClassLoader, getRealm, getResources, invoke, map, removeChild, removeContainerListener, removeMapper, removePropertyChangeListener, setCluster, setLoader, setLogger, setManager, setName, setParent, setParentClassLoader, setRealm, setResources |
Method Detail |
public java.lang.String getDefaultHost()
public void setDefaultHost(java.lang.String defaultHost)
defaultHost
- The new default hostpublic void setJvmRoute(java.lang.String jvmRouteId)
jvmRouteId
- the (new) JVM Route ID. Each Engine within a cluster
must have the same JVM Route ID.public java.lang.String getJvmRoute()
public Service getService()
Service
with which we are associated (if any).
public void setService(Service service)
Service
with which we are associated (if any).
service
- The service that owns this Enginepublic void addDefaultContext(DefaultContext defaultContext)
defaultContext
- The new DefaultContextpublic void importDefaultContext(Context context)
context
- web application context to import default context
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |