com.foreach.common.spring.logging.Log4JConfigurator Maven / Gradle / Ivy
/*
* Copyright 2014 the original author or authors
*
* 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 com.foreach.common.spring.logging;
import org.apache.commons.lang3.StringUtils;
import org.apache.log4j.PropertyConfigurator;
import org.springframework.core.io.Resource;
import java.io.IOException;
import java.net.URL;
/**
* The Log4JConfigurator bean can be used to configure log4j settings in Spring.
* It takes the path to the log4j properties file, and the directory where logfiles should be written.
* The directory is then configured as system property log.dir so it can also be used
* in the log4j properties file.
* Log4J is configured when the configure method of the bean is called.
* Example use in spring configuration file:
*
* <bean class="com.foreach.spring.logging.Log4JConfigurator" init-method="configure" lazy-init="false">
* <property name="propertiesFile" value="classpath:/config/log.properties"/>
* <property name="logDirectory" value="/project-logging-dir"/>
* </bean>
*
* Example excerpt of log.properties (depends on apache-log4j-extras):
*
* log4j.appender.logfile=org.apache.log4j.rolling.RollingFileAppender
* log4j.appender.logfile.rollingPolicy=org.apache.log4j.rolling.TimeBasedRollingPolicy
* log4j.appender.logfile.rollingPolicy.FileNamePattern=${log.dir}/logfile-%d{yyyy-MM-dd}.log
*
*
* @author Pavan K. Parankusam, Arne Vandamme
* @version 1.0
*/
public class Log4JConfigurator
{
private String logDirectory = System.getProperty( "java.io.tmpdir" );
private Resource propertiesFile = null;
/**
* Configures Log4J using a PropertyConfigurator and the properties file set on the bean.
*
* @throws java.io.IOException if something goes wrong with reading the properties file.
*/
public final void configure() throws IOException {
if ( propertiesFile != null ) {
URL url = propertiesFile.getURL();
PropertyConfigurator.configure( url );
}
}
/**
* Getter for the field propertiesFile.
*
* @return a {@link org.springframework.core.io.Resource} object.
*/
public final Resource getPropertiesFile() {
return propertiesFile;
}
/**
* Setter for the Log4J configuration file (properties format).
*
* @param location a {@link org.springframework.core.io.Resource} object.
*/
public final void setPropertiesFile( Resource location ) {
this.propertiesFile = location;
}
/**
* Getter for the field logDirectory.
*
* @return a {@link java.lang.String} object.
*/
public final String getLogDirectory() {
return logDirectory;
}
/**
* Setter for the field logDirectory. This value will be exposed to the Log4J properties file
* using the system property log.dir.
*
* @param logDirectory a {@link java.lang.String} object.
*/
public final void setLogDirectory( String logDirectory ) {
if ( StringUtils.isNotBlank( logDirectory ) ) {
this.logDirectory = logDirectory;
// Allow log4j properties file to use this property
System.setProperty( "log.dir", this.logDirectory );
}
}
}