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 org.apache.hadoop.hbase.HBaseInterfaceAudience;
021import org.apache.yetus.audience.InterfaceAudience;
022import org.apache.yetus.audience.InterfaceStability;
023
024/**
025 * Encapsulation of client-side logic to authenticate to HBase via some means over SASL.
026 * It is suggested that custom implementations extend the abstract class in the type hierarchy
027 * instead of directly implementing this interface (clients have a base class available, but
028 * servers presently do not).
029 *
030 * Implementations of this interface <b>must</b> be unique among each other via the {@code byte}
031 * returned by {@link SaslAuthMethod#getCode()} on {@link #getSaslAuthMethod()}.
032 */
033@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.AUTHENTICATION)
034@InterfaceStability.Evolving
035public interface SaslAuthenticationProvider {
036
037  /**
038   * Returns the attributes which identify how this provider authenticates.
039   */
040  SaslAuthMethod getSaslAuthMethod();
041
042  /**
043   * Returns the name of the type used by the TokenIdentifier.
044   */
045  String getTokenKind();
046}