org.apache.catalina.AccessLog Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.catalina;
import org.apache.catalina.connector.Request;
import org.apache.catalina.connector.Response;
/**
* Intended for use by a {@link Valve} to indicate that the {@link 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 {@link Request} and {@link 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.
*/
public interface AccessLog {
/**
* Name of request attribute used to override the remote address recorded by the AccessLog.
*/
String REMOTE_ADDR_ATTRIBUTE = "org.apache.catalina.AccessLog.RemoteAddr";
/**
* Name of request attribute used to override remote host name recorded by the AccessLog.
*/
String REMOTE_HOST_ATTRIBUTE = "org.apache.catalina.AccessLog.RemoteHost";
/**
* Name of request attribute used to override the protocol recorded by the AccessLog.
*/
String PROTOCOL_ATTRIBUTE = "org.apache.catalina.AccessLog.Protocol";
/**
* Name of request attribute used to override the server name recorded by the AccessLog.
*/
String SERVER_NAME_ATTRIBUTE = "org.apache.catalina.AccessLog.ServerName";
/**
* Name of request attribute used to override the server port recorded by the AccessLog.
*/
String SERVER_PORT_ATTRIBUTE = "org.apache.catalina.AccessLog.ServerPort";
/**
* Add the request/response to the access log using the specified processing time.
*
* @param request Request (associated with the response) to log
* @param response Response (associated with the request) to log
* @param time 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
*/
void log(Request request, Response response, long time);
/**
* Should this valve use request attributes for IP address, hostname, protocol and port used for the request? The
* attributes used are:
*
* - org.apache.catalina.RemoteAddr
* - org.apache.catalina.RemoteHost
* - org.apache.catalina.Protocol
* - org.apache.catalina.ServerName
* - org.apache.catalina.ServerPost
*
*
* @param requestAttributesEnabled true causes the attributes to be used, false causes the
* original values to be used.
*/
void setRequestAttributesEnabled(boolean requestAttributesEnabled);
/**
* @see #setRequestAttributesEnabled(boolean)
*
* @return true if the attributes will be logged, otherwise false
*/
boolean getRequestAttributesEnabled();
}