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 * Base implementation of {@link SaslClientAuthenticationProvider}. All implementations should
026 * extend this class instead of directly implementing the interface.
027 */
028@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.AUTHENTICATION)
029@InterfaceStability.Evolving
030public abstract class AbstractSaslClientAuthenticationProvider implements
031        SaslClientAuthenticationProvider {
032  public static final String AUTH_TOKEN_TYPE = "HBASE_AUTH_TOKEN";
033
034
035  @Override
036  public final String getTokenKind() {
037    // All HBase authentication tokens are "HBASE_AUTH_TOKEN"'s. We differentiate between them
038    // via the code().
039    return AUTH_TOKEN_TYPE;
040  }
041
042  /**
043   * Provides a hash code to identify this AuthenticationProvider among others. These two fields
044   * must be unique to ensure that authentication methods are clearly separated.
045   */
046  @Override
047  public final int hashCode() {
048    return getSaslAuthMethod().hashCode();
049  }
050
051  @Override
052  public final boolean equals(Object o) {
053    // SaslClientAuthProviders should be unique via their hashCode().
054    if (o instanceof AbstractSaslClientAuthenticationProvider) {
055      return this.hashCode() == o.hashCode();
056    }
057    return false;
058  }
059}