java/broker/src/main/java/org/apache/qpid/server/security/access/plugins/LegacyAccess.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */
package org.apache.qpid.server.security.access.plugins;

import org.apache.commons.configuration.Configuration;
import org.apache.commons.configuration.ConfigurationException;

import org.apache.qpid.server.configuration.plugins.ConfigurationPlugin;
import org.apache.qpid.server.configuration.plugins.ConfigurationPluginFactory;
import org.apache.qpid.server.security.SecurityPluginFactory;

import java.util.Arrays;
import java.util.List;

/**
 * The <code>LegacyAccess</code> plugin is used internally and  simply ignores legacy elements of the configuration file.
 */
public class LegacyAccess extends BasicPlugin
{
    public static class LegacyAccessConfiguration extends ConfigurationPlugin {
        public static final ConfigurationPluginFactory FACTORY = new ConfigurationPluginFactory()
        {
            public List<String> getParentPaths()
            {
                return Arrays.asList("security.msg-auth", "virtualhosts.virtualhost.security.msg-auth");
            }

            public ConfigurationPlugin newInstance(String path, Configuration config) throws ConfigurationException
            {
                ConfigurationPlugin instance = new LegacyAccessConfiguration();
                instance.setConfiguration(path, config);
                return instance;
            }
        };
        
        public String[] getElementsProcessed()
        {
            return new String[] { "" };
        }
    }
    
    public static final SecurityPluginFactory<LegacyAccess> FACTORY = new SecurityPluginFactory<LegacyAccess>()
    {
        public LegacyAccess newInstance(ConfigurationPlugin config) throws ConfigurationException
        {
            LegacyAccessConfiguration configuration = config.getConfiguration(LegacyAccessConfiguration.class.getName());

            // If there is no configuration for this plugin then don't load it.
            if (configuration == null)
            {
                return null;
            }

            LegacyAccess plugin = new LegacyAccess();
            plugin.configure(configuration);
            return plugin;
        }

        public String getPluginName()
        {
            return LegacyAccess.class.getName();
        }

        public Class<LegacyAccess> getPluginClass()
        {
            return LegacyAccess.class;
        }
    };
    
}