1 /**
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18 package org.apache.hadoop.hbase.security.visibility;
19
20 import org.apache.hadoop.hbase.classification.InterfaceAudience;
21
22 @InterfaceAudience.Private
23 public interface VisibilityLabelOrdinalProvider {
24
25 /**
26 * @param label Not null label string
27 * @return The ordinal for the label. The ordinal starts from 1. Returns 0 when passed a non
28 * existing label.
29 */
30 public int getLabelOrdinal(String label);
31
32 /**
33 * Returns the string associated with the ordinal. Not be used in MR.
34 * @param ordinal representing the visibility label's ordinal
35 * @return label associated with the string, null if not found
36 */
37 public String getLabel(int ordinal);
38 }