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, Pipeline

public final 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.2 $ $Date: 2000/08/24 23:56:59 $
Author:
Craig R. McClanahan

Fields inherited from class org.apache.catalina.core.ContainerBase
basic, children, debug, first, lifecycle, listeners, loader, logger, manager, mapper, mapperClass, mappers, name, parent, 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.
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>.
 void setDefaultHost(java.lang.String host)
          Set the default host.
 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, findValves, fireContainerEvent, getBasic, getDebug, getLast, getLoader, getLogger, getManager, getName, getParent, getParentClassLoader, getRealm, getResources, invoke, log, log, logName, map, removeChild, removeContainerListener, removeLifecycleListener, removeMapper, removePropertyChangeListener, removeValve, setBasic, 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, getLoader, getLogger, getManager, getName, getParent, getParentClassLoader, getRealm, getResources, invoke, map, removeChild, removeContainerListener, removeMapper, removePropertyChangeListener, 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.

setDefaultHost

public void setDefaultHost(java.lang.String host)
Set the default host.
Parameters:
host - The new default host

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 - Java class name of the default Mapper


Copyright © 2000 Apache Software Foundation. All Rights Reserved.