Top Description Fields Methods
org.apache.catalina

public Interface Engine

extends Container
Known Direct Implementers
org.apache.catalina.core.StandardEngine

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

Inherited from org.apache.catalina.Container:
ADD_CHILD_EVENTADD_VALVE_EVENTREMOVE_CHILD_EVENTREMOVE_VALVE_EVENT

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the default host name for this Engine.
getDefaultHost
()

public String

Returns:

the JvmRouteId for this engine.
getJvmRoute
()

public Service

Returns:

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

public void
setDefaultHost(String
The new default host
defaultHost
)

Set the default hostname for this Engine.

public void
setJvmRoute(String
the (new) JVM Route ID. Each Engine within a cluster must have a unique JVM Route ID.
jvmRouteId
)

Set the JvmRouteId for this engine.

public void
setService(Service
The service that owns this Engine
service
)

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

Inherited from org.apache.catalina.Container:
addChildaddContainerListeneraddPropertyChangeListenerbackgroundProcessfindChildfindChildrenfindContainerListenersfireContainerEventgetAccessLoggetBackgroundProcessorDelaygetCatalinaBasegetCatalinaHomegetClustergetConfigPathgetDomaingetLoggergetLogNamegetMBeanKeyPropertiesgetNamegetObjectNamegetParentgetParentClassLoadergetPipelinegetRealmgetServicegetStartStopThreadslogAccessremoveChildremoveContainerListenerremovePropertyChangeListenersetBackgroundProcessorDelaysetClustersetNamesetParentsetParentClassLoadersetRealmsetStartStopThreads

Method Detail

getDefaultHostback to summary
public String getDefaultHost()
Returns:String

the default host name for this Engine.

getJvmRouteback to summary
public String getJvmRoute()
Returns:String

the JvmRouteId for this engine.

getServiceback to summary
public Service getService()
Returns:Service

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

setDefaultHostback to summary
public void setDefaultHost(String defaultHost)

Set the default hostname for this Engine.

Parameters
defaultHost:String

The new default host

setJvmRouteback to summary
public void setJvmRoute(String jvmRouteId)

Set the JvmRouteId for this engine.

Parameters
jvmRouteId:String

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

setServiceback to summary
public void setService(Service service)

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

Parameters
service:Service

The service that owns this Engine