public class StandardEngine extends ContainerBase implements Engine
| Modifier and Type | Class and Description |
|---|---|
protected static class |
StandardEngine.AccessLogListener |
protected static class |
StandardEngine.NoopAccessLog |
ContainerBase.ContainerBackgroundProcessor, ContainerBase.ContainerBackgroundProcessorMonitor, ContainerBase.PrivilegedAddChildLifecycle.SingleUseaccessLog, backgroundProcessorDelay, backgroundProcessorFuture, children, cluster, listeners, logger, logName, monitorFuture, name, parent, parentClassLoader, pipeline, sm, startChildren, startStopExecutor, supportmserverADD_CHILD_EVENT, ADD_VALVE_EVENT, REMOVE_CHILD_EVENT, REMOVE_VALVE_EVENTAFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_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.
|
File |
getCatalinaBase()
Obtain the location of CATALINA_BASE.
|
File |
getCatalinaHome()
Obtain the location of CATALINA_HOME.
|
String |
getDefaultHost()
Return the default host.
|
protected String |
getDomainInternal()
Method implemented by sub-classes to identify the domain in which MBeans
should be registered.
|
String |
getJvmRoute()
Retrieve the cluster-wide unique identifier for this Engine.
|
protected String |
getObjectNameKeyProperties()
Allow sub-classes to specify the key properties component of the
ObjectName that will be used to register this component. |
ClassLoader |
getParentClassLoader()
Return the parent class loader for this component.
|
Realm |
getRealm()
Obtain the configured Realm and provide a default Realm implementation
when no explicit configuration is set.
|
Service |
getService()
Return the
Service with which we are associated (if any). |
protected void |
initInternal()
Sub-classes wishing to perform additional initialization should override
this method, ensuring that super.initInternal() is the first call in the
overriding method.
|
void |
logAccess(Request request,
Response response,
long time,
boolean useDefault)
Override the default implementation.
|
void |
setDefaultHost(String host)
Set the default host.
|
void |
setJvmRoute(String routeId)
Set the cluster-wide unique identifier for this Engine.
|
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). |
protected void |
startInternal()
Start this component and implement the requirements
of
LifecycleBase.startInternal(). |
addContainerListener, addPropertyChangeListener, addValve, backgroundProcess, destroyInternal, findChild, findChildren, findContainerListeners, fireContainerEvent, getAccessLog, getBackgroundProcessorDelay, getChildren, getCluster, getClusterInternal, getLogger, getLogName, getMBeanKeyProperties, getName, getParent, getPipeline, getRealmInternal, getStartChildren, getStartStopThreads, removeChild, removeContainerListener, removePropertyChangeListener, setBackgroundProcessorDelay, setCluster, setName, setParentClassLoader, setRealm, setStartChildren, setStartStopThreads, stopInternal, threadStart, threadStop, toStringgetDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister, unregisteraddLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, removeLifecycleListener, setState, setState, setThrowOnFailure, start, stopclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitaddContainerListener, addPropertyChangeListener, backgroundProcess, findChild, findChildren, findContainerListeners, fireContainerEvent, getAccessLog, getBackgroundProcessorDelay, getCluster, getConfigPath, getDomain, getLogger, getLogName, getMBeanKeyProperties, getName, getObjectName, getParent, getPipeline, getService, getStartStopThreads, removeChild, removeContainerListener, removePropertyChangeListener, setBackgroundProcessorDelay, setCluster, setName, setParentClassLoader, setRealm, setStartStopThreadsaddLifecycleListener, destroy, findLifecycleListeners, getState, getStateName, init, removeLifecycleListener, start, stoppublic StandardEngine()
public Realm getRealm()
getRealm in interface ContainergetRealm in class ContainerBaseNullRealm by defaultpublic String getDefaultHost()
getDefaultHost in interface Enginepublic void setDefaultHost(String host)
setDefaultHost in interface Enginehost - The new default hostpublic void setJvmRoute(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 String getJvmRoute()
getJvmRoute in interface Enginepublic Service getService()
Service with which we are associated (if any).getService in interface EngineService with which we are associated (if any).public void setService(Service service)
Service with which we are associated (if any).setService in interface Engineservice - The service that owns this Enginepublic void addChild(Container child)
addChild in interface ContaineraddChild in class ContainerBasechild - Child container to be addedpublic void setParent(Container container)
setParent in interface ContainersetParent in class ContainerBasecontainer - Proposed parent Containerprotected void initInternal()
throws LifecycleException
LifecycleMBeanBaseinitInternal in class ContainerBaseLifecycleException - If the initialisation failsprotected void startInternal()
throws LifecycleException
LifecycleBase.startInternal().startInternal in class ContainerBaseLifecycleException - if this component detects a fatal error
that prevents this component from being usedpublic 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 ClassLoader getParentClassLoader()
getParentClassLoader in interface ContainergetParentClassLoader in class ContainerBaseContainer.getParent().Container.getParentClassLoader(). If no
parent has been set, return the system class loader.public File getCatalinaBase()
ContainergetCatalinaBase in interface ContainergetCatalinaBase in class ContainerBasepublic File getCatalinaHome()
ContainergetCatalinaHome in interface ContainergetCatalinaHome in class ContainerBaseprotected String getObjectNameKeyProperties()
LifecycleMBeanBaseObjectName that will be used to register this component.getObjectNameKeyProperties in class LifecycleMBeanBaseObjectNameprotected String getDomainInternal()
LifecycleMBeanBasegetDomainInternal in class ContainerBaseCopyright © 2000-2020 Apache Software Foundation. All Rights Reserved.