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.security.AuthMethod;
021import org.apache.yetus.audience.InterfaceAudience;
022
023/**
024 * Base class for all Apache HBase, built-in {@link SaslAuthenticationProvider}'s to extend. HBase
025 * users should take care to note that this class (and its sub-classes) are marked with the
026 * {@code InterfaceAudience.Private} annotation. These implementations are available for users to
027 * read, copy, and modify, but should not be extended or re-used in binary form. There are no
028 * compatibility guarantees provided for implementations of this class.
029 */
030@InterfaceAudience.Private
031public abstract class BuiltInSaslAuthenticationProvider implements SaslAuthenticationProvider {
032
033  public static final String AUTH_TOKEN_TYPE = "HBASE_AUTH_TOKEN";
034
035  @Override
036  public String getTokenKind() {
037    return AUTH_TOKEN_TYPE;
038  }
039
040  protected static SaslAuthMethod createSaslAuthMethod(AuthMethod authMethod) {
041    return new SaslAuthMethod(authMethod.name(), authMethod.code, authMethod.mechanismName,
042      authMethod.authenticationMethod);
043  }
044}