Module org.elasticsearch.xcore

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

Class RoleDescriptor.IndicesPrivileges

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

RoleDescriptor.IndicesPrivileges.ImplicitlyGranted

Enclosing class:

RoleDescriptor

public static class RoleDescriptor.IndicesPrivileges
extends Object
implements ToXContentObject, Writeable, Comparable<RoleDescriptor.IndicesPrivileges>

A class representing permissions for a group of indices mapped to privileges, field permissions, and a query.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RoleDescriptor.IndicesPrivileges.Builder
static final class	RoleDescriptor.IndicesPrivileges.ImplicitlyGranted	In-memory marker subclass used only when rendering the get-roles API response.

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

Modifier	Constructor	Description
	IndicesPrivileges(StreamInput in)
protected	IndicesPrivileges(RoleDescriptor.IndicesPrivileges other)	Copy constructor used by subclasses that wrap an existing instance with response-only decorations (see RoleDescriptor.IndicesPrivileges.ImplicitlyGranted).

Method Summary

Modifier and Type	Method	Description
boolean	allowRestrictedIndices()
static RoleDescriptor.IndicesPrivileges.Builder	builder()
int	compareTo(RoleDescriptor.IndicesPrivileges o)
boolean	equals(Object o)
String[]	getDeniedFields()
String[]	getGrantedFields()
String[]	getIndices()
String[]	getPrivileges()
BytesReference	getQuery()
boolean	hasDeniedFields()
boolean	hasGrantedFields()
int	hashCode()
boolean	isUsingDocumentLevelSecurity()
boolean	isUsingDocumentOrFieldLevelSecurity()
boolean	isUsingFieldLevelSecurity()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
static void	write(StreamOutput out, RoleDescriptor.IndicesPrivileges privileges)
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

Constructor Details

IndicesPrivileges

protected IndicesPrivileges(RoleDescriptor.IndicesPrivileges other)

Copy constructor used by subclasses that wrap an existing instance with response-only decorations (see RoleDescriptor.IndicesPrivileges.ImplicitlyGranted). All identity-defining state is shallow-copied; subclasses must not introduce new state that affects equality, ordering, or wire format.

IndicesPrivileges

public IndicesPrivileges(StreamInput in)
                  throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

builder

public static RoleDescriptor.IndicesPrivileges.Builder builder()

getIndices

public String[] getIndices()

getPrivileges

public String[] getPrivileges()

getGrantedFields

@Nullable
public String[] getGrantedFields()

getDeniedFields

@Nullable
public String[] getDeniedFields()

getQuery

@Nullable
public BytesReference getQuery()

isUsingDocumentLevelSecurity

public boolean isUsingDocumentLevelSecurity()

isUsingFieldLevelSecurity

public boolean isUsingFieldLevelSecurity()

isUsingDocumentOrFieldLevelSecurity

public boolean isUsingDocumentOrFieldLevelSecurity()

allowRestrictedIndices

public boolean allowRestrictedIndices()

hasDeniedFields

public boolean hasDeniedFields()

hasGrantedFields

public boolean hasGrantedFields()

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

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

write

public static void write(StreamOutput out,
 RoleDescriptor.IndicesPrivileges privileges)
                  throws IOException

Throws:

IOException

compareTo

public int compareTo(RoleDescriptor.IndicesPrivileges o)

Specified by:

compareTo in interface Comparable<RoleDescriptor.IndicesPrivileges>