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.appender;
18  
19  import org.apache.logging.log4j.Logger;
20  import org.apache.logging.log4j.core.config.AppenderRef;
21  import org.apache.logging.log4j.core.config.plugins.Plugin;
22  import org.apache.logging.log4j.core.config.plugins.PluginElement;
23  import org.apache.logging.log4j.core.config.plugins.PluginFactory;
24  import org.apache.logging.log4j.status.StatusLogger;
25  
26  /**
27   * The array of failover Appenders.
28   */
29  @Plugin(name = "failovers", category = "Core")
30  public final class FailoversPlugin {
31  
32      private static final Logger LOGGER = StatusLogger.getLogger();
33  
34      /**
35       * Prevent instantiation.
36       */
37      private FailoversPlugin() {
38      }
39  
40      /**
41       * Returns the appender references.
42       * @param refs The references to return.
43       * @return The appender references.
44       */
45      @PluginFactory
46      public static String[] createFailovers(@PluginElement("AppenderRef") final AppenderRef... refs) {
47  
48          if (refs == null) {
49              LOGGER.error("failovers must contain an appender reference");
50              return null;
51          }
52          final String[] arr = new String[refs.length];
53          for (int i = 0; i < refs.length; ++i) {
54              arr[i] = refs[i].getRef();
55          }
56          return arr;
57      }
58  }