| /* |
| * 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.log4j.builders.appender; |
| |
| import org.apache.log4j.Appender; |
| import org.apache.log4j.Layout; |
| import org.apache.log4j.bridge.AppenderWrapper; |
| import org.apache.log4j.bridge.LayoutAdapter; |
| import org.apache.log4j.bridge.LayoutWrapper; |
| import org.apache.log4j.builders.AbstractBuilder; |
| import org.apache.log4j.builders.BooleanHolder; |
| import org.apache.log4j.builders.Holder; |
| import org.apache.log4j.config.Log4j1Configuration; |
| import org.apache.log4j.config.PropertiesConfiguration; |
| import org.apache.log4j.spi.Filter; |
| import org.apache.log4j.xml.XmlConfiguration; |
| import org.apache.logging.log4j.Logger; |
| import org.apache.logging.log4j.core.appender.RollingFileAppender; |
| import org.apache.logging.log4j.core.appender.rolling.DefaultRolloverStrategy; |
| import org.apache.logging.log4j.core.appender.rolling.RolloverStrategy; |
| import org.apache.logging.log4j.core.appender.rolling.TimeBasedTriggeringPolicy; |
| import org.apache.logging.log4j.core.appender.rolling.TriggeringPolicy; |
| import org.apache.logging.log4j.plugins.Plugin; |
| import org.apache.logging.log4j.status.StatusLogger; |
| import org.w3c.dom.Element; |
| |
| import java.util.Properties; |
| |
| import static org.apache.log4j.builders.BuilderManager.CATEGORY; |
| import static org.apache.log4j.config.Log4j1Configuration.THRESHOLD_PARAM; |
| import static org.apache.log4j.xml.XmlConfiguration.FILTER_TAG; |
| import static org.apache.log4j.xml.XmlConfiguration.LAYOUT_TAG; |
| import static org.apache.log4j.xml.XmlConfiguration.NAME_ATTR; |
| import static org.apache.log4j.xml.XmlConfiguration.PARAM_TAG; |
| import static org.apache.log4j.xml.XmlConfiguration.VALUE_ATTR; |
| import static org.apache.log4j.xml.XmlConfiguration.forEachElement; |
| |
| |
| /** |
| * Build a Daily Rolling File Appender |
| */ |
| @Plugin(name = "org.apache.log4j.DailyRollingFileAppender", category = CATEGORY) |
| public class DailyRollingFileAppenderBuilder extends AbstractBuilder implements AppenderBuilder { |
| |
| private static final Logger LOGGER = StatusLogger.getLogger(); |
| |
| public DailyRollingFileAppenderBuilder() { |
| } |
| |
| public DailyRollingFileAppenderBuilder(String prefix, Properties props) { |
| super(prefix, props); |
| } |
| |
| |
| @Override |
| public Appender parseAppender(final Element appenderElement, final XmlConfiguration config) { |
| String name = appenderElement.getAttribute(NAME_ATTR); |
| Holder<Layout> layout = new Holder<>(); |
| Holder<Filter> filter = new Holder<>(); |
| Holder<String> fileName = new Holder<>(); |
| Holder<String> level = new Holder<>(); |
| Holder<Boolean> immediateFlush = new BooleanHolder(); |
| Holder<Boolean> append = new BooleanHolder(); |
| Holder<Boolean> bufferedIo = new BooleanHolder(); |
| Holder<Integer> bufferSize = new Holder<>(8192); |
| forEachElement(appenderElement.getChildNodes(), (currentElement) -> { |
| switch (currentElement.getTagName()) { |
| case LAYOUT_TAG: |
| layout.set(config.parseLayout(currentElement)); |
| break; |
| case FILTER_TAG: |
| filter.set(config.parseFilters(currentElement)); |
| break; |
| case PARAM_TAG: { |
| switch (currentElement.getAttribute(NAME_ATTR)) { |
| case FILE_PARAM: |
| fileName.set(currentElement.getAttribute(VALUE_ATTR)); |
| break; |
| case APPEND_PARAM: { |
| String bool = currentElement.getAttribute(VALUE_ATTR); |
| if (bool != null) { |
| append.set(Boolean.parseBoolean(bool)); |
| } else { |
| LOGGER.warn("No value provided for append parameter"); |
| } |
| break; |
| } |
| case BUFFERED_IO_PARAM: { |
| String bool = currentElement.getAttribute(VALUE_ATTR); |
| if (bool != null) { |
| bufferedIo.set(Boolean.parseBoolean(bool)); |
| } else { |
| LOGGER.warn("No value provided for bufferedIo parameter"); |
| } |
| break; |
| } |
| case BUFFER_SIZE_PARAM: { |
| String size = currentElement.getAttribute(VALUE_ATTR); |
| if (size != null) { |
| bufferSize.set(Integer.parseInt(size)); |
| } else { |
| LOGGER.warn("No value provide for bufferSize parameter"); |
| } |
| break; |
| } |
| case THRESHOLD_PARAM: { |
| String value = currentElement.getAttribute(VALUE_ATTR); |
| if (value == null) { |
| LOGGER.warn("No value supplied for Threshold parameter, ignoring."); |
| } else { |
| level.set(value); |
| } |
| break; |
| } |
| } |
| break; |
| } |
| } |
| }); |
| return createAppender(name, layout.get(), filter.get(), fileName.get(), append.get(), immediateFlush.get(), |
| level.get(), bufferedIo.get(), bufferSize.get(), config); |
| } |
| |
| @Override |
| public Appender parseAppender(final String name, final String appenderPrefix, final String layoutPrefix, |
| final String filterPrefix, final Properties props, final PropertiesConfiguration configuration) { |
| Layout layout = configuration.parseLayout(layoutPrefix, name, props); |
| Filter filter = configuration.parseAppenderFilters(props, filterPrefix, name); |
| String fileName = getProperty(FILE_PARAM); |
| String level = getProperty(THRESHOLD_PARAM); |
| boolean append = getBooleanProperty(APPEND_PARAM); |
| boolean immediateFlush = false; |
| boolean bufferedIo = getBooleanProperty(BUFFERED_IO_PARAM); |
| int bufferSize = Integer.parseInt(getProperty(BUFFER_SIZE_PARAM, "8192")); |
| return createAppender(name, layout, filter, fileName, append, immediateFlush, |
| level, bufferedIo, bufferSize, configuration); |
| } |
| |
| private <T extends Log4j1Configuration> Appender createAppender(final String name, final Layout layout, |
| final Filter filter, final String fileName, final boolean append, boolean immediateFlush, |
| final String level, final boolean bufferedIo, final int bufferSize, final T configuration) { |
| |
| org.apache.logging.log4j.core.Layout<?> fileLayout = null; |
| if (bufferedIo) { |
| immediateFlush = true; |
| } |
| if (layout instanceof LayoutWrapper) { |
| fileLayout = ((LayoutWrapper) layout).getLayout(); |
| } else if (layout != null) { |
| fileLayout = new LayoutAdapter(layout); |
| } |
| org.apache.logging.log4j.core.Filter fileFilter = buildFilters(level, filter); |
| if (fileName == null) { |
| LOGGER.warn("Unable to create File Appender, no file name provided"); |
| return null; |
| } |
| String filePattern = fileName +"%d{yyy-MM-dd}"; |
| TriggeringPolicy policy = TimeBasedTriggeringPolicy.newBuilder().setModulate(true).build(); |
| RolloverStrategy strategy = DefaultRolloverStrategy.newBuilder() |
| .setConfig(configuration) |
| .setMax(Integer.toString(Integer.MAX_VALUE)) |
| .build(); |
| return new AppenderWrapper(RollingFileAppender.newBuilder() |
| .setName(name) |
| .setConfiguration(configuration) |
| .setLayout(fileLayout) |
| .setFilter(fileFilter) |
| .setFileName(fileName) |
| .setBufferSize(bufferSize) |
| .setImmediateFlush(immediateFlush) |
| .setFilePattern(filePattern) |
| .setPolicy(policy) |
| .setStrategy(strategy) |
| .build()); |
| } |
| } |
