001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017package org.apache.logging.log4j.core.appender;
018
019import org.apache.logging.log4j.Logger;
020import org.apache.logging.log4j.core.Core;
021import org.apache.logging.log4j.core.config.AppenderRef;
022import org.apache.logging.log4j.core.config.plugins.Plugin;
023import org.apache.logging.log4j.core.config.plugins.PluginElement;
024import org.apache.logging.log4j.core.config.plugins.PluginFactory;
025import org.apache.logging.log4j.status.StatusLogger;
026
027/**
028 * The array of failover Appenders.
029 */
030@Plugin(name = "failovers", category = Core.CATEGORY_NAME)
031public final class FailoversPlugin {
032
033    private static final Logger LOGGER = StatusLogger.getLogger();
034
035    /**
036     * Prevent instantiation.
037     */
038    private FailoversPlugin() {
039    }
040
041    /**
042     * Returns the appender references.
043     * @param refs The references to return.
044     * @return The appender references.
045     */
046    @PluginFactory
047    public static String[] createFailovers(@PluginElement("AppenderRef") final AppenderRef... refs) {
048
049        if (refs == null) {
050            LOGGER.error("failovers must contain an appender reference");
051            return null;
052        }
053        final String[] arr = new String[refs.length];
054        for (int i = 0; i < refs.length; ++i) {
055            arr[i] = refs[i].getRef();
056        }
057        return arr;
058    }
059}