Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.security.authz.permission

Class IndicesPermission.Builder

java.lang.Object

org.elasticsearch.xpack.core.security.authz.permission.IndicesPermission.Builder

Enclosing class:

IndicesPermission

public static class IndicesPermission.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder(RestrictedIndices restrictedIndices)

Method Summary

Modifier and Type	Method	Description
IndicesPermission.Builder	addGroup(IndexPrivilege privilege, FieldPermissions fieldPermissions, Set<BytesReference> query, boolean allowRestrictedIndices, boolean implicitlyGranted, String... indices)	Adds a group to the permission.
IndicesPermission.Builder	addGroup(IndexPrivilege privilege, FieldPermissions fieldPermissions, Set<BytesReference> query, boolean allowRestrictedIndices, String... indices)	Adds an explicitly-granted group.
IndicesPermission	build()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(RestrictedIndices restrictedIndices)

Method Details

addGroup

public IndicesPermission.Builder addGroup(IndexPrivilege privilege,
 FieldPermissions fieldPermissions,
 @Nullable
 Set<BytesReference> query,
 boolean allowRestrictedIndices,
 String... indices)

Adds an explicitly-granted group. Equivalent to addGroup(IndexPrivilege, FieldPermissions, Set, boolean, boolean, String...) with implicitlyGranted=false.

addGroup

public IndicesPermission.Builder addGroup(IndexPrivilege privilege,
 FieldPermissions fieldPermissions,
 @Nullable
 Set<BytesReference> query,
 boolean allowRestrictedIndices,
 boolean implicitlyGranted,
 String... indices)

Adds a group to the permission. When implicitlyGranted is true, the group is marked as having been contributed by an ImplicitPrivilegesProvider SPI implementation rather than declared in a role definition. The flag flows through to the resulting IndicesAccessControl.IndexAccessControl (via IndicesPermission.authorize(java.lang.String, java.util.Set<java.lang.String>, org.elasticsearch.cluster.metadata.ProjectMetadata, org.elasticsearch.xpack.core.security.authz.permission.FieldPermissionsCache)) and gates whether downstream DLS/FLS license enforcement and feature-usage tracking apply: implicit grants bypass them; explicit grants do not.

build

public IndicesPermission build()