org.apache.catalina.core
public class StandardEngine extends ContainerBase implements Engine
| Modifier and Type | Class and Description |
|---|---|
protected static class |
StandardEngine.AccessLogListener |
ContainerBase.ContainerBackgroundProcessor, ContainerBase.NoopAccessLog, ContainerBase.PrivilegedAddChildaccessLog, backgroundProcessorDelay, children, cluster, controller, domain, lifecycle, listeners, loader, logger, logName, manager, mserver, name, oname, parent, parentClassLoader, pipeline, realm, resources, sm, startChildren, started, suffix, support, typeADD_CHILD_EVENT, ADD_MAPPER_EVENT, ADD_VALVE_EVENT, REMOVE_CHILD_EVENT, REMOVE_MAPPER_EVENT, REMOVE_VALVE_EVENTAFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, DESTROY_EVENT, INIT_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT| Constructor and Description |
|---|
StandardEngine()
Create a new StandardEngine component with the default basic Valve.
|
| Modifier and Type | Method and Description |
|---|---|
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.
|
void |
logAccess(Request request,
Response response,
long time,
boolean useDefault)
Override the default implementation.
|
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.
|
addContainerListener, addLifecycleListener, addPropertyChangeListener, addValve, backgroundProcess, findChild, findChildren, findContainerListeners, findLifecycleListeners, fireContainerEvent, getAccessLog, getBackgroundProcessorDelay, getBasic, getChildren, getCluster, getContainerSuffix, getFirst, getJmxName, getJSR77Suffix, getLoader, getLogger, getManager, getMappingObject, getName, getObjectName, getParent, getParentClassLoader, getPipeline, getResources, getStartChildren, getType, getValveObjectNames, getValves, invoke, logName, postDeregister, postRegister, preDeregister, removeChild, removeContainerListener, removeLifecycleListener, removePropertyChangeListener, removeValve, setBackgroundProcessorDelay, setBasic, setCluster, setLoader, setManager, setParentClassLoader, setRealm, setResources, setStartChildren, threadStart, threadStopclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitaddContainerListener, addPropertyChangeListener, backgroundProcess, findChild, findChildren, findContainerListeners, getAccessLog, getBackgroundProcessorDelay, getCluster, getLoader, getLogger, getManager, getMappingObject, getName, getObjectName, getParent, getParentClassLoader, getPipeline, getResources, invoke, removeChild, removeContainerListener, removePropertyChangeListener, setBackgroundProcessorDelay, setCluster, setLoader, setManager, setParentClassLoader, setRealm, setResourcespublic StandardEngine()
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)
ContainerBasesetName 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()
ContainerBaseinit in class ContainerBasepublic void destroy()
throws LifecycleException
destroy in class ContainerBaseLifecycleExceptionpublic void start()
throws LifecycleException
start in interface Lifecyclestart in class ContainerBaseLifecycleException - if a startup error occurspublic void stop()
throws LifecycleException
ContainerBasestop 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.Objectpublic void logAccess(Request request, Response response, long time, boolean useDefault)
logAccess in interface ContainerlogAccess in class ContainerBaserequest - Request (associated with the response) to logresponse - Response (associated with the request) to logtime - Time taken to process the request/response in
milliseconds (use 0 if not known)useDefault - Flag that indicates that the request/response should
be logged in the engine's default access logpublic 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.Exceptionpublic javax.management.ObjectName getParentName()
throws javax.management.MalformedObjectNameException
getParentName in class ContainerBasejavax.management.MalformedObjectNameExceptionpublic 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 ContainerBaseCopyright © 2000-2013 Apache Software Foundation. All Rights Reserved.