VisibilityClient (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.security.visibility.VisibilityClient

@InterfaceAudience.Public
@InterfaceStability.Evolving
public class VisibilityClient
extends Object

Utility client for doing visibility labels admin operations.

Constructor Summary

Constructors
Constructor and Description

VisibilityClient()

Constructors
Constructor and Description
`VisibilityClient()`

Method Summary

Methods
Modifier and Type	Method and Description
`static org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.VisibilityLabelsResponse`	`addLabel(org.apache.hadoop.conf.Configuration conf, String label)` Deprecated. Use `addLabel(Connection,String)` instead.
`static org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.VisibilityLabelsResponse`	`addLabel(Connection connection, String label)` Utility method for adding label to the system.
`static org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.VisibilityLabelsResponse`	`addLabels(org.apache.hadoop.conf.Configuration conf, String[] labels)` Deprecated. Use `addLabels(Connection,String[])` instead.
`static org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.VisibilityLabelsResponse`	`addLabels(Connection connection, String[] labels)` Utility method for adding labels to the system.
`static org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.VisibilityLabelsResponse`	`clearAuths(org.apache.hadoop.conf.Configuration conf, String[] auths, String user)` Deprecated. Use `clearAuths(Connection,String[],String)` instead.
`static org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.VisibilityLabelsResponse`	`clearAuths(Connection connection, String[] auths, String user)` Removes given labels from user's globally authorized list of labels.
`static org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.GetAuthsResponse`	`getAuths(org.apache.hadoop.conf.Configuration conf, String user)` Deprecated. Use `getAuths(Connection,String)` instead.
`static org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.GetAuthsResponse`	`getAuths(Connection connection, String user)`
`static boolean`	`isCellVisibilityEnabled(Connection connection)` Return true if cell visibility features are supported and enabled
`static org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.ListLabelsResponse`	`listLabels(org.apache.hadoop.conf.Configuration conf, String regex)` Deprecated. Use `listLabels(Connection,String)` instead.
`static org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.ListLabelsResponse`	`listLabels(Connection connection, String regex)` Retrieve the list of visibility labels defined in the system.
`static org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.VisibilityLabelsResponse`	`setAuths(org.apache.hadoop.conf.Configuration conf, String[] auths, String user)` Deprecated. Use `setAuths(Connection,String[],String)` instead.
`static org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.VisibilityLabelsResponse`	`setAuths(Connection connection, String[] auths, String user)` Sets given labels globally authorized for the user.
`private static org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.VisibilityLabelsResponse`	`setOrClearAuths(Connection connection, String[] auths, String user, boolean setOrClear)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- VisibilityClient
```
public VisibilityClient()
```

Method Detail

isCellVisibilityEnabled
```
public static boolean isCellVisibilityEnabled(Connection connection)
                                       throws IOException
```
Return true if cell visibility features are supported and enabled

Parameters:
connection - The connection to use

Returns:
true if cell visibility features are supported and enabled, false otherwise

Throws:

IOException

addLabel

@Deprecated
public static org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.VisibilityLabelsResponse addLabel(org.apache.hadoop.conf.Configuration conf,
                                                                                                             String label)
                                                                                                           throws Throwable

Deprecated. Use addLabel(Connection,String) instead.

Utility method for adding label to the system.

Parameters:: conf -; label -
Returns:: VisibilityLabelsResponse
Throws:: Throwable

addLabel

public static org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.VisibilityLabelsResponse addLabel(Connection connection,
                                                                                                  String label)
                                                                                                           throws Throwable

Utility method for adding label to the system.

Parameters:: connection -; label -
Returns:: VisibilityLabelsResponse
Throws:: Throwable

addLabels

@Deprecated
public static org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.VisibilityLabelsResponse addLabels(org.apache.hadoop.conf.Configuration conf,
                                                                                                              String[] labels)
                                                                                                            throws Throwable

Deprecated. Use addLabels(Connection,String[]) instead.

Utility method for adding labels to the system.

Parameters:: conf -; labels -
Returns:: VisibilityLabelsResponse
Throws:: Throwable

addLabels

public static org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.VisibilityLabelsResponse addLabels(Connection connection,
                                                                                                   String[] labels)
                                                                                                            throws Throwable

Utility method for adding labels to the system.

Parameters:: connection -; labels -
Returns:: VisibilityLabelsResponse
Throws:: Throwable

setAuths

@Deprecated
public static org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.VisibilityLabelsResponse setAuths(org.apache.hadoop.conf.Configuration conf,
                                                                                                             String[] auths,
                                                                                                             String user)
                                                                                                           throws Throwable

Deprecated. Use setAuths(Connection,String[],String) instead.

Sets given labels globally authorized for the user.

Parameters:: conf -; auths -; user -
Returns:: VisibilityLabelsResponse
Throws:: Throwable

setAuths

public static org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.VisibilityLabelsResponse setAuths(Connection connection,
                                                                                                  String[] auths,
                                                                                                  String user)
                                                                                                           throws Throwable

Sets given labels globally authorized for the user.

Parameters:: connection -; auths -; user -
Returns:: VisibilityLabelsResponse
Throws:: Throwable

getAuths

@Deprecated
public static org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.GetAuthsResponse getAuths(org.apache.hadoop.conf.Configuration conf,
                                                                                                     String user)
                                                                                                   throws Throwable

Deprecated. Use getAuths(Connection,String) instead.

Parameters:: conf -; user -
Returns:: labels, the given user is globally authorized for.
Throws:: Throwable

getAuths

public static org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.GetAuthsResponse getAuths(Connection connection,
                                                                                          String user)
                                                                                                   throws Throwable

Parameters:: connection - the Connection instance to use.; user -
Returns:: labels, the given user is globally authorized for.
Throws:: Throwable

listLabels

@Deprecated
public static org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.ListLabelsResponse listLabels(org.apache.hadoop.conf.Configuration conf,
                                                                                                         String regex)
                                                                                                       throws Throwable

Deprecated. Use listLabels(Connection,String) instead.

Retrieve the list of visibility labels defined in the system.

Parameters:: conf -; regex - The regular expression to filter which labels are returned.
Returns:: labels The list of visibility labels defined in the system.
Throws:: Throwable

listLabels

public static org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.ListLabelsResponse listLabels(Connection connection,
                                                                                              String regex)
                                                                                                       throws Throwable

Retrieve the list of visibility labels defined in the system.

Parameters:: connection - The Connection instance to use.; regex - The regular expression to filter which labels are returned.
Returns:: labels The list of visibility labels defined in the system.
Throws:: Throwable

clearAuths

@Deprecated
public static org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.VisibilityLabelsResponse clearAuths(org.apache.hadoop.conf.Configuration conf,
                                                                                                               String[] auths,
                                                                                                               String user)
                                                                                                             throws Throwable

Deprecated. Use clearAuths(Connection,String[],String) instead.

Removes given labels from user's globally authorized list of labels.

Parameters:: conf -; auths -; user -
Returns:: VisibilityLabelsResponse
Throws:: Throwable

clearAuths

public static org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.VisibilityLabelsResponse clearAuths(Connection connection,
                                                                                                    String[] auths,
                                                                                                    String user)
                                                                                                             throws Throwable

Removes given labels from user's globally authorized list of labels.

Parameters:: connection -; auths -; user -
Returns:: VisibilityLabelsResponse
Throws:: Throwable

setOrClearAuths

private static org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.VisibilityLabelsResponse setOrClearAuths(Connection connection,
                                                                                                         String[] auths,
                                                                                                         String user,
                                                                                                         boolean setOrClear)
                                                                                                                   throws IOException,
                                                                                                                          com.google.protobuf.ServiceException,
                                                                                                                          Throwable

Throws:: IOException; com.google.protobuf.ServiceException; Throwable

Class VisibilityClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VisibilityClient

Method Detail

isCellVisibilityEnabled

addLabel

addLabel

addLabels

addLabels

setAuths

setAuths

getAuths

getAuths

listLabels

listLabels

clearAuths

clearAuths

setOrClearAuths