Module org.elasticsearch.xcore

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

Interface ConfigurableClusterPrivilege

All Superinterfaces:

ClusterPrivilege, NamedWriteable, ToXContent, ToXContentFragment, Writeable

All Known Implementing Classes:

ConfigurableClusterPrivileges.DatasourcePrivileges, ConfigurableClusterPrivileges.ManageApplicationPrivileges, ConfigurableClusterPrivileges.ManageRolesPrivilege, ConfigurableClusterPrivileges.WriteProfileDataPrivileges

public interface ConfigurableClusterPrivilege
extends NamedWriteable, ToXContentFragment, ClusterPrivilege

A ConfigurableClusterPrivilege is a form of ClusterPrivilege that can be configured by an Elasticsearch security administrator within a RoleDescriptor.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ConfigurableClusterPrivilege.Category	Categories exist for to segment privileges for the purposes of rendering to XContent.

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

Method Summary

Modifier and Type	Method	Description
ConfigurableClusterPrivilege.Category	getCategory()	The category under which this privilege should be rendered when output as XContent.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)	A ConfigurableClusterPrivilege should generate a fragment of XContent, which consists of a single field name, followed by its value (which may be an object, an array, or a simple value).

Methods inherited from interface org.elasticsearch.xpack.core.security.authz.privilege.ClusterPrivilege

buildPermission

Methods inherited from interface org.elasticsearch.common.io.stream.NamedWriteable

getWriteableName

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Methods inherited from interface org.elasticsearch.common.io.stream.Writeable

writeTo

Method Details

getCategory

ConfigurableClusterPrivilege.Category getCategory()

The category under which this privilege should be rendered when output as XContent.

toXContent

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

A ConfigurableClusterPrivilege should generate a fragment of XContent, which consists of a single field name, followed by its value (which may be an object, an array, or a simple value).

Specified by:

toXContent in interface ToXContent

Throws:

IOException