org.apache.catalina.valves.AccessLogValve Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-embedded-web Show documentation
Show all versions of payara-embedded-web Show documentation
Embedded-Web Distribution of the Payara Project for IBM JDK
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Copyright 2004 The Apache Software Foundation
*
* Licensed 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.valves;
import org.apache.catalina.*;
import org.glassfish.logging.annotation.LogMessageInfo;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.io.PrintWriter;
import java.net.InetAddress;
import java.text.DecimalFormat;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.TimeZone;
import java.util.logging.Level;
/**
* Implementation of the Valve interface that generates a web server
* access log with the detailed line contents matching a configurable pattern.
* The syntax of the available patterns is similar to that supported by the
* Apache mod_log_config module. As an additional feature,
* automatic rollover of log files when the date changes is also supported.
*
* Patterns for the logged message may include constant text or any of the
* following replacement strings, for which the corresponding information
* from the specified Response is substituted:
*
* - %a - Remote IP address
*
- %A - Local IP address
*
- %b - Bytes sent, excluding HTTP headers, or '-' if no bytes
* were sent
*
- %B - Bytes sent, excluding HTTP headers
*
- %h - Remote host name
*
- %H - Request protocol
*
- %l - Remote logical username from identd (always returns '-')
*
- %m - Request method
*
- %p - Local port
*
- %q - Query string (prepended with a '?' if it exists, otherwise
* an empty string
*
- %r - First line of the request
*
- %s - HTTP status code of the response
*
- %S - User session ID
*
- %t - Date and time, in Common Log Format format
*
- %u - Remote user that was authenticated
*
- %U - Requested URL path
*
- %v - Local server name
*
- %D - Time taken to process the request, in millis
*
- %T - Time taken to process the request, in seconds
*
* In addition, the caller can specify one of the following aliases for
* commonly utilized patterns:
*
* - common -
%h %l %u %t "%r" %s %b
* - combined -
*
%h %l %u %t "%r" %s %b "%{Referer}i" "%{User-Agent}i"
*
*
*
* There is also support to write information from the cookie, incoming
* header, the Session or something else in the ServletRequest.
* It is modeled after the apache syntax:
*
* %{xxx}i for incoming headers
* %{xxx}c for a specific cookie
* %{xxx}r xxx is an attribute in the ServletRequest
* %{xxx}s xxx is an attribute in the HttpSession
*
*
*
*
* Conditional logging is also supported. This can be done with the
* condition property.
* If the value returned from ServletRequest.getAttribute(condition)
* yields a non-null value. The logging will be skipped.
*
*
* @author Craig R. McClanahan
* @author Jason Brittain
* @version $Revision: 1.4 $ $Date: 2006/10/23 23:18:02 $
*/
public final class AccessLogValve
/** CR 6411114 (Lifecycle implementation moved to ValveBase)
extends ValveBase
implements Lifecycle {
*/
// START CR 6411114
extends ValveBase {
// END CR 6411114
@LogMessageInfo(
message = "Could not create a new directory: {0}",
level = "SEVERE",
cause = "Could not create a new directory",
action = "Verify if file is directory, and access permission"
)
public static final String CREATING_DIR_EXCEPTION = "AS-WEB-CORE-00491";
// ----------------------------------------------------------- Constructors
/**
* Construct a new instance of this class with default property values.
*/
public AccessLogValve() {
super();
setPattern("common");
}
// ----------------------------------------------------- Instance Variables
/**
* The as-of date for the currently open log file, or a zero-length
* string if there is no open log file.
*/
private String dateStamp = "";
/**
* The directory in which log files are created.
*/
private String directory = "logs";
/**
* The descriptive information about this implementation.
*/
private static final String info =
"org.apache.catalina.valves.AccessLogValve/1.0";
/**
* The lifecycle event support for this component.
*/
/** CR 6411114 (Lifecycle implementation moved to ValveBase)
protected LifecycleSupport lifecycle = new LifecycleSupport(this);
*/
private static final String REQUEST_START_TIME_NOTE =
"org.apache.catalina.valves.AccessLogValve.requestStartTime";
/**
* The set of month abbreviations for log messages.
*/
private static final String months[] =
{ "Jan", "Feb", "Mar", "Apr", "May", "Jun",
"Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
/**
* If the current log pattern is the same as the common access log
* format pattern, then we'll set this variable to true and log in
* a more optimal and hard-coded way.
*/
private boolean common = false;
/**
* For the combined format (common, plus useragent and referer), we do
* the same
*/
private boolean combined = false;
/**
* The pattern used to format our access log lines.
*/
private String pattern = null;
/**
* The prefix that is added to log file filenames.
*/
private String prefix = "access_log.";
/**
* Should we rotate our log file? Default is true (like old behavior)
*/
private boolean rotatable = true;
/**
* Has this component been started yet?
*/
/** CR 6411114 (Lifecycle implementation moved to ValveBase)
private boolean started = false;
*/
/**
* The suffix that is added to log file filenames.
*/
private String suffix = "";
/**
* The PrintWriter to which we are currently logging, if any.
*/
private PrintWriter writer = null;
/**
* ThreadLocal for a date formatter to format a Date into a date in the format
* "yyyy-MM-dd".
*/
private volatile ThreadLocal dateFormatter = null;
private static final TimeZone DEFAULT_TIME_ZONE = TimeZone.getDefault();
/**
* ThreadLocal for a date formatter to format Dates into a day string in the format
* "dd".
*/
private static final ThreadLocal dayFormatter =
new ThreadLocal() {
@Override
protected SimpleDateFormat initialValue() {
SimpleDateFormat f = new SimpleDateFormat("dd");
f.setTimeZone(DEFAULT_TIME_ZONE);
return f;
}
};
/**
* ThreadLocal for a date formatter to format a Date into a month string in the format
* "MM".
*/
private static final ThreadLocal monthFormatter =
new ThreadLocal() {
@Override
protected SimpleDateFormat initialValue() {
SimpleDateFormat f = new SimpleDateFormat("MM");
f.setTimeZone(DEFAULT_TIME_ZONE);
return f;
}
};
/**
* ThreadLocal for a time taken formatter for 3 decimal places.
*/
private static final ThreadLocal timeTakenFormatter =
new ThreadLocal() {
@Override
protected DecimalFormat initialValue() {
return new DecimalFormat("0.000");
}
};
/**
* ThreadLocal for a date formatter to format a Date into a year string in the format
* "yyyy".
*/
private ThreadLocal yearFormatter =
new ThreadLocal() {
@Override
protected SimpleDateFormat initialValue() {
SimpleDateFormat f = new SimpleDateFormat("yyyy");
f.setTimeZone(DEFAULT_TIME_ZONE);
return f;
}
};
/**
* ThreadLocal for a date formatter to format a Date into a time in the format
* "kk:mm:ss" (kk is a 24-hour representation of the hour).
*/
private ThreadLocal timeFormatter =
new ThreadLocal() {
@Override
protected SimpleDateFormat initialValue() {
SimpleDateFormat f = new SimpleDateFormat("HH:mm:ss");
f.setTimeZone(DEFAULT_TIME_ZONE);
return f;
}
};
/**
* The time zone relative to GMT.
*/
private String timeZone = null;
/**
* The system time when we last updated the Date that this valve
* uses for log lines.
*/
private Date currentDate = null;
/**
* When formatting log lines, we often use strings like this one (" ").
*/
private String space = " ";
/**
* Resolve hosts.
*/
private boolean resolveHosts = false;
/**
* Instant when the log daily rotation was last checked.
*/
private volatile long rotationLastChecked = 0L;
/**
* Are we doing conditional logging. default false.
*/
private String condition = null;
/**
* Date format to place in log file name. Use at your own risk!
*/
private String fileDateFormat = null;
// ------------------------------------------------------------- Properties
/**
* Return the directory in which we create log files.
*/
public String getDirectory() {
return (directory);
}
/**
* Set the directory in which we create log files.
*
* @param directory The new log file directory
*/
public void setDirectory(String directory) {
this.directory = directory;
}
/**
* Return descriptive information about this implementation.
*/
public String getInfo() {
return (this.info);
}
/**
* Return the format pattern.
*/
public String getPattern() {
return (this.pattern);
}
/**
* Set the format pattern, first translating any recognized alias.
*
* @param pattern The new pattern
*/
public void setPattern(String pattern) {
if (pattern == null)
pattern = "";
if (pattern.equals(Constants.AccessLog.COMMON_ALIAS))
pattern = Constants.AccessLog.COMMON_PATTERN;
if (pattern.equals(Constants.AccessLog.COMBINED_ALIAS))
pattern = Constants.AccessLog.COMBINED_PATTERN;
this.pattern = pattern;
if (this.pattern.equals(Constants.AccessLog.COMMON_PATTERN))
common = true;
else
common = false;
if (this.pattern.equals(Constants.AccessLog.COMBINED_PATTERN))
combined = true;
else
combined = false;
}
/**
* Return the log file prefix.
*/
public String getPrefix() {
return (prefix);
}
/**
* Set the log file prefix.
*
* @param prefix The new log file prefix
*/
public void setPrefix(String prefix) {
this.prefix = prefix;
}
/**
* Should we rotate the logs
*/
public boolean isRotatable() {
return rotatable;
}
/**
* Set the value is we should we rotate the logs
*
* @param rotatable true is we should rotate.
*/
public void setRotatable(boolean rotatable) {
this.rotatable = rotatable;
}
/**
* Return the log file suffix.
*/
public String getSuffix() {
return (suffix);
}
/**
* Set the log file suffix.
*
* @param suffix The new log file suffix
*/
public void setSuffix(String suffix) {
this.suffix = suffix;
}
/**
* Set the resolve hosts flag.
*
* @param resolveHosts The new resolve hosts value
*/
public void setResolveHosts(boolean resolveHosts) {
this.resolveHosts = resolveHosts;
}
/**
* Get the value of the resolve hosts flag.
*/
public boolean isResolveHosts() {
return resolveHosts;
}
/**
* Return whether the attribute name to look for when
* performing conditional logging. If null, every
* request is logged.
*/
public String getCondition() {
return condition;
}
/**
* Set the ServletRequest.attribute to look for to perform
* conditional logging. Set to null to log everything.
*
* @param condition Set to null to log everything
*/
public void setCondition(String condition) {
this.condition = condition;
}
/**
* Return the date format date based log rotation.
*/
public String getFileDateFormat() {
return fileDateFormat;
}
/**
* Set the date format date based log rotation.
*/
public void setFileDateFormat(String fileDateFormat) {
this.fileDateFormat = fileDateFormat;
}
// --------------------------------------------------------- Public Methods
/**
* Log a message summarizing the specified request and response, according
* to the format specified by the pattern property.
*
* @param request Request being processed
* @param response Response being processed
*
* @exception IOException if an input/output error has occurred
* @exception ServletException if a servlet error has occurred
*/
public int invoke(Request request, Response response)
throws IOException, ServletException {
// Pass this request on to the next valve in our pipeline
request.setNote(REQUEST_START_TIME_NOTE, Long.valueOf(System.currentTimeMillis()));
return INVOKE_NEXT;
}
public void postInvoke(Request request, Response response){
long t2 = System.currentTimeMillis();
Object startTimeObj = request.getNote(REQUEST_START_TIME_NOTE);
if (!(startTimeObj instanceof Long)) {
// should not happen
return;
}
long time = t2 - ((Long)startTimeObj).longValue();
if (condition!=null &&
null!=request.getRequest().getAttribute(condition)) {
return;
}
Date date = getDate();
StringBuilder result = new StringBuilder();
// Check to see if we should log using the "common" access log pattern
if (common || combined) {
String value = null;
ServletRequest req = request.getRequest();
HttpServletRequest hreq = (HttpServletRequest) req;
if (isResolveHosts())
result.append(req.getRemoteHost());
else
result.append(req.getRemoteAddr());
result.append(" - ");
value = hreq.getRemoteUser();
if (value == null)
result.append("- ");
else {
result.append(value);
result.append(space);
}
result.append("[");
result.append(dayFormatter.get().format(date)); // Day
result.append('/');
result.append(lookup(monthFormatter.get().format(date))); // Month
result.append('/');
result.append(yearFormatter.get().format(date)); // Year
result.append(':');
result.append(timeFormatter.get().format(date)); // Time
result.append(space);
result.append(timeZone); // Time Zone
result.append("] \"");
result.append(hreq.getMethod());
result.append(space);
result.append(hreq.getRequestURI());
if (hreq.getQueryString() != null) {
result.append('?');
result.append(hreq.getQueryString());
}
result.append(space);
result.append(hreq.getProtocol());
result.append("\" ");
result.append(((HttpResponse) response).getStatus());
result.append(space);
int length = response.getContentCount();
if (length <= 0)
value = "-";
else
value = "" + length;
result.append(value);
if (combined) {
result.append(space);
result.append("\"");
String referer = hreq.getHeader("referer");
if(referer != null)
result.append(referer);
else
result.append("-");
result.append("\"");
result.append(space);
result.append("\"");
String ua = hreq.getHeader("user-agent");
if(ua != null)
result.append(ua);
else
result.append("-");
result.append("\"");
}
} else {
// Generate a message based on the defined pattern
boolean replace = false;
for (int i = 0; i < pattern.length(); i++) {
char ch = pattern.charAt(i);
if (replace) {
/* For code that processes {, the behavior will be ... if I
* do not encounter a closing } - then I ignore the {
*/
if ('{' == ch){
StringBuilder name = new StringBuilder();
int j = i + 1;
for(;j < pattern.length() && '}' != pattern.charAt(j); j++) {
name.append(pattern.charAt(j));
}
if (j+1 < pattern.length()) {
/* the +1 was to account for } which we increment now */
j++;
result.append(replace(name.toString(),
pattern.charAt(j),
request,
response));
i=j; /*Since we walked more than one character*/
} else {
//D'oh - end of string - pretend we never did this
//and do processing the "old way"
result.append(replace(ch, date, request, response, time));
}
} else {
result.append(replace(ch, date, request, response,time ));
}
replace = false;
} else if (ch == '%') {
replace = true;
} else {
result.append(ch);
}
}
}
log(result.toString(), date);
}
// -------------------------------------------------------- Private Methods
/**
* Close the currently open log file (if any)
*/
private synchronized void close() {
if (writer == null)
return;
writer.flush();
writer.close();
writer = null;
dateStamp = "";
}
/**
* Log the specified message to the log file, switching files if the date
* has changed since the previous log call.
*
* @param message Message to be logged
* @param date the current Date object (so this method doesn't need to
* create a new one)
*/
public void log(String message, Date date) {
if (rotatable){
// Only do a logfile switch check once a second, max.
long systime = System.currentTimeMillis();
if ((systime - rotationLastChecked) > 1000) {
// We need a new currentDate
currentDate = new Date(systime);
rotationLastChecked = systime;
// Check for a change of date
String tsDate = dateFormatter.get().format(currentDate);
// If the date has changed, switch log files
if (!dateStamp.equals(tsDate)) {
synchronized (this) {
if (!dateStamp.equals(tsDate)) {
close();
dateStamp = tsDate;
open();
}
}
}
}
}
// Log this message
if (writer != null) {
writer.println(message);
}
}
/**
* Return the month abbreviation for the specified month, which must
* be a two-digit String.
*
* @param month Month number ("01" .. "12").
*/
private String lookup(String month) {
int index;
try {
index = Integer.parseInt(month) - 1;
} catch (Throwable t) {
index = 0; // Can not happen, in theory
}
return (months[index]);
}
/**
* Open the new log file for the date specified by dateStamp.
*/
private synchronized void open() {
// Create the directory if necessary
File dir = new File(directory);
if (!dir.isAbsolute())
dir = new File(System.getProperty("catalina.base"), directory);
if (!dir.mkdirs() && !dir.isDirectory()) {
log.log(Level.SEVERE, CREATING_DIR_EXCEPTION, dir);
}
// Open the current log file
try {
String pathname;
// If no rotate - no need for dateStamp in fileName
if (rotatable){
pathname = dir.getAbsolutePath() + File.separator +
prefix + dateStamp + suffix;
} else {
pathname = dir.getAbsolutePath() + File.separator +
prefix + suffix;
}
writer = new PrintWriter(new FileWriter(pathname, true), true);
} catch (IOException e) {
writer = null;
}
}
/**
* Return the replacement text for the specified pattern character.
*
* @param pattern Pattern character identifying the desired text
* @param date the current Date so that this method doesn't need to
* create one
* @param request Request being processed
* @param response Response being processed
*/
private String replace(char pattern, Date date, Request request,
Response response, long time) {
String value = null;
ServletRequest req = request.getRequest();
HttpServletRequest hreq = (HttpServletRequest) req;
ServletResponse res = response.getResponse();
HttpServletResponse hres = (HttpServletResponse) res;
if (pattern == 'a') {
value = req.getRemoteAddr();
} else if (pattern == 'A') {
try {
value = InetAddress.getLocalHost().getHostAddress();
} catch(Throwable e){
value = "127.0.0.1";
}
} else if (pattern == 'b') {
int length = response.getContentCount();
if (length <= 0)
value = "-";
else
value = "" + length;
} else if (pattern == 'B') {
value = "" + response.getContentLength();
} else if (pattern == 'h') {
value = req.getRemoteHost();
} else if (pattern == 'H') {
value = req.getProtocol();
} else if (pattern == 'l') {
value = "-";
} else if (pattern == 'm') {
if (hreq != null)
value = hreq.getMethod();
else
value = "";
} else if (pattern == 'p') {
value = "" + req.getServerPort();
} else if (pattern == 'D') {
value = "" + time;
} else if (pattern == 'q') {
String query = null;
if (hreq != null)
query = hreq.getQueryString();
if (query != null)
value = "?" + query;
else
value = "";
} else if (pattern == 'r') {
if (hreq != null) {
StringBuilder sb = new StringBuilder();
sb.append(hreq.getMethod());
sb.append(space);
sb.append(hreq.getRequestURI());
if (hreq.getQueryString() != null) {
sb.append('?');
sb.append(hreq.getQueryString());
}
sb.append(space);
sb.append(hreq.getProtocol());
value = sb.toString();
} else {
value = "- - -";
}
} else if (pattern == 'S') {
if (request instanceof org.apache.catalina.connector.Request) {
Session sess = ((org.apache.catalina.connector.Request) request).getSessionInternal(false);
if (sess != null) {
value = sess.getIdInternal();
} else {
value = "-";
}
} else {
if (hreq != null)
if (hreq.getSession(false) != null)
value = hreq.getSession(false).getId();
else value = "-";
else
value = "-";
}
} else if (pattern == 's') {
if (hres != null)
value = "" + ((HttpResponse) response).getStatus();
else
value = "-";
} else if (pattern == 't') {
StringBuilder temp = new StringBuilder("[");
temp.append(dayFormatter.get().format(date)); // Day
temp.append('/');
temp.append(lookup(monthFormatter.get().format(date))); // Month
temp.append('/');
temp.append(yearFormatter.get().format(date)); // Year
temp.append(':');
temp.append(timeFormatter.get().format(date)); // Time
temp.append(' ');
temp.append(timeZone); // Timezone
temp.append(']');
value = temp.toString();
} else if (pattern == 'T') {
value = timeTakenFormatter.get().format(time/1000d);
} else if (pattern == 'u') {
if (hreq != null)
value = hreq.getRemoteUser();
if (value == null)
value = "-";
} else if (pattern == 'U') {
if (hreq != null)
value = hreq.getRequestURI();
else
value = "-";
} else if (pattern == 'v') {
value = req.getServerName();
} else {
value = "???" + pattern + "???";
}
if (value == null)
return ("");
else
return (value);
}
/**
* Return the replacement text for the specified "header/parameter".
*
* @param header The header/parameter to get
* @param type Where to get it from i=input,c=cookie,r=ServletRequest,s=Session
* @param request Request being processed
* @param response Response being processed
*/
private String replace(String header, char type, Request request,
Response response) {
Object value = null;
ServletRequest req = request.getRequest();
HttpServletRequest hreq = (HttpServletRequest) req;
switch (type) {
case 'i':
if (null != hreq)
value = hreq.getHeader(header);
else
value= "??";
break;
/*
// Someone please make me work
case 'o':
break;
*/
case 'c':
Cookie[] c = hreq.getCookies();
for (int i=0; c != null && i < c.length; i++){
if (header.equals(c[i].getName())){
value = c[i].getValue();
break;
}
}
break;
case 'r':
if (null != hreq)
value = hreq.getAttribute(header);
else
value= "??";
break;
case 's':
if (null != hreq) {
HttpSession sess = hreq.getSession(false);
if (null != sess)
value = sess.getAttribute(header);
}
break;
default:
value = "???";
}
/* try catch in case toString() barfs */
try {
if (value!=null)
if (value instanceof String)
return (String)value;
else
return value.toString();
else
return "-";
} catch(Throwable e) {
return "-";
}
}
/**
* This method returns a Date object that is accurate to within one
* second. If a thread calls this method to get a Date and it's been
* less than 1 second since a new Date was created, this method
* simply gives out the same Date again so that the system doesn't
* spend time creating Date objects unnecessarily.
*/
private Date getDate() {
// Only create a new Date once per second, max.
long systime = System.currentTimeMillis();
if ((systime - currentDate.getTime()) > 1000) {
currentDate = new Date(systime);
}
return currentDate;
}
private String calculateTimeZoneOffset(long offset) {
StringBuilder tz = new StringBuilder();
if ((offset<0)) {
tz.append("-");
offset = -offset;
} else {
tz.append("+");
}
long hourOffset = offset/(1000*60*60);
long minuteOffset = (offset/(1000*60)) % 60;
if (hourOffset<10)
tz.append("0");
tz.append(hourOffset);
if (minuteOffset<10)
tz.append("0");
tz.append(minuteOffset);
return tz.toString();
}
// ------------------------------------------------------ Lifecycle Methods
/**
* Add a lifecycle event listener to this component.
*
* @param listener The listener to add
*/
/** CR 6411114 (Lifecycle implementation moved to ValveBase)
public void addLifecycleListener(LifecycleListener listener) {
lifecycle.addLifecycleListener(listener);
}
*/
/**
* Get the lifecycle listeners associated with this lifecycle. If this
* Lifecycle has no listeners registered, a zero-length array is returned.
*/
/** CR 6411114 (Lifecycle implementation moved to ValveBase)
public LifecycleListener[] findLifecycleListeners() {
return lifecycle.findLifecycleListeners();
}
*/
/**
* Remove a lifecycle event listener from this component.
*
* @param listener The listener to add
*/
/** CR 6411114 (Lifecycle implementation moved to ValveBase)
public void removeLifecycleListener(LifecycleListener listener) {
lifecycle.removeLifecycleListener(listener);
}
*/
/**
* Prepare for the beginning of active use of the public methods of this
* component. This method should be called after configure(),
* and before any of the public methods of the component are utilized.
*
* @exception LifecycleException if this component detects a fatal error
* that prevents this component from being used
*/
public void start() throws LifecycleException {
// START CR 6411114
if (started) // Ignore multiple starts
return;
super.start();
// END CR 6411114
// Initialize the timeZone, Date formatters, and currentDate
timeZone = calculateTimeZoneOffset(DEFAULT_TIME_ZONE.getRawOffset());
if (fileDateFormat==null || fileDateFormat.length()==0)
fileDateFormat = "yyyy-MM-dd";
dateFormatter = new ThreadLocal() {
@Override
protected SimpleDateFormat initialValue() {
SimpleDateFormat f = new SimpleDateFormat(fileDateFormat);
f.setTimeZone(DEFAULT_TIME_ZONE);
return f;
}
};
currentDate = new Date();
dateStamp = dateFormatter.get().format(currentDate);
open();
}
/**
* Gracefully terminate the active use of the public methods of this
* component. This method should be the last one called on a given
* instance of this component.
*
* @exception LifecycleException if this component detects a fatal error
* that needs to be reported
*/
public void stop() throws LifecycleException {
// START CR 6411114
if (!started) // Ignore stop if not started
return;
// END CR 6411114
close();
// START CR 6411114
super.stop();
// END CR 6411114
}
}