org.apache.log4j.lf5.DefaultLF5Configurator 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.log4j.lf5;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import org.apache.log4j.PropertyConfigurator;
import org.apache.log4j.spi.Configurator;
import org.apache.log4j.spi.LoggerRepository;
/**
* The DefaultLF5Configurator provides a default
* configuration for the LF5Appender.
*
* Note: The preferred method for configuring a LF5Appender
* is to use the LF5Manager class. This class ensures
* that configuration does not occur multiple times, and improves system
* performance. Reconfiguring the monitor multiple times can result in
* unexpected behavior.
*
* @author Brent Sprecher
*/
// Contributed by ThoughtWorks Inc.
public class DefaultLF5Configurator implements Configurator {
//--------------------------------------------------------------------------
// Constants:
//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
// Protected Variables:
//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
// Private Variables:
//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
// Constructors:
//--------------------------------------------------------------------------
/**
* This class should never be instantiated! It implements the
* Configurator
* interface, but does not provide the same functionality as full
* configurator class.
*/
private DefaultLF5Configurator() {
}
//--------------------------------------------------------------------------
// Public Methods:
//--------------------------------------------------------------------------
/**
* This method configures the LF5Appender using a
* default configuration file. The default configuration file is
* defaultconfig.properties .
* @throws java.io.IOException
*/
public static void configure() throws IOException {
String resource =
"/org/apache/log4j/lf5/config/defaultconfig.properties";
URL configFileResource =
DefaultLF5Configurator.class.getResource(resource);
if (configFileResource != null) {
PropertyConfigurator.configure(configFileResource);
} else {
throw new IOException("Error: Unable to open the resource" +
resource);
}
}
/**
* This is a dummy method that will throw an
* IllegalStateException if used.
*
* @since 1.2.17
*/
public void doConfigure(InputStream inputStream, LoggerRepository repository) {
throw new IllegalStateException("This class should NOT be instantiated!");
}
/**
* This is a dummy method that will throw an
* IllegalStateException if used.
*/
public void doConfigure(URL configURL, LoggerRepository repository) {
throw new IllegalStateException("This class should NOT be instantiated!");
}
//--------------------------------------------------------------------------
// Protected Methods:
//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
// Private Methods:
//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
// Nested Top-Level Classes or Interfaces:
//--------------------------------------------------------------------------
}