Module org.elasticsearch.xcore

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

Class RoleDescriptor.IndicesPrivileges.ImplicitlyGranted

java.lang.Object

org.elasticsearch.xpack.core.security.authz.RoleDescriptor.IndicesPrivileges

org.elasticsearch.xpack.core.security.authz.RoleDescriptor.IndicesPrivileges.ImplicitlyGranted

All Implemented Interfaces:

Comparable<RoleDescriptor.IndicesPrivileges>, Writeable, ToXContent, ToXContentObject

Enclosing class:

RoleDescriptor.IndicesPrivileges

public static final class RoleDescriptor.IndicesPrivileges.ImplicitlyGranted
extends RoleDescriptor.IndicesPrivileges

In-memory marker subclass used only when rendering the get-roles API response. It carries no extra state and inherits RoleDescriptor.IndicesPrivileges.hashCode(), RoleDescriptor.IndicesPrivileges.compareTo(org.elasticsearch.xpack.core.security.authz.RoleDescriptor.IndicesPrivileges), and RoleDescriptor.IndicesPrivileges.writeTo(org.elasticsearch.common.io.stream.StreamOutput) unchanged from its parent. The implicit-grant marker is therefore not serialized over the wire and not persisted to the .security index.

The marker is surfaced exclusively via toXContent(org.elasticsearch.xcontent.XContentBuilder, org.elasticsearch.xcontent.ToXContent.Params), which appends an "implicitly_granted": true field to the rendered indices privilege entry. There is no parser support for this field; PUT requests that include it will be rejected as an unknown field by RoleDescriptor.parseIndex(java.lang.String, org.elasticsearch.xcontent.XContentParser, boolean).

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.core.security.authz.RoleDescriptor.IndicesPrivileges

RoleDescriptor.IndicesPrivileges.Builder, RoleDescriptor.IndicesPrivileges.ImplicitlyGranted

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ImplicitlyGranted(RoleDescriptor.IndicesPrivileges base)

Method Summary

Modifier and Type	Method	Description
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class org.elasticsearch.xpack.core.security.authz.RoleDescriptor.IndicesPrivileges

allowRestrictedIndices, builder, compareTo, equals, getDeniedFields, getGrantedFields, getIndices, getPrivileges, getQuery, hasDeniedFields, hasGrantedFields, hashCode, isUsingDocumentLevelSecurity, isUsingDocumentOrFieldLevelSecurity, isUsingFieldLevelSecurity, toString, write, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

ImplicitlyGranted

public ImplicitlyGranted(RoleDescriptor.IndicesPrivileges base)

Method Details

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Overrides:

toXContent in class RoleDescriptor.IndicesPrivileges

Throws:

IOException