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.PrivilegedAddChild
Lifecycle.SingleUse
accessLog, backgroundProcessorDelay, children, cluster, listeners, loader, logger, logName, manager, name, parent, parentClassLoader, pipeline, resources, sm, startChildren, startStopExecutor, support
mserver
ADD_CHILD_EVENT, ADD_MAPPER_EVENT, ADD_VALVE_EVENT, REMOVE_CHILD_EVENT, REMOVE_MAPPER_EVENT, REMOVE_VALVE_EVENT
AFTER_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.
|
String |
getBaseDir() |
String |
getDefaultHost()
Return the default host.
|
String |
getInfo()
Return descriptive information about this Container implementation and
the corresponding version number, in the format
<description>/<version> . |
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 |
setBaseDir(String baseDir) |
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() . |
String |
toString()
Return a String representation of this component.
|
addContainerListener, addPropertyChangeListener, addValve, backgroundProcess, destroyInternal, findChild, findChildren, findContainerListeners, fireContainerEvent, getAccessLog, getBackgroundProcessorDelay, getChildren, getCluster, getClusterInternal, getDomainInternal, getLoader, getLoaderInternal, getLogger, getManager, getManagerInternal, getMappingObject, getName, getParent, getPipeline, getRealmInternal, getResources, getResourcesInternal, getStartChildren, getStartStopThreads, invoke, logName, removeChild, removeContainerListener, removePropertyChangeListener, setBackgroundProcessorDelay, setCluster, setLoader, setManager, setName, setParentClassLoader, setRealm, setResources, setStartChildren, setStartStopThreads, stopInternal, threadStart, threadStop
getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister
addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, removeLifecycleListener, setState, setState, setThrowOnFailure, start, stop
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
addContainerListener, addPropertyChangeListener, backgroundProcess, findChild, findChildren, findContainerListeners, fireContainerEvent, getAccessLog, getBackgroundProcessorDelay, getCluster, getLoader, getLogger, getManager, getMappingObject, getName, getObjectName, getParent, getPipeline, getResources, getStartStopThreads, invoke, removeChild, removeContainerListener, removePropertyChangeListener, setBackgroundProcessorDelay, setCluster, setLoader, setManager, setName, setParentClassLoader, setRealm, setResources, setStartStopThreads
addLifecycleListener, destroy, findLifecycleListeners, getState, getStateName, init, removeLifecycleListener, start, stop
public StandardEngine()
public Realm getRealm()
getRealm
in interface Container
getRealm
in class ContainerBase
NullRealm
by defaultpublic String getDefaultHost()
getDefaultHost
in interface Engine
public void setDefaultHost(String host)
setDefaultHost
in interface Engine
host
- The new default hostpublic void setJvmRoute(String routeId)
This property should not be changed once it is set.
setJvmRoute
in interface Engine
routeId
- the (new) JVM Route ID. Each Engine within a cluster
must have a unique JVM Route ID.public String getJvmRoute()
getJvmRoute
in interface Engine
public Service getService()
Service
with which we are associated (if any).getService
in interface Engine
Service
with which we are associated (if any).public void setService(Service service)
Service
with which we are associated (if any).setService
in interface Engine
service
- The service that owns this Enginepublic String getBaseDir()
public void setBaseDir(String baseDir)
public void addChild(Container child)
addChild
in interface Container
addChild
in class ContainerBase
child
- Child container to be addedpublic String getInfo()
<description>/<version>
.getInfo
in interface Container
getInfo
in class ContainerBase
<description>/<version>
.public void setParent(Container container)
setParent
in interface Container
setParent
in class ContainerBase
container
- Proposed parent Containerprotected void initInternal() throws LifecycleException
LifecycleMBeanBase
initInternal
in class ContainerBase
LifecycleException
- If the initialisation failsprotected void startInternal() throws LifecycleException
LifecycleBase.startInternal()
.startInternal
in class ContainerBase
LifecycleException
- if this component detects a fatal error
that prevents this component from being usedpublic String toString()
public void logAccess(Request request, Response response, long time, boolean useDefault)
logAccess
in interface Container
logAccess
in class ContainerBase
request
- 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 Container
getParentClassLoader
in class ContainerBase
Container.getParent()
.Container.getParentClassLoader()
. If no
parent has been set, return the system class loader.protected String getObjectNameKeyProperties()
LifecycleMBeanBase
ObjectName
that will be used to register this component.getObjectNameKeyProperties
in class LifecycleMBeanBase
ObjectName
Copyright © 2000-2021 Apache Software Foundation. All Rights Reserved.