Module org.elasticsearch.xcore

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

Class RoleDescriptor

java.lang.Object

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

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class RoleDescriptor
extends Object
implements ToXContentObject, Writeable

A holder for a Role that contains user-readable information about the Role without containing the actual Role object.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RoleDescriptor.ApplicationResourcePrivileges
static interface	RoleDescriptor.Fields
static class	RoleDescriptor.IndicesPrivileges	A class representing permissions for a group of indices mapped to privileges, field permissions, and a query.
static final record	RoleDescriptor.Parser
static final class	RoleDescriptor.RemoteIndicesPrivileges
static class	RoleDescriptor.Restriction

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

Modifier and Type	Field	Description
static final String	ROLE_TYPE
static final TransportVersion	SECURITY_ROLE_DESCRIPTION

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
RoleDescriptor(String name, String[] clusterPrivileges, RoleDescriptor.IndicesPrivileges[] indicesPrivileges, String[] runAs)
RoleDescriptor(String name, String[] clusterPrivileges, RoleDescriptor.IndicesPrivileges[] indicesPrivileges, String[] runAs, Map<String,Object> metadata)	Deprecated. Use RoleDescriptor(String, String[], IndicesPrivileges[], ApplicationResourcePrivileges[], ConfigurableClusterPrivilege[], String[], Map, Map, RemoteIndicesPrivileges[], RemoteClusterPermissions, Restriction, String)
RoleDescriptor(String name, String[] clusterPrivileges, RoleDescriptor.IndicesPrivileges[] indicesPrivileges, String[] runAs, Map<String,Object> metadata, Map<String,Object> transientMetadata)	Deprecated. Use RoleDescriptor(String, String[], IndicesPrivileges[], ApplicationResourcePrivileges[], ConfigurableClusterPrivilege[], String[], Map, Map, RemoteIndicesPrivileges[], RemoteClusterPermissions, Restriction, String)
RoleDescriptor(String name, String[] clusterPrivileges, RoleDescriptor.IndicesPrivileges[] indicesPrivileges, RoleDescriptor.ApplicationResourcePrivileges[] applicationPrivileges, ConfigurableClusterPrivilege[] configurableClusterPrivileges, String[] runAs, Map<String,Object> metadata, Map<String,Object> transientMetadata)
RoleDescriptor(String name, String[] clusterPrivileges, RoleDescriptor.IndicesPrivileges[] indicesPrivileges, RoleDescriptor.ApplicationResourcePrivileges[] applicationPrivileges, ConfigurableClusterPrivilege[] configurableClusterPrivileges, String[] runAs, Map<String,Object> metadata, Map<String,Object> transientMetadata, RoleDescriptor.RemoteIndicesPrivileges[] remoteIndicesPrivileges, RemoteClusterPermissions remoteClusterPermissions, RoleDescriptor.Restriction restriction, String description)
RoleDescriptor(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
RoleDescriptor.ApplicationResourcePrivileges[]	getApplicationPrivileges()
String[]	getClusterPrivileges()
ConfigurableClusterPrivilege[]	getConditionalClusterPrivileges()
String	getDescription()
RoleDescriptor.IndicesPrivileges[]	getIndicesPrivileges()
Map<String,Object>	getMetadata()
String	getName()
RemoteClusterPermissions	getRemoteClusterPermissions()
RoleDescriptor.RemoteIndicesPrivileges[]	getRemoteIndicesPrivileges()
RoleDescriptor.Restriction	getRestriction()
String[]	getRunAs()
Map<String,Object>	getTransientMetadata()
boolean	hasApplicationPrivileges()
boolean	hasClusterPrivileges()
boolean	hasConfigurableClusterPrivileges()
boolean	hasDescription()
int	hashCode()
boolean	hasRemoteClusterPermissions()
boolean	hasRemoteIndicesPrivileges()
boolean	hasRestriction()
boolean	hasRunAs()
boolean	hasUnsupportedPrivilegesInsideAPIKeyConnectedRemoteCluster()
boolean	hasWorkflowsRestriction()
XContentBuilder	innerToXContent(XContentBuilder builder, ToXContent.Params params, boolean docCreation)	Generates x-content for this RoleDescriptor instance.
boolean	isEmpty()
boolean	isUsingDocumentOrFieldLevelSecurity()
static RoleDescriptor.ApplicationResourcePrivileges[]	parseApplicationPrivileges(String roleName, XContentParser parser)
static RoleDescriptor.IndicesPrivileges	parseIndexWithPredefinedPrivileges(String roleName, String[] privileges, XContentParser parser)
static RoleDescriptor.IndicesPrivileges[]	parseIndices(String roleName, XContentParser parser, boolean allow2xFormat)
static AuthorizationEngine.PrivilegesToCheck	parsePrivilegesToCheck(String description, boolean runDetailedCheck, BytesReference source, XContentType xContentType)	Parses the privileges to be checked, from the same syntax used for granting privileges in a RoleDescriptor.
static AuthorizationEngine.PrivilegesToCheck	parsePrivilegesToCheck(String description, boolean runDetailedCheck, XContentParser parser)
static RoleDescriptor.Parser.Builder	parserBuilder()
static void	setFieldPermissionsCache(FieldPermissionsCache cache)
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params, boolean docCreation)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

SECURITY_ROLE_DESCRIPTION

public static final TransportVersion SECURITY_ROLE_DESCRIPTION

ROLE_TYPE

public static final String ROLE_TYPE

See Also:

• Constant Field Values

Constructor Details

RoleDescriptor

public RoleDescriptor(String name,
 @Nullable
 String[] clusterPrivileges,
 @Nullable
 RoleDescriptor.IndicesPrivileges[] indicesPrivileges,
 @Nullable
 String[] runAs)

RoleDescriptor

@Deprecated
public RoleDescriptor(String name,
 @Nullable
 String[] clusterPrivileges,
 @Nullable
 RoleDescriptor.IndicesPrivileges[] indicesPrivileges,
 @Nullable
 String[] runAs,
 @Nullable
 Map<String,Object> metadata)

Deprecated.

Use RoleDescriptor(String, String[], IndicesPrivileges[], ApplicationResourcePrivileges[], ConfigurableClusterPrivilege[], String[], Map, Map, RemoteIndicesPrivileges[], RemoteClusterPermissions, Restriction, String)

RoleDescriptor

@Deprecated
public RoleDescriptor(String name,
 @Nullable
 String[] clusterPrivileges,
 @Nullable
 RoleDescriptor.IndicesPrivileges[] indicesPrivileges,
 @Nullable
 String[] runAs,
 @Nullable
 Map<String,Object> metadata,
 @Nullable
 Map<String,Object> transientMetadata)

Deprecated.

Use RoleDescriptor(String, String[], IndicesPrivileges[], ApplicationResourcePrivileges[], ConfigurableClusterPrivilege[], String[], Map, Map, RemoteIndicesPrivileges[], RemoteClusterPermissions, Restriction, String)

RoleDescriptor

public RoleDescriptor(String name,
 @Nullable
 String[] clusterPrivileges,
 @Nullable
 RoleDescriptor.IndicesPrivileges[] indicesPrivileges,
 @Nullable
 RoleDescriptor.ApplicationResourcePrivileges[] applicationPrivileges,
 @Nullable
 ConfigurableClusterPrivilege[] configurableClusterPrivileges,
 @Nullable
 String[] runAs,
 @Nullable
 Map<String,Object> metadata,
 @Nullable
 Map<String,Object> transientMetadata)

RoleDescriptor

public RoleDescriptor(String name,
 @Nullable
 String[] clusterPrivileges,
 @Nullable
 RoleDescriptor.IndicesPrivileges[] indicesPrivileges,
 @Nullable
 RoleDescriptor.ApplicationResourcePrivileges[] applicationPrivileges,
 @Nullable
 ConfigurableClusterPrivilege[] configurableClusterPrivileges,
 @Nullable
 String[] runAs,
 @Nullable
 Map<String,Object> metadata,
 @Nullable
 Map<String,Object> transientMetadata,
 @Nullable
 RoleDescriptor.RemoteIndicesPrivileges[] remoteIndicesPrivileges,
 @Nullable
 RemoteClusterPermissions remoteClusterPermissions,
 @Nullable
 RoleDescriptor.Restriction restriction,
 @Nullable
 String description)

RoleDescriptor

public RoleDescriptor(StreamInput in)
               throws IOException

Throws:

IOException

Method Details

setFieldPermissionsCache

public static void setFieldPermissionsCache(FieldPermissionsCache cache)

getName

public String getName()

getDescription

public String getDescription()

getClusterPrivileges

public String[] getClusterPrivileges()

getConditionalClusterPrivileges

public ConfigurableClusterPrivilege[] getConditionalClusterPrivileges()

getIndicesPrivileges

public RoleDescriptor.IndicesPrivileges[] getIndicesPrivileges()

getRemoteIndicesPrivileges

public RoleDescriptor.RemoteIndicesPrivileges[] getRemoteIndicesPrivileges()

hasRemoteIndicesPrivileges

public boolean hasRemoteIndicesPrivileges()

hasRemoteClusterPermissions

public boolean hasRemoteClusterPermissions()

getRemoteClusterPermissions

public RemoteClusterPermissions getRemoteClusterPermissions()

getApplicationPrivileges

public RoleDescriptor.ApplicationResourcePrivileges[] getApplicationPrivileges()

hasClusterPrivileges

public boolean hasClusterPrivileges()

hasApplicationPrivileges

public boolean hasApplicationPrivileges()

hasConfigurableClusterPrivileges

public boolean hasConfigurableClusterPrivileges()

hasRunAs

public boolean hasRunAs()

hasDescription

public boolean hasDescription()

hasUnsupportedPrivilegesInsideAPIKeyConnectedRemoteCluster

public boolean hasUnsupportedPrivilegesInsideAPIKeyConnectedRemoteCluster()

getRunAs

public String[] getRunAs()

getRestriction

public RoleDescriptor.Restriction getRestriction()

hasRestriction

public boolean hasRestriction()

hasWorkflowsRestriction

public boolean hasWorkflowsRestriction()

getMetadata

public Map<String,Object> getMetadata()

getTransientMetadata

public Map<String,Object> getTransientMetadata()

isUsingDocumentOrFieldLevelSecurity

public boolean isUsingDocumentOrFieldLevelSecurity()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isEmpty

public boolean isEmpty()

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toXContent

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

Throws:

IOException

innerToXContent

public XContentBuilder innerToXContent(XContentBuilder builder,
 ToXContent.Params params,
 boolean docCreation)
                                throws IOException

Generates x-content for this RoleDescriptor instance.

Parameters:

builder - the x-content builder

params - the parameters for x-content generation directives

docCreation - true if the x-content is being generated for creating a document in the security index, false if the x-content being generated is for API display purposes

Returns:

x-content builder

Throws:

IOException - if there was an error writing the x-content to the builder

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

parserBuilder

public static RoleDescriptor.Parser.Builder parserBuilder()

parsePrivilegesToCheck

public static AuthorizationEngine.PrivilegesToCheck parsePrivilegesToCheck(String description,
 boolean runDetailedCheck,
 XContentParser parser)
                                                                    throws IOException

Throws:

IOException

parsePrivilegesToCheck

public static AuthorizationEngine.PrivilegesToCheck parsePrivilegesToCheck(String description,
 boolean runDetailedCheck,
 BytesReference source,
 XContentType xContentType)
                                                                    throws IOException

Parses the privileges to be checked, from the same syntax used for granting privileges in a RoleDescriptor.

Throws:

IOException

parseIndices

public static RoleDescriptor.IndicesPrivileges[] parseIndices(String roleName,
 XContentParser parser,
 boolean allow2xFormat)
                                                       throws IOException

Throws:

IOException

parseIndexWithPredefinedPrivileges

public static RoleDescriptor.IndicesPrivileges parseIndexWithPredefinedPrivileges(String roleName,
 String[] privileges,
 XContentParser parser)
                                                                           throws IOException

Throws:

IOException

parseApplicationPrivileges

public static RoleDescriptor.ApplicationResourcePrivileges[] parseApplicationPrivileges(String roleName,
 XContentParser parser)
                                                                                 throws IOException

Throws:

IOException