View Javadoc

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.core.config;
18  
19  import java.util.Locale;
20  
21  import org.apache.logging.log4j.Level;
22  import org.apache.logging.log4j.Logger;
23  import org.apache.logging.log4j.core.Filter;
24  import org.apache.logging.log4j.core.config.plugins.Plugin;
25  import org.apache.logging.log4j.core.config.plugins.PluginAttr;
26  import org.apache.logging.log4j.core.config.plugins.PluginElement;
27  import org.apache.logging.log4j.core.config.plugins.PluginFactory;
28  import org.apache.logging.log4j.status.StatusLogger;
29  
30  /**
31   * An Appender reference.
32   */
33  @Plugin(name = "appender-ref", type = "Core", printObject = true)
34  public final class AppenderRef {
35      private static final Logger LOGGER = StatusLogger.getLogger();
36  
37      private final String ref;
38      private final Level level;
39      private final Filter filter;
40  
41      private AppenderRef(String ref, Level level, Filter filter) {
42          this.ref = ref;
43          this.level = level;
44          this.filter = filter;
45      }
46  
47      public String getRef() {
48          return ref;
49      }
50  
51      public Level getLevel() {
52          return level;
53      }
54  
55      public Filter getFilter() {
56          return filter;
57      }
58  
59      /**
60       * Create an Appender reference.
61       * @param ref The name of the Appender.
62       * @param levelName The Level to filter against.
63       * @param filter The filter(s) to use.
64       * @return The name of the Appender.
65       */
66      @PluginFactory
67      public static AppenderRef createAppenderRef(@PluginAttr("ref") String ref,
68                                                  @PluginAttr("level") String levelName,
69                                                  @PluginElement("filters") Filter filter) {
70  
71          if (ref == null) {
72              LOGGER.error("Appender references must contain a reference");
73              return null;
74          }
75          Level level = null;
76  
77          if (levelName != null) {
78              level = Level.toLevel(levelName, null);
79              if (level == null) {
80                  LOGGER.error("Invalid level " + levelName + " on Appender reference " + ref);
81              }
82          }
83  
84          return new AppenderRef(ref, level, filter);
85      }
86  }