| Modifier and Type | Class and Description |
|---|---|
| protected static class | |
| protected static class |
| Modifier and Type | Field and Description |
|---|---|
| private final AtomicReference | defaultAccessLog
Default access log to use for request/response pairs where we can't ID the intended host and context. |
| private String | defaultHost
Host name to use when no server host, or an unknown host, is specified in the request. |
| private String | jvmRouteId
The JVM Route ID for this Tomcat instance. |
| private static final Log | |
| private Service | service
The |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public void | addChild(Container
Child container to be added child)Overrides org. Implements org. Add a child Container, only if the proposed child is an implementation of Host. |
| public File | getCatalinaBase()
Overrides org. Implements org. Obtain the location of CATALINA_BASE. |
| public File | getCatalinaHome()
Overrides org. Implements org. Obtain the location of CATALINA_HOME. |
| public String | |
| protected String | getDomainInternal()
Overrides org. Method implemented by sub-classes to identify the domain in which MBeans should be registered. |
| public String | getJvmRoute()
Implements org. Retrieve the cluster-wide unique identifier for this Engine. |
| protected String | getObjectNameKeyProperties()
Implements abstract org. Allow sub-classes to specify the key properties component of the
|
| public ClassLoader | getParentClassLoader()
Overrides org. Implements org. Return the parent class loader for this component. |
| public Realm | Returns: configured realm, or aNullRealm by defaultOverrides org. Implements org. Obtain the configured Realm and provide a default Realm implementation when no explicit configuration is set. |
| public Service | getService()
Implements org. Return the |
| protected void | initInternal()
Overrides org. Sub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method. |
| public void | logAccess(Request
Request (associated with the response) to log request, Response Response (associated with the request) to log response, long Time taken to process the request/response in
milliseconds (use 0 if not known) time, boolean Flag that indicates that the request/response should
be logged in the engine's default access log useDefault)Overrides org. Implements org. Override the default implementation. |
| public void | setDefaultHost(String
The new default host host)Implements org. Set the default host. |
| public void | setJvmRoute(String
the (new) JVM Route ID. Each Engine within a cluster
must have a unique JVM Route ID. routeId)Implements org. Set the cluster-wide unique identifier for this Engine. |
| public void | setParent(Container
Proposed parent Container container)Overrides org. Implements org. Disallow any attempt to set a parent for this Container, since an Engine is supposed to be at the top of the Container hierarchy. |
| public void | setService(Service
The service that owns this Engine service)Implements org. Set the |
| protected void | startInternal()
Overrides org. Start this component and implement the requirements of
|
| defaultAccessLog | back to summary |
|---|---|
| private final AtomicReference<AccessLog> defaultAccessLog Default access log to use for request/response pairs where we can't ID the intended host and context. | |
| defaultHost | back to summary |
|---|---|
| private String defaultHost Host name to use when no server host, or an unknown host, is specified in the request. | |
| jvmRouteId | back to summary |
|---|---|
| private String jvmRouteId The JVM Route ID for this Tomcat instance. All Route ID's must be unique across the cluster. | |
| log | back to summary |
|---|---|
| private static final Log log | |
| service | back to summary |
|---|---|
| private Service service The | |
| StandardEngine | back to summary |
|---|---|
| public StandardEngine() Create a new StandardEngine component with the default basic Valve. | |
| addChild | back to summary |
|---|---|
| public void addChild(Container child) Overrides org. Implements org. Add a child Container, only if the proposed child is an implementation of Host. | |
| getCatalinaBase | back to summary |
|---|---|
| public File getCatalinaBase() Overrides org. Implements org. Doc from org. Obtain the location of CATALINA_BASE. | |
| getCatalinaHome | back to summary |
|---|---|
| public File getCatalinaHome() Overrides org. Implements org. Doc from org. Obtain the location of CATALINA_HOME. | |
| getDefaultHost | back to summary |
|---|---|
| public String getDefaultHost() Implements org. Return the default host.
| |
| getDomainInternal | back to summary |
|---|---|
| protected String getDomainInternal() Overrides org. Doc from org. Method implemented by sub-classes to identify the domain in which MBeans should be registered. | |
| getJvmRoute | back to summary |
|---|---|
| public String getJvmRoute() Implements org. Retrieve the cluster-wide unique identifier for this Engine. This value is only useful in a load-balancing scenario.
| |
| getObjectNameKeyProperties | back to summary |
|---|---|
| protected String getObjectNameKeyProperties() Implements abstract org. Doc from org. Allow sub-classes to specify the key properties component of the
| |
| getParentClassLoader | back to summary |
|---|---|
| public ClassLoader getParentClassLoader() Overrides org. Implements org. Return the parent class loader for this component.
| |
| getRealm | back to summary |
|---|---|
| public Realm getRealm() Overrides org. Implements org. Obtain the configured Realm and provide a default Realm implementation when no explicit configuration is set. | |
| getService | back to summary |
|---|---|
| public Service getService() Implements org. Return the
| |
| initInternal | back to summary |
|---|---|
| protected void initInternal() throws LifecycleException Overrides org. Doc from org. Sub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method.
| |
| logAccess | back to summary |
|---|---|
| public void logAccess(Request request, Response response, long time, boolean useDefault) Overrides org. Implements org. Override the default implementation. If no access log is defined for the Engine, look for one in the Engine's default host and then the default host's ROOT context. If still none is found, return the default NoOp access log.
| |
| setDefaultHost | back to summary |
|---|---|
| public void setDefaultHost(String host) Implements org. Set the default host. | |
| setJvmRoute | back to summary |
|---|---|
| public void setJvmRoute(String routeId) Implements org. 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.
| |
| setParent | back to summary |
|---|---|
| public void setParent(Container container) Overrides org. Implements org. Disallow any attempt to set a parent for this Container, since an Engine is supposed to be at the top of the Container hierarchy. | |
| setService | back to summary |
|---|---|
| public void setService(Service service) Implements org. Set the | |
| startInternal | back to summary |
|---|---|
| protected void startInternal() throws LifecycleException Overrides org. Start this component and implement the requirements of
| |
| Modifier and Type | Field and Description |
|---|---|
| private final Context | |
| private volatile boolean | |
| private final StandardEngine | |
| private final Host |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public void | containerEvent(ContainerEvent
ContainerEvent that has occurred event)Implements org. Acknowledge the occurrence of the specified event. |
| public void | |
| public void | lifecycleEvent(LifecycleEvent
LifecycleEvent that has occurred event)Implements org. Acknowledge the occurrence of the specified event. |
| public void | propertyChange(PropertyChangeEvent
A PropertyChangeEvent object describing the event source
and the property that has changed. evt)Implements java. This method gets called when a bound property is changed. |
| private void |
| context | back to summary |
|---|---|
| private final Context context | |
| disabled | back to summary |
|---|---|
| private volatile boolean disabled | |
| engine | back to summary |
|---|---|
| private final StandardEngine engine | |
| host | back to summary |
|---|---|
| private final Host host | |
| AccessLogListener | back to summary |
|---|---|
| public AccessLogListener(StandardEngine engine, Host host, Context context) | |
| containerEvent | back to summary |
|---|---|
| public void containerEvent(ContainerEvent event) Implements org. Doc from org. Acknowledge the occurrence of the specified event.
| |
| install | back to summary |
|---|---|
| public void install() | |
| lifecycleEvent | back to summary |
|---|---|
| public void lifecycleEvent(LifecycleEvent event) Implements org. Doc from org. Acknowledge the occurrence of the specified event.
| |
| propertyChange | back to summary |
|---|---|
| public void propertyChange(PropertyChangeEvent evt) Implements java. Doc from java. This method gets called when a bound property is changed.
| |
| uninstall | back to summary |
|---|---|
| private void uninstall() | |
| Access | Constructor and Description |
|---|---|
| protected |
| Modifier and Type | Method and Description |
|---|---|
| public boolean | |
| public void | log(Request
Request (associated with the response) to log request, Response Response (associated with the request) to log response, long Time taken to process the request/response in
nanoseconds (use 0 if not known); in Tomcat
versions prior to 10, the time unit was
milliseconds time)Implements org. Add the request/response to the access log using the specified processing time. |
| public void | setRequestAttributesEnabled(boolean
true causes the attributes
to be used, false causes
the original values to be used.Implements org. Should this valve use request attributes for IP address, hostname, protocol and port used for the request? |
| NoopAccessLog | back to summary |
|---|---|
| protected NoopAccessLog() | |
| getRequestAttributesEnabled | back to summary |
|---|---|
| public boolean getRequestAttributesEnabled() Implements org.
| |
| log | back to summary |
|---|---|
| public void log(Request request, Response response, long time) Implements org. Doc from org. Add the request/response to the access log using the specified processing time.
| |
| setRequestAttributesEnabled | back to summary |
|---|---|
| public void setRequestAttributesEnabled(boolean requestAttributesEnabled) Implements org. Doc from org. Should this valve use request attributes for IP address, hostname, protocol and port used for the request? The attributes used are:
| |