org.apache.catalina.core
Class StandardEngine

java.lang.Object
  |
  +--org.apache.catalina.core.ContainerBase
        |
        +--org.apache.catalina.core.StandardEngine

All Implemented Interfaces:

Container, Engine, Lifecycle

Direct Known Subclasses:

WarpEngine

public class StandardEngine

extends ContainerBase

implements Engine

Standard implementation of the Engine interface. Each child container must be a Host implementation to process the specific fully qualified host name of that virtual host.

Version:

$Revision: 1.8 $ $Date: 2001/05/04 05:07:08 $

Author:

Craig R. McClanahan

Fields inherited from class org.apache.catalina.core.ContainerBase

children, cluster, debug, lifecycle, listeners, loader, logger, manager, mapper, mapperClass, mappers, name, parent, parentClassLoader, pipeline, realm, resources, sm, started, support

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

Fields inherited from interface org.apache.catalina.Lifecycle

START_EVENT, STOP_EVENT

Constructor Summary

StandardEngine()
Create a new StandardEngine component with the default basic Valve.

Method Summary

void	addChild(Container child) Add a child Container, only if the proposed child is an implementation of Host.
void	addDefaultContext(DefaultContext defaultContext) Set the DefaultContext for new web applications.
protected void	addDefaultMapper(java.lang.String mapperClass) Add a default Mapper implementation if none have been configured explicitly.
java.lang.String	getDefaultHost() Return the default host.
java.lang.String	getInfo() Return descriptive information about this Container implementation and the corresponding version number, in the format <description>/<version>.
java.lang.String	getMapperClass() Return the default Mapper class name.
void	importDefaultContext(Context context) Import the DefaultContext config into a web application context.
void	setDefaultHost(java.lang.String host) Set the default host.
void	setMapperClass(java.lang.String mapperClass) Set the default Mapper class name.
void	setParent(Container container) Disallow any attempt to set a parent for this Container, since an Engine is supposed to be at the top of the Container hierarchy.
void	start() Start this Engine component.
java.lang.String	toString() Return a String representation of this component.

Methods inherited from class org.apache.catalina.core.ContainerBase

addContainerListener, addLifecycleListener, addMapper, addPropertyChangeListener, addValve, findChild, findChildren, findMapper, findMappers, fireContainerEvent, getCluster, getDebug, getLoader, getLogger, getManager, getName, getParent, getParentClassLoader, getPipeline, getRealm, getResources, getValves, invoke, log, log, logName, map, removeChild, removeContainerListener, removeLifecycleListener, removeMapper, removePropertyChangeListener, removeValve, setCluster, setDebug, setLoader, setLogger, setManager, setName, setParentClassLoader, setRealm, setResources, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.catalina.Container

addContainerListener, addMapper, addPropertyChangeListener, findChild, findChildren, findMapper, findMappers, getCluster, getLoader, getLogger, getManager, getName, getParent, getParentClassLoader, getRealm, getResources, invoke, map, removeChild, removeContainerListener, removeMapper, removePropertyChangeListener, setCluster, setLoader, setLogger, setManager, setName, setParentClassLoader, setRealm, setResources

Constructor Detail

StandardEngine

public StandardEngine()

Create a new StandardEngine component with the default basic Valve.

Method Detail

getDefaultHost

public java.lang.String getDefaultHost()

Return the default host.

Specified by:

getDefaultHost in interface Engine

setDefaultHost

public void setDefaultHost(java.lang.String host)

Set the default host.

Specified by:

setDefaultHost in interface Engine

Parameters:

host - The new default host

addDefaultContext

public void addDefaultContext(DefaultContext defaultContext)

Set the DefaultContext for new web applications.

Specified by:

addDefaultContext in interface Engine

Parameters:

defaultContext - The new DefaultContext

getMapperClass

public java.lang.String getMapperClass()

Return the default Mapper class name.

setMapperClass

public void setMapperClass(java.lang.String mapperClass)

Set the default Mapper class name.

Parameters:

mapperClass - The new default Mapper class name

importDefaultContext

public void importDefaultContext(Context context)

Import the DefaultContext config into a web application context.

Specified by:

importDefaultContext in interface Engine

Parameters:

context - web application context to import default context

addChild

public void addChild(Container child)

Add a child Container, only if the proposed child is an implementation of Host.

Specified by:

addChild in interface Container

Overrides:

addChild in class ContainerBase

Parameters:

child - Child container to be added

getInfo

public java.lang.String getInfo()

Return descriptive information about this Container implementation and the corresponding version number, in the format <description>/<version>.

Specified by:

getInfo in interface Container

Overrides:

getInfo in class ContainerBase

setParent

public void setParent(Container container)

Disallow any attempt to set a parent for this Container, since an Engine is supposed to be at the top of the Container hierarchy.

Specified by:

setParent in interface Container

Overrides:

setParent in class ContainerBase

Parameters:

container - Proposed parent Container

start

public void start()
           throws LifecycleException

Start this Engine component.

Overrides:

start in class ContainerBase

Throws:

LifecycleException - if a startup error occurs

toString

public java.lang.String toString()

Return a String representation of this component.

Overrides:

toString in class java.lang.Object

addDefaultMapper

protected void addDefaultMapper(java.lang.String mapperClass)

Add a default Mapper implementation if none have been configured explicitly.

Overrides:

addDefaultMapper in class ContainerBase

Parameters:

mapperClass - The default mapper class name to add