Module org.elasticsearch.xcore

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

Class ChangePasswordRequest

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.ChangePasswordRequest

All Implemented Interfaces:

WriteRequest<ChangePasswordRequest>, Writeable, RefCounted, TaskAwareRequest, TransportRequest, UserRequest

public class ChangePasswordRequest
extends UntypedActionRequest
implements UserRequest, WriteRequest<ChangePasswordRequest>

Request to change a user's password.

Nested Class Summary

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

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

Nested classes/interfaces inherited from interface org.elasticsearch.action.support.WriteRequest

WriteRequest.RefreshPolicy

Field Summary

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
ChangePasswordRequest()
ChangePasswordRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
WriteRequest.RefreshPolicy	getRefreshPolicy()	Should this request trigger a refresh (WriteRequest.RefreshPolicy.IMMEDIATE, the default), wait for a refresh ( WriteRequest.RefreshPolicy.WAIT_UNTIL), or proceed ignore refreshes entirely (WriteRequest.RefreshPolicy.NONE).
char[]	passwordHash()
void	passwordHash(char[] passwordHash)
ChangePasswordRequest	setRefreshPolicy(WriteRequest.RefreshPolicy refreshPolicy)
String	username()
void	username(String username)
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

Methods inherited from interface org.elasticsearch.action.support.WriteRequest

setRefreshPolicy

Constructor Details

ChangePasswordRequest

public ChangePasswordRequest()

ChangePasswordRequest

public ChangePasswordRequest(StreamInput in)
                      throws IOException

Throws:

IOException

Method Details

validate

public ActionRequestValidationException validate()

Specified by:

validate in interface WriteRequest<ChangePasswordRequest>

Specified by:

validate in class ActionRequest

username

public String username()

username

public void username(String username)

passwordHash

public char[] passwordHash()

passwordHash

public void passwordHash(char[] passwordHash)

getRefreshPolicy

public WriteRequest.RefreshPolicy getRefreshPolicy()

Should this request trigger a refresh (WriteRequest.RefreshPolicy.IMMEDIATE, the default), wait for a refresh ( WriteRequest.RefreshPolicy.WAIT_UNTIL), or proceed ignore refreshes entirely (WriteRequest.RefreshPolicy.NONE).

Specified by:

getRefreshPolicy in interface WriteRequest<ChangePasswordRequest>

setRefreshPolicy

public ChangePasswordRequest setRefreshPolicy(WriteRequest.RefreshPolicy refreshPolicy)

Specified by:

setRefreshPolicy in interface WriteRequest<ChangePasswordRequest>

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

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

IOException