org.apache.catalina.core

Class StandardEngine

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.
You can set the jvmRoute direct or with the System.property jvmRoute.

Version: $Revision: 467222 $ $Date: 2006-10-24 05:17:11 +0200 (Tue, 24 Oct 2006) $

Author: Craig R. McClanahan

Constructor Summary
StandardEngine()
Create a new StandardEngine component with the default basic Valve.
Method Summary
voidaddChild(Container child)
Add a child Container, only if the proposed child is an implementation of Host.
ObjectNamecreateObjectName(String domain, ObjectName parent)
voiddestroy()
StringgetBaseDir()
StringgetDefaultHost()
Return the default host.
StringgetDomain()
StringgetInfo()
Return descriptive information about this Container implementation and the corresponding version number, in the format <description>/<version>.
StringgetJvmRoute()
Retrieve the cluster-wide unique identifier for this Engine.
StringgetMbeansFile()
ObjectNamegetParentName()
RealmgetRealm()
Provide a default in case no explicit configuration is set
ServicegetService()
Return the Service with which we are associated (if any).
voidinit()
ObjectNamepreRegister(MBeanServer server, ObjectName name)
voidsetBaseDir(String baseDir)
voidsetDefaultHost(String host)
Set the default host.
voidsetDomain(String domain)
voidsetJvmRoute(String routeId)
Set the cluster-wide unique identifier for this Engine.
voidsetMbeansFile(String mbeansFile)
voidsetName(String name)
voidsetParent(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.
voidsetService(Service service)
Set the Service with which we are associated (if any).
voidstart()
Start this Engine component.
voidstop()
StringtoString()
Return a String representation of this component.

Constructor Detail

StandardEngine

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

Method Detail

addChild

public void addChild(Container child)
Add a child Container, only if the proposed child is an implementation of Host.

Parameters: child Child container to be added

createObjectName

public ObjectName createObjectName(String domain, ObjectName parent)

destroy

public void destroy()

getBaseDir

public String getBaseDir()

getDefaultHost

public String getDefaultHost()
Return the default host.

getDomain

public String getDomain()

getInfo

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

getJvmRoute

public String getJvmRoute()
Retrieve the cluster-wide unique identifier for this Engine. This value is only useful in a load-balancing scenario.

getMbeansFile

public String getMbeansFile()

getParentName

public ObjectName getParentName()

getRealm

public Realm getRealm()
Provide a default in case no explicit configuration is set

Returns: configured realm, or a JAAS realm by default

getService

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

init

public void init()

preRegister

public ObjectName preRegister(MBeanServer server, ObjectName name)

setBaseDir

public void setBaseDir(String baseDir)

setDefaultHost

public void setDefaultHost(String host)
Set the default host.

Parameters: host The new default host

setDomain

public void setDomain(String domain)

setJvmRoute

public void setJvmRoute(String routeId)
Set the cluster-wide unique identifier for this Engine. This value is only useful in a load-balancing scenario.

This property should not be changed once it is set.

setMbeansFile

public void setMbeansFile(String mbeansFile)

setName

public void setName(String name)

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.

Parameters: container Proposed parent Container

setService

public void setService(Service service)
Set the Service with which we are associated (if any).

Parameters: service The service that owns this Engine

start

public void start()
Start this Engine component.

Throws: LifecycleException if a startup error occurs

stop

public void stop()

toString

public String toString()
Return a String representation of this component.
Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.