org.apache.logging.log4j.core.pattern.DatePatternConverter 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.logging.log4j.core.pattern;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.TimeZone;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.config.plugins.Plugin;
/**
* Convert and format the event's date in a StringBuilder.
*/
@Plugin(name = "DatePatternConverter", category = PatternConverter.CATEGORY)
@ConverterKeys({ "d", "date" })
public final class DatePatternConverter extends LogEventPatternConverter implements ArrayPatternConverter {
private abstract static class Formatter {
abstract String format(long time);
public String toPattern() {
return null;
}
}
private static class PatternFormatter extends Formatter {
private final SimpleDateFormat simpleDateFormat;
PatternFormatter(final SimpleDateFormat simpleDateFormat) {
this.simpleDateFormat = simpleDateFormat;
}
@Override
String format(final long time) {
return simpleDateFormat.format(Long.valueOf(time));
}
@Override
public String toPattern() {
return simpleDateFormat.toPattern();
}
}
private static class UnixFormatter extends Formatter {
@Override
String format(final long time) {
return Long.toString(time / 1000);
}
}
private static class UnixMillisFormatter extends Formatter {
@Override
String format(final long time) {
return Long.toString(time);
}
}
/**
* ABSOLUTE string literal.
*/
private static final String ABSOLUTE_FORMAT = "ABSOLUTE";
/**
* SimpleTimePattern for ABSOLUTE.
*/
private static final String ABSOLUTE_TIME_PATTERN = "HH:mm:ss,SSS";
/**
* COMPACT string literal.
*/
private static final String COMPACT_FORMAT = "COMPACT";
/**
* SimpleTimePattern for COMPACT.
*/
private static final String COMPACT_PATTERN = "yyyyMMddHHmmssSSS";
/**
* DATE string literal.
*/
private static final String DATE_AND_TIME_FORMAT = "DATE";
/**
* SimpleTimePattern for DATE.
*/
private static final String DATE_AND_TIME_PATTERN = "dd MMM yyyy HH:mm:ss,SSS";
/**
* DEFAULT string literal.
*/
private static final String DEFAULT_FORMAT = "DEFAULT";
/**
* SimpleTimePattern for DEFAULT.
*/
// package private for unit tests
static final String DEFAULT_PATTERN = "yyyy-MM-dd HH:mm:ss,SSS";
/**
* ISO8601_BASIC string literal.
*/
private static final String ISO8601_BASIC_FORMAT = "ISO8601_BASIC";
/**
* SimpleTimePattern for ISO8601_BASIC.
*/
private static final String ISO8601_BASIC_PATTERN = "yyyyMMdd'T'HHmmss,SSS";
/**
* ISO8601 string literal.
*/
// package private for unit tests
static final String ISO8601_FORMAT = "ISO8601";
/**
* SimpleTimePattern for ISO8601.
*/
// package private for unit tests
static final String ISO8601_PATTERN = "yyyy-MM-dd'T'HH:mm:ss,SSS";
/**
* UNIX formatter in seconds (standard).
*/
private static final String UNIX_FORMAT = "UNIX";
/**
* UNIX formatter in milliseconds
*/
private static final String UNIX_MILLIS_FORMAT = "UNIX_MILLIS";
/**
* Obtains an instance of pattern converter.
*
* @param options
* options, may be null.
* @return instance of pattern converter.
*/
public static DatePatternConverter newInstance(final String[] options) {
return new DatePatternConverter(options);
}
/**
* Date format.
*/
private String cachedDateString;
private final Formatter formatter;
private long lastTimestamp;
/**
* Private constructor.
*
* @param options
* options, may be null.
*/
private DatePatternConverter(final String[] options) {
super("Date", "date");
// null patternOption is OK.
final String patternOption = options != null && options.length > 0 ? options[0] : null;
String pattern = null;
Formatter tempFormatter = null;
if (patternOption == null || patternOption.equalsIgnoreCase(DEFAULT_FORMAT)) {
pattern = DEFAULT_PATTERN;
} else if (patternOption.equalsIgnoreCase(ISO8601_FORMAT)) {
pattern = ISO8601_PATTERN;
} else if (patternOption.equalsIgnoreCase(ISO8601_BASIC_FORMAT)) {
pattern = ISO8601_BASIC_PATTERN;
} else if (patternOption.equalsIgnoreCase(ABSOLUTE_FORMAT)) {
pattern = ABSOLUTE_TIME_PATTERN;
} else if (patternOption.equalsIgnoreCase(DATE_AND_TIME_FORMAT)) {
pattern = DATE_AND_TIME_PATTERN;
} else if (patternOption.equalsIgnoreCase(COMPACT_FORMAT)) {
pattern = COMPACT_PATTERN;
} else if (patternOption.equalsIgnoreCase(UNIX_FORMAT)) {
tempFormatter = new UnixFormatter();
} else if (patternOption.equalsIgnoreCase(UNIX_MILLIS_FORMAT)) {
tempFormatter = new UnixMillisFormatter();
} else {
pattern = patternOption;
}
if (pattern != null) {
SimpleDateFormat tempFormat;
try {
tempFormat = new SimpleDateFormat(pattern);
} catch (final IllegalArgumentException e) {
LOGGER.warn("Could not instantiate SimpleDateFormat with pattern " + patternOption, e);
// default to the DEFAULT format
tempFormat = new SimpleDateFormat(DEFAULT_PATTERN);
}
// if the option list contains a TZ option, then set it.
if (options != null && options.length > 1) {
final TimeZone tz = TimeZone.getTimeZone(options[1]);
tempFormat.setTimeZone(tz);
}
tempFormatter = new PatternFormatter(tempFormat);
}
formatter = tempFormatter;
}
/**
* Append formatted date to string buffer.
*
* @param date
* date
* @param toAppendTo
* buffer to which formatted date is appended.
*/
public void format(final Date date, final StringBuilder toAppendTo) {
synchronized (this) {
toAppendTo.append(formatter.format(date.getTime()));
}
}
/**
* {@inheritDoc}
*/
@Override
public void format(final LogEvent event, final StringBuilder output) {
final long timestamp = event.getTimeMillis();
synchronized (this) {
if (timestamp != lastTimestamp) {
lastTimestamp = timestamp;
cachedDateString = formatter.format(timestamp);
}
}
output.append(cachedDateString);
}
/**
* {@inheritDoc}
*/
@Override
public void format(final Object obj, final StringBuilder output) {
if (obj instanceof Date) {
format((Date) obj, output);
}
super.format(obj, output);
}
@Override
public void format(final StringBuilder toAppendTo, final Object... objects) {
for (final Object obj : objects) {
if (obj instanceof Date) {
format(obj, toAppendTo);
break;
}
}
}
/**
* Gets the pattern string describing this date format.
*
* @return the pattern string describing this date format.
*/
public String getPattern() {
return formatter.toPattern();
}
}