001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.security.provider;
019
020import java.util.Collection;
021import org.apache.hadoop.conf.Configuration;
022import org.apache.hadoop.hbase.HBaseInterfaceAudience;
023import org.apache.hadoop.hbase.security.User;
024import org.apache.hadoop.hbase.util.Pair;
025import org.apache.hadoop.security.token.Token;
026import org.apache.hadoop.security.token.TokenIdentifier;
027import org.apache.yetus.audience.InterfaceAudience;
028import org.apache.yetus.audience.InterfaceStability;
029
030@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.AUTHENTICATION)
031@InterfaceStability.Evolving
032public interface AuthenticationProviderSelector {
033
034  /**
035   * Initializes the implementation with configuration and a set of providers available.
036   * <p>
037   * This method is called once upon construction, before {@link #selectProvider(String, User)} is
038   * invoked.
039   */
040  void configure(Configuration conf,
041    Collection<SaslClientAuthenticationProvider> availableProviders);
042
043  /**
044   * Chooses the authentication provider which should be used given the provided client context from
045   * the authentication providers passed in via {@link #configure(Configuration, Collection)}.
046   */
047  Pair<SaslClientAuthenticationProvider, Token<? extends TokenIdentifier>>
048    selectProvider(String clusterId, User user);
049}