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