/*
 *
 * 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.model;

import java.util.List;

import org.apache.qpid.server.logging.EventLoggerProvider;
import org.apache.qpid.server.security.auth.sasl.SaslNegotiator;
import org.apache.qpid.server.security.auth.sasl.SaslSettings;

@ManagedObject
public interface AuthenticationProvider<X extends AuthenticationProvider<X>> extends ConfiguredObject<X>,
                                                                                     EventLoggerProvider
{

    /**
     * Gets the SASL mechanisms known to this manager.
     *
     * @return SASL mechanism names, space separated.
     */
    @DerivedAttribute
    List<String> getMechanisms();


    @ManagedAttribute( defaultValue = "[ \"PLAIN\" ]")
    List<String> getSecureOnlyMechanisms();

    @ManagedAttribute( defaultValue = "[]")
    List<String> getDisabledMechanisms();

    SaslNegotiator createSaslNegotiator(String mechanism,
                                        final SaslSettings saslSettings,
                                        final NamedAddressSpace addressSpace);

    List<String> getAvailableMechanisms(boolean secure);

}