com.marklogic.client.io

Interface DocumentMetadataHandle.DocumentPermissions

All Superinterfaces:

java.util.Map<java.lang.String,java.util.Set<DocumentMetadataHandle.Capability>>

Enclosing class:

DocumentMetadataHandle

public static interface DocumentMetadataHandle.DocumentPermissions
extends java.util.Map<java.lang.String,java.util.Set<DocumentMetadataHandle.Capability>>

Represents the permissions for a database document.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String role, DocumentMetadataHandle.Capability... capabilities) Adds a role with one or more capabilities to the metadata that can be written for the document.
void	addFromDelimitedString(java.lang.String commaDelimitedRolesAndCapabilities) Adds one or more permissions based on the given comma-delimited string.

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

add

void add(java.lang.String role,
         DocumentMetadataHandle.Capability... capabilities)

Adds a role with one or more capabilities to the metadata that can be written for the document.

Parameters:

role - the role for users permitted to access the document

capabilities - the permissions to be granted to users with the role

addFromDelimitedString

void addFromDelimitedString(java.lang.String commaDelimitedRolesAndCapabilities)

Adds one or more permissions based on the given comma-delimited string. Each capability value is case-insensitive; you do not need to worry about providing the correct case. Similar to add, this method adds permissions and can thus add capabilities to roles already present in this object. For example, the following string would add two permissions - a "read" permission for "rest-reader" and an "update" permission for "rest-writer": rest-reader,read,rest-writer,update.

Parameters:

commaDelimitedRolesAndCapabilities - comma-delimited string of the pattern: role1,capability1,role2,capability2,etc.

Since:

6.3.0