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.visibility;
019
020import org.apache.yetus.audience.InterfaceAudience;
021
022@InterfaceAudience.Private
023public interface VisibilityLabelOrdinalProvider {
024
025  /**
026   * @param label Not null label string
027   * @return The ordinal for the label. The ordinal starts from 1. Returns 0 when passed a non
028   *         existing label.
029   */
030  public int getLabelOrdinal(String label);
031
032  /**
033   * Returns the string associated with the ordinal. Not be used in MR.
034   * @param ordinal representing the visibility label's ordinal
035   * @return label associated with the string, null if not found
036   */
037  public String getLabel(int ordinal);
038}