@InterfaceAudience.Public @InterfaceStability.Evolving public interface VisibilityLabelService
Modifier and Type | Method and Description |
---|---|
OperationStatus[] |
addLabels(java.util.List<byte[]> labels)
Adds the set of labels into the system.
|
OperationStatus[] |
clearAuths(byte[] user,
java.util.List<byte[]> authLabels)
Removes given labels from user's globally authorized list of labels.
|
java.util.List<Tag> |
createVisibilityExpTags(java.lang.String visExpression,
boolean withSerializationFormat,
boolean checkAuths)
Creates tags corresponding to given visibility expression.
|
byte[] |
encodeVisibilityForReplication(java.util.List<Tag> visTags,
java.lang.Byte serializationFormat)
Provides a way to modify the visibility tags of type
TagType
.VISIBILITY_TAG_TYPE, that are part of the cell created from the WALEdits
that are prepared for replication while calling
ReplicationEndpoint
.replicate(). |
java.util.List<java.lang.String> |
getAuths(byte[] user,
boolean systemCall)
Deprecated.
|
java.util.List<java.lang.String> |
getGroupAuths(java.lang.String[] groups,
boolean systemCall)
Retrieve the visibility labels for the groups.
|
java.util.List<java.lang.String> |
getUserAuths(byte[] user,
boolean systemCall)
Retrieve the visibility labels for the user.
|
VisibilityExpEvaluator |
getVisibilityExpEvaluator(Authorizations authorizations)
Creates VisibilityExpEvaluator corresponding to given Authorizations.
|
boolean |
havingSystemAuth(byte[] user)
Deprecated.
|
boolean |
havingSystemAuth(User user)
System checks for user auth during admin operations.
|
void |
init(RegionCoprocessorEnvironment e)
System calls this after opening of regions.
|
java.util.List<java.lang.String> |
listLabels(java.lang.String regex)
Retrieve the list of visibility labels defined in the system.
|
boolean |
matchVisibility(java.util.List<Tag> putVisTags,
java.lang.Byte putVisTagFormat,
java.util.List<Tag> deleteVisTags,
java.lang.Byte deleteVisTagFormat)
System uses this for deciding whether a Cell can be deleted by matching visibility expression
in Delete mutation and the cell in consideration.
|
OperationStatus[] |
setAuths(byte[] user,
java.util.List<byte[]> authLabels)
Sets given labels globally authorized for the user.
|
void init(RegionCoprocessorEnvironment e) throws java.io.IOException
e
- the region coprocessor envjava.io.IOException
OperationStatus[] addLabels(java.util.List<byte[]> labels) throws java.io.IOException
labels
- Labels to add to the system.java.io.IOException
OperationStatus[] setAuths(byte[] user, java.util.List<byte[]> authLabels) throws java.io.IOException
user
- The authorizing userauthLabels
- Labels which are getting authorized for the userjava.io.IOException
OperationStatus[] clearAuths(byte[] user, java.util.List<byte[]> authLabels) throws java.io.IOException
user
- The user whose authorization to be removedauthLabels
- Labels which are getting removed from authorization setjava.io.IOException
@Deprecated java.util.List<java.lang.String> getAuths(byte[] user, boolean systemCall) throws java.io.IOException
getUserAuths(byte[], boolean)
user
- Name of the user whose authorization to be retrievedsystemCall
- Whether a system or user originated call.java.io.IOException
java.util.List<java.lang.String> getUserAuths(byte[] user, boolean systemCall) throws java.io.IOException
user
- Name of the user whose authorization to be retrievedsystemCall
- Whether a system or user originated call.java.io.IOException
java.util.List<java.lang.String> getGroupAuths(java.lang.String[] groups, boolean systemCall) throws java.io.IOException
groups
- Name of the groups whose authorization to be retrievedsystemCall
- Whether a system or user originated call.java.io.IOException
java.util.List<java.lang.String> listLabels(java.lang.String regex) throws java.io.IOException
regex
- The regular expression to filter which labels are returned.java.io.IOException
java.util.List<Tag> createVisibilityExpTags(java.lang.String visExpression, boolean withSerializationFormat, boolean checkAuths) throws java.io.IOException
visExpression
- The Expression for which corresponding Tags to be created.withSerializationFormat
- specifies whether a tag, denoting the serialization version
of the tags, to be added in the list. When this is true make sure to add the
serialization format Tag also. The format tag value should be byte type.checkAuths
- denotes whether to check individual labels in visExpression against user's
global auth label.java.io.IOException
VisibilityExpEvaluator getVisibilityExpEvaluator(Authorizations authorizations) throws java.io.IOException
authorizations
- Authorizations for the read requestjava.io.IOException
@Deprecated boolean havingSystemAuth(byte[] user) throws java.io.IOException
havingSystemAuth(User)
user
- User for whom system auth check to be done.java.io.IOException
boolean havingSystemAuth(User user) throws java.io.IOException
user
- User for whom system auth check to be done.java.io.IOException
boolean matchVisibility(java.util.List<Tag> putVisTags, java.lang.Byte putVisTagFormat, java.util.List<Tag> deleteVisTags, java.lang.Byte deleteVisTagFormat) throws java.io.IOException
putVisTags
- The visibility tags present in the Put mutationputVisTagFormat
- The serialization format for the Put visibility tags. A null
value for
this format means the tags are written with unsorted label ordinalsdeleteVisTags
- - The visibility tags in the delete mutation (the specified Cell Visibility)deleteVisTagFormat
- The serialization format for the Delete visibility tags. A null
value for
this format means the tags are written with unsorted label ordinalsjava.io.IOException
VisibilityConstants.SORTED_ORDINAL_SERIALIZATION_FORMAT
byte[] encodeVisibilityForReplication(java.util.List<Tag> visTags, java.lang.Byte serializationFormat) throws java.io.IOException
TagType
.VISIBILITY_TAG_TYPE, that are part of the cell created from the WALEdits
that are prepared for replication while calling
ReplicationEndpoint
.replicate().
VisibilityReplicationEndpoint
calls this API to provide an opportunity to modify the visibility tags
before replicating.visTags
- the visibility tags associated with the cellserializationFormat
- the serialization format associated with the tagjava.io.IOException