|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.catalina.core.ContainerBase
org.apache.catalina.core.StandardEngine
public class StandardEngine
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.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class org.apache.catalina.core.ContainerBase |
|---|
ContainerBase.ContainerBackgroundProcessor, ContainerBase.PrivilegedAddChild |
| Field Summary |
|---|
| Fields inherited from class org.apache.catalina.core.ContainerBase |
|---|
backgroundProcessorDelay, children, cluster, controller, domain, lifecycle, listeners, loader, logger, logName, manager, mserver, name, oname, parent, parentClassLoader, pipeline, realm, resources, sm, startChildren, started, suffix, support, type |
| 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 |
|---|
AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, DESTROY_EVENT, INIT_EVENT, PERIODIC_EVENT, 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. |
javax.management.ObjectName |
createObjectName(java.lang.String domain,
javax.management.ObjectName parent)
|
void |
destroy()
|
java.lang.String |
getBaseDir()
|
java.lang.String |
getDefaultHost()
Return the default host. |
java.lang.String |
getDomain()
|
java.lang.String |
getInfo()
Return descriptive information about this Container implementation and the corresponding version number, in the format <description>/<version>. |
java.lang.String |
getJvmRoute()
Retrieve the cluster-wide unique identifier for this Engine. |
java.lang.String |
getMbeansFile()
|
javax.management.ObjectName |
getParentName()
|
Realm |
getRealm()
Provide a default in case no explicit configuration is set |
Service |
getService()
Return the Service with which we are associated (if any). |
void |
init()
Init method, part of the MBean lifecycle. |
javax.management.ObjectName |
preRegister(javax.management.MBeanServer server,
javax.management.ObjectName name)
|
void |
setBaseDir(java.lang.String baseDir)
|
void |
setDefaultHost(java.lang.String host)
Set the default host. |
void |
setDomain(java.lang.String domain)
|
void |
setJvmRoute(java.lang.String routeId)
Set the cluster-wide unique identifier for this Engine. |
void |
setMbeansFile(java.lang.String mbeansFile)
|
void |
setName(java.lang.String name)
Set a name string (suitable for use by humans) that describes this Container. |
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 |
setService(Service service)
Set the Service with which we are associated (if any). |
void |
start()
Start this Engine component. |
void |
stop()
Gracefully shut down active use of the public methods of this Component. |
java.lang.String |
toString()
Return a String representation of this component. |
| 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, addPropertyChangeListener, backgroundProcess, findChild, findChildren, findContainerListeners, getBackgroundProcessorDelay, getCluster, getLoader, getLogger, getManager, getMappingObject, getName, getObjectName, getParent, getParentClassLoader, getPipeline, getResources, invoke, removeChild, removeContainerListener, removePropertyChangeListener, setBackgroundProcessorDelay, setCluster, setLoader, setManager, setParentClassLoader, setRealm, setResources |
| Constructor Detail |
|---|
public StandardEngine()
| Method Detail |
|---|
public Realm getRealm()
getRealm in interface ContainergetRealm in class ContainerBasepublic java.lang.String getDefaultHost()
getDefaultHost in interface Enginepublic void setDefaultHost(java.lang.String host)
setDefaultHost in interface Enginehost - The new default hostpublic void setName(java.lang.String name)
ContainerBase
setName in interface ContainersetName in class ContainerBasename - New name of this containerpublic void setJvmRoute(java.lang.String routeId)
This property should not be changed once it is set.
setJvmRoute in interface EnginerouteId - the (new) JVM Route ID. Each Engine within a cluster
must have a unique JVM Route ID.public java.lang.String getJvmRoute()
getJvmRoute in interface Enginepublic Service getService()
Service with which we are associated (if any).
getService in interface Enginepublic void setService(Service service)
Service with which we are associated (if any).
setService in interface Engineservice - The service that owns this Enginepublic java.lang.String getMbeansFile()
public void setMbeansFile(java.lang.String mbeansFile)
public java.lang.String getBaseDir()
public void setBaseDir(java.lang.String baseDir)
public void addChild(Container child)
addChild in interface ContaineraddChild in class ContainerBasechild - Child container to be addedpublic java.lang.String getInfo()
<description>/<version>.
getInfo in interface ContainergetInfo in class ContainerBasepublic void setParent(Container container)
setParent in interface ContainersetParent in class ContainerBasecontainer - Proposed parent Containerpublic void init()
ContainerBase
init in class ContainerBase
public void destroy()
throws LifecycleException
destroy in class ContainerBaseLifecycleException
public void start()
throws LifecycleException
start in interface Lifecyclestart in class ContainerBaseLifecycleException - if a startup error occurs
public void stop()
throws LifecycleException
ContainerBase
stop in interface Lifecyclestop in class ContainerBaseLifecycleException - if this component detects a fatal error
that needs to be reportedpublic java.lang.String toString()
toString in class java.lang.Object
public javax.management.ObjectName preRegister(javax.management.MBeanServer server,
javax.management.ObjectName name)
throws java.lang.Exception
preRegister in interface javax.management.MBeanRegistrationpreRegister in class ContainerBasejava.lang.Exception
public javax.management.ObjectName getParentName()
throws javax.management.MalformedObjectNameException
getParentName in class ContainerBasejavax.management.MalformedObjectNameException
public javax.management.ObjectName createObjectName(java.lang.String domain,
javax.management.ObjectName parent)
throws java.lang.Exception
createObjectName in class ContainerBasejava.lang.Exceptionpublic java.lang.String getDomain()
getDomain in class ContainerBasepublic void setDomain(java.lang.String domain)
setDomain in class ContainerBase
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||