1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache license, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the license for the specific language governing permissions and
15 * limitations under the license.
16 */
17 package org.apache.logging.log4j.web;
18
19 import org.apache.logging.log4j.core.LifeCycle;
20
21 /**
22 * Specifies an interface for initializing and deinitializing Log4j in a Java EE web application. The default and only
23 * implementation is {@link Log4jWebInitializerImpl}. The initializer is based on an interface to improve testability.
24 * The methods here are contained in a package-private sub-interface because general application code should not have
25 * access to them.
26 */
27 interface Log4jWebLifeCycle extends Log4jWebSupport, LifeCycle {
28
29 /**
30 * Starts up Log4j in the web application. Calls {@link #setLoggerContext()} after initialization is complete.
31 *
32 * @throws IllegalStateException if a JNDI config location is specified but no name is specified.
33 */
34 @Override
35 void start();
36
37 /**
38 * Shuts down Log4j in the web application. Calls {@link #clearLoggerContext()} immediately before deinitialization
39 * begins.
40 */
41 @Override
42 void stop();
43 }