Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.security.action.user

Class HasPrivilegesRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.AbstractTransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.UntypedActionRequest

org.elasticsearch.xpack.core.security.action.user.HasPrivilegesRequest

All Implemented Interfaces:

Writeable, RefCounted, TaskAwareRequest, TransportRequest, UserRequest

public class HasPrivilegesRequest
extends UntypedActionRequest
implements UserRequest

A request for checking a user's privileges

Nested Class Summary

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.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
HasPrivilegesRequest()
HasPrivilegesRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
RoleDescriptor.ApplicationResourcePrivileges[]	applicationPrivileges()
void	applicationPrivileges(RoleDescriptor.ApplicationResourcePrivileges... appPrivileges)
String[]	clusterPrivileges()
void	clusterPrivileges(String... privileges)
AuthorizationEngine.PrivilegesToCheck	getPrivilegesToCheck()
RoleDescriptor.IndicesPrivileges[]	indexPrivileges()
void	indexPrivileges(RoleDescriptor.IndicesPrivileges... privileges)
void	privilegesToCheck(AuthorizationEngine.PrivilegesToCheck privilegesToCheck)
String	username()
void	username(String username)	Set the username that the request applies to.
String[]	usernames()	Accessor for the usernames that this request pertains to.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.AbstractTransportRequest

copyFieldsFrom, getParentTask, getRequestId, remoteAddress, remoteAddress, setParentTask, setRequestId, toString

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.core.RefCounted

decRef, hasReferences, incRef, mustIncRef, tryIncRef

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, createTask, getDescription, setParentTask

Constructor Details

HasPrivilegesRequest

public HasPrivilegesRequest()

HasPrivilegesRequest

public HasPrivilegesRequest(StreamInput in)
                     throws IOException

Throws:

IOException

Method Details

getPrivilegesToCheck

public AuthorizationEngine.PrivilegesToCheck getPrivilegesToCheck()

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

username

public String username()

Returns:

the username that this request applies to.

username

public void username(String username)

Set the username that the request applies to. Must not be null

usernames

public String[] usernames()

Description copied from interface: UserRequest

Accessor for the usernames that this request pertains to. null should never be returned!

Specified by:

usernames in interface UserRequest

indexPrivileges

public RoleDescriptor.IndicesPrivileges[] indexPrivileges()

clusterPrivileges

public String[] clusterPrivileges()

applicationPrivileges

public RoleDescriptor.ApplicationResourcePrivileges[] applicationPrivileges()

indexPrivileges

public void indexPrivileges(RoleDescriptor.IndicesPrivileges... privileges)

clusterPrivileges

public void clusterPrivileges(String... privileges)

applicationPrivileges

public void applicationPrivileges(RoleDescriptor.ApplicationResourcePrivileges... appPrivileges)

privilegesToCheck

public void privilegesToCheck(AuthorizationEngine.PrivilegesToCheck privilegesToCheck)

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

IOException