org.apache.hadoop.hbase.security.visibility.VisibilityLabelOrdinalProvider Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hbase-server Show documentation

Server functionality for HBase

There is a newer version: 3.0.0-beta-1

/**
 * 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.visibility;

import org.apache.yetus.audience.InterfaceAudience;

@InterfaceAudience.Private
public interface VisibilityLabelOrdinalProvider {

  /**
   * @param label Not null label string
   * @return The ordinal for the label. The ordinal starts from 1. Returns 0 when passed a non
   *         existing label.
   */
  public int getLabelOrdinal(String label);

  /**
   * Returns the string associated with the ordinal. Not be used in MR.
   * @param ordinal representing the visibility label's ordinal
   * @return label associated with the string, null if not found
   */
  public String getLabel(int ordinal);
}