hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/security/token/OzoneBlockTokenSelector.java

/**
 * 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.hdds.security.token;

import org.apache.hadoop.hdds.annotation.InterfaceAudience;
import org.apache.hadoop.io.Text;
import org.apache.hadoop.security.token.Token;
import org.apache.hadoop.security.token.TokenIdentifier;
import org.apache.hadoop.security.token.TokenSelector;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.Collection;

/**
 * A block token selector for Ozone.
 */
@InterfaceAudience.Private
public class OzoneBlockTokenSelector implements
    TokenSelector<OzoneBlockTokenIdentifier> {

  private static final Logger LOG = LoggerFactory
      .getLogger(OzoneBlockTokenSelector.class);

  @Override
  @SuppressWarnings("unchecked")
  public Token<OzoneBlockTokenIdentifier> selectToken(Text service,
      Collection<Token<? extends TokenIdentifier>> tokens) {
    if (service == null) {
      return null;
    }
    for (Token<? extends TokenIdentifier> token : tokens) {
      if (OzoneBlockTokenIdentifier.KIND_NAME.equals(token.getKind())
          && token.getService().equals(service)) {
        if (LOG.isTraceEnabled()) {
          LOG.trace("Getting token for service:{}", service);
        }
        return (Token<OzoneBlockTokenIdentifier>) token;
      }
    }
    return null;
  }

  /**
   * Static method to avoid instantiation.
   * */
  @SuppressWarnings("unchecked")
  public static Token<OzoneBlockTokenIdentifier> selectBlockToken(Text service,
      Collection<Token<? extends TokenIdentifier>> tokens) {
    if (service == null) {
      return null;
    }
    for (Token<? extends TokenIdentifier> token : tokens) {
      if (OzoneBlockTokenIdentifier.KIND_NAME.equals(token.getKind())
          && token.getService().equals(service)) {
        if (LOG.isTraceEnabled()) {
          LOG.trace("Getting token for service:{}", service);
        }
        return (Token<OzoneBlockTokenIdentifier>) token;
      }
    }
    return null;
  }
}