Valve to indicate that the Valve
provides access logging. It is used by the Tomcat internals to identify a
Valve that logs access requests so requests that are rejected
earlier in the processing chain can still be added to the access log.
Implementations of this interface should be robust against the provided
Request and Response objects being null, having null
attributes or any other 'oddness' that may result from attempting to log
a request that was almost certainly rejected because it was mal-formed.
| Modifier and Type | Field and Description |
|---|---|
| public static final String | PROTOCOL_ATTRIBUTE
Name of request attribute used to override the protocol recorded by the AccessLog. |
| public static final String | REMOTE_ADDR_ATTRIBUTE
Name of request attribute used to override the remote address recorded by the AccessLog. |
| public static final String | REMOTE_HOST_ATTRIBUTE
Name of request attribute used to override remote host name recorded by the AccessLog. |
| public static final String | SERVER_NAME_ATTRIBUTE
Name of request attribute used to override the server name recorded by the AccessLog. |
| public static final String | SERVER_PORT_ATTRIBUTE
Name of request attribute used to override the server port recorded by the AccessLog. |
| 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)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.Should this valve use request attributes for IP address, hostname, protocol and port used for the request? |
| PROTOCOL_ATTRIBUTE | back to summary |
|---|---|
| public static final String PROTOCOL_ATTRIBUTE Name of request attribute used to override the protocol recorded by the AccessLog. | |
| REMOTE_ADDR_ATTRIBUTE | back to summary |
|---|---|
| public static final String REMOTE_ADDR_ATTRIBUTE Name of request attribute used to override the remote address recorded by the AccessLog. | |
| REMOTE_HOST_ATTRIBUTE | back to summary |
|---|---|
| public static final String REMOTE_HOST_ATTRIBUTE Name of request attribute used to override remote host name recorded by the AccessLog. | |
| SERVER_NAME_ATTRIBUTE | back to summary |
|---|---|
| public static final String SERVER_NAME_ATTRIBUTE Name of request attribute used to override the server name recorded by the AccessLog. | |
| SERVER_PORT_ATTRIBUTE | back to summary |
|---|---|
| public static final String SERVER_PORT_ATTRIBUTE Name of request attribute used to override the server port recorded by the AccessLog. | |
| getRequestAttributesEnabled | back to summary |
|---|---|
public boolean getRequestAttributesEnabled()
| |
| log | back to summary |
|---|---|
| public void log(Request request, Response response, long time) Add the request/response to the access log using the specified processing time. | |
| setRequestAttributesEnabled | back to summary |
|---|---|
| public void setRequestAttributesEnabled(boolean requestAttributesEnabled) Should this valve use request attributes for IP address, hostname, protocol and port used for the request? The attributes used are:
| |