org.apache.hadoop.hbase.security.visibility

Class VisibilityLabelsCache

java.lang.Object

org.apache.hadoop.hbase.security.visibility.VisibilityLabelsCache

All Implemented Interfaces:

VisibilityLabelOrdinalProvider

@InterfaceAudience.Private
public class VisibilityLabelsCache
extends java.lang.Object
implements VisibilityLabelOrdinalProvider

Maintains the cache for visibility labels and also uses the zookeeper to update the labels in the system. The cache updation happens based on the data change event that happens on the zookeeper znode for labels table

Method Summary

Modifier and Type	Method and Description
static VisibilityLabelsCache	createAndGet(ZooKeeperWatcher watcher, Configuration conf) Creates the singleton instance, if not yet present, and returns the same.
static VisibilityLabelsCache	get()
java.util.List<java.lang.String>	getGroupAuths(java.lang.String[] groups)
java.util.Set<java.lang.Integer>	getGroupAuthsAsOrdinals(java.lang.String[] groups) Returns the list of ordinals of labels associated with the groups
java.lang.String	getLabel(int ordinal) Returns the string associated with the ordinal.
int	getLabelOrdinal(java.lang.String label)
int	getLabelsCount()
java.util.List<java.lang.String>	getUserAuths(java.lang.String user)
java.util.Set<java.lang.Integer>	getUserAuthsAsOrdinals(java.lang.String user) Returns the list of ordinals of labels associated with the user
void	refreshLabelsCache(byte[] data)
void	refreshUserAuthsCache(byte[] data)
void	writeToZookeeper(byte[] data, boolean labelsOrUserAuths)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createAndGet

public static VisibilityLabelsCache createAndGet(ZooKeeperWatcher watcher,
                                                 Configuration conf)
                                          throws java.io.IOException

Creates the singleton instance, if not yet present, and returns the same.

Parameters:

watcher -

conf -

Returns:

Singleton instance of VisibilityLabelsCache

Throws:

java.io.IOException

get

public static VisibilityLabelsCache get()

Returns:

Singleton instance of VisibilityLabelsCache

Throws:

java.lang.IllegalStateException - when this is called before calling createAndGet(ZooKeeperWatcher, Configuration)

refreshLabelsCache

public void refreshLabelsCache(byte[] data)
                        throws java.io.IOException

Throws:

java.io.IOException

refreshUserAuthsCache

public void refreshUserAuthsCache(byte[] data)
                           throws java.io.IOException

Throws:

java.io.IOException

getLabelOrdinal

public int getLabelOrdinal(java.lang.String label)

Specified by:

getLabelOrdinal in interface VisibilityLabelOrdinalProvider

Parameters:

label - Not null label string

Returns:

The ordinal for the label. The ordinal starts from 1. Returns 0 when passed a non existing label.

getLabel

public java.lang.String getLabel(int ordinal)

Description copied from interface: VisibilityLabelOrdinalProvider

Returns the string associated with the ordinal. Not be used in MR.

Specified by:

getLabel in interface VisibilityLabelOrdinalProvider

Parameters:

ordinal - The ordinal of label which we are looking for.

Returns:

The label having the given ordinal. Returns null when no label exist in the system with given ordinal

getLabelsCount

public int getLabelsCount()

Returns:

The total number of visibility labels.

getUserAuths

public java.util.List<java.lang.String> getUserAuths(java.lang.String user)

getGroupAuths

public java.util.List<java.lang.String> getGroupAuths(java.lang.String[] groups)

getUserAuthsAsOrdinals

public java.util.Set<java.lang.Integer> getUserAuthsAsOrdinals(java.lang.String user)

Returns the list of ordinals of labels associated with the user

Parameters:

user - Not null value.

Returns:

the list of ordinals

getGroupAuthsAsOrdinals

public java.util.Set<java.lang.Integer> getGroupAuthsAsOrdinals(java.lang.String[] groups)

Returns the list of ordinals of labels associated with the groups

Parameters:

groups -

Returns:

the list of ordinals

writeToZookeeper

public void writeToZookeeper(byte[] data,
                             boolean labelsOrUserAuths)
                      throws java.io.IOException

Throws:

java.io.IOException