Module org.elasticsearch.server

Package org.elasticsearch.action.support.master

Class TermOverridingMasterNodeRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.AbstractTransportRequest

org.elasticsearch.action.support.master.TermOverridingMasterNodeRequest

All Implemented Interfaces:

Writeable, RefCounted, TaskAwareRequest, TransportRequest

public class TermOverridingMasterNodeRequest
extends AbstractTransportRequest

Wrapper around a MasterNodeRequest for use when sending the request to another node, overriding the MasterNodeRequest.masterTerm() sent out over the wire.

Note that in production this is only used for sending the request out, so there's no need to preserve other marker interfaces such as IndicesRequest or IndicesRequest.Replaceable on the wrapped request. The receiving node will deserialize a request without a wrapper, with the correct interfaces and the appropriate master term stored directly in MasterNodeRequest.masterTerm(). However in tests sometimes we want to intercept the request as it's being sent, for which it may be necessary to use the test utility MasterNodeRequestHelper#unwrapTermOverride to remove the wrapper and access the inner request.

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

Method Summary

Modifier and Type	Method	Description
Task	createTask(long id, String type, String action, TaskId parentTaskId, Map<String,String> headers)	Returns the task object that should be used to keep track of the processing of the request.
boolean	decRef()	Note that the lifetime of an outbound TransportMessage lasts at least until it has been fully sent over the network, and it may be closed on a network thread in a context in which there's a risk of stack overflows if on close it calls back into the network layer in a manner that might end up nesting too deeply.
String	getDescription()	Returns optional description of the request to be displayed by the task manager
TaskId	getParentTask()	Get a reference to the task that created this request.
long	getRequestId()	Gets the request ID.
boolean	hasReferences()
void	incRef()
InetSocketAddress	remoteAddress()
void	remoteAddress(InetSocketAddress remoteAddress)
void	setParentTask(String parentTaskNode, long parentTaskId)	Set a reference to task that caused this task to be run.
void	setParentTask(TaskId taskId)	Set a reference to task that created this request.
void	setRequestId(long requestId)	Set the request ID of this request.
String	toString()
boolean	tryIncRef()
final void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

mustIncRef

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask

Method Details

createTask

public Task createTask(long id,
 String type,
 String action,
 TaskId parentTaskId,
 Map<String,String> headers)

Description copied from interface: TaskAwareRequest

Returns the task object that should be used to keep track of the processing of the request.

getDescription

public String getDescription()

Description copied from interface: TaskAwareRequest

Returns optional description of the request to be displayed by the task manager

remoteAddress

public void remoteAddress(InetSocketAddress remoteAddress)

Specified by:

remoteAddress in interface TransportRequest

Overrides:

remoteAddress in class AbstractTransportRequest

remoteAddress

public InetSocketAddress remoteAddress()

Specified by:

remoteAddress in interface TransportRequest

Overrides:

remoteAddress in class AbstractTransportRequest

incRef

public void incRef()

Specified by:

incRef in interface RefCounted

Overrides:

incRef in class TransportMessage

tryIncRef

public boolean tryIncRef()

Specified by:

tryIncRef in interface RefCounted

Overrides:

tryIncRef in class TransportMessage

decRef

public boolean decRef()

Description copied from class: TransportMessage

Note that the lifetime of an outbound TransportMessage lasts at least until it has been fully sent over the network, and it may be closed on a network thread in a context in which there's a risk of stack overflows if on close it calls back into the network layer in a manner that might end up nesting too deeply. When in doubt, dispatch any further work onto a separate thread.

Specified by:

decRef in interface RefCounted

Overrides:

decRef in class TransportMessage

hasReferences

public boolean hasReferences()

Specified by:

hasReferences in interface RefCounted

Overrides:

hasReferences in class TransportMessage

setParentTask

public void setParentTask(String parentTaskNode,
 long parentTaskId)

Description copied from interface: TaskAwareRequest

Set a reference to task that caused this task to be run.

setParentTask

public void setParentTask(TaskId taskId)

Description copied from class: AbstractTransportRequest

Set a reference to task that created this request.

Specified by:

setParentTask in interface TaskAwareRequest

Overrides:

setParentTask in class AbstractTransportRequest

getParentTask

public TaskId getParentTask()

Description copied from class: AbstractTransportRequest

Get a reference to the task that created this request. Defaults to TaskId.EMPTY_TASK_ID, meaning "there is no parent".

Specified by:

getParentTask in interface TaskAwareRequest

Overrides:

getParentTask in class AbstractTransportRequest

setRequestId

public void setRequestId(long requestId)

Description copied from class: AbstractTransportRequest

Set the request ID of this request.

Specified by:

setRequestId in interface TaskAwareRequest

Overrides:

setRequestId in class AbstractTransportRequest

getRequestId

public long getRequestId()

Description copied from interface: TaskAwareRequest

Gets the request ID. Defaults to -1, meaning "no request ID is set".

Specified by:

getRequestId in interface TaskAwareRequest

Overrides:

getRequestId in class AbstractTransportRequest

writeTo

public final void writeTo(StreamOutput out)
                   throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class AbstractTransportRequest

Throws:

IOException

toString

public String toString()

Overrides:

toString in class AbstractTransportRequest