org.apache.hadoop.hbase.security.provider.SaslAuthenticationProvider Maven / Gradle / Ivy
/*
* 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.hadoop.hbase.security.provider;
import org.apache.hadoop.hbase.HBaseInterfaceAudience;
import org.apache.yetus.audience.InterfaceAudience;
import org.apache.yetus.audience.InterfaceStability;
/**
* Encapsulation of client-side logic to authenticate to HBase via some means over SASL. It is
* suggested that custom implementations extend the abstract class in the type hierarchy instead of
* directly implementing this interface (clients have a base class available, but servers presently
* do not). Implementations of this interface must be unique among each other via the
* {@code byte} returned by {@link SaslAuthMethod#getCode()} on {@link #getSaslAuthMethod()}.
*/
@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.AUTHENTICATION)
@InterfaceStability.Evolving
public interface SaslAuthenticationProvider {
/**
* Returns the attributes which identify how this provider authenticates.
*/
SaslAuthMethod getSaslAuthMethod();
/**
* Returns the name of the type used by the TokenIdentifier.
*/
String getTokenKind();
}