Package org.opensearch.action.support.single.instance

Class TransportInstanceSingleOperationAction<Request extends InstanceShardOperationRequest<Request>,Response extends ActionResponse>

java.lang.Object

org.opensearch.action.support.TransportAction<Request,Response>

org.opensearch.action.support.HandledTransportAction<Request,Response>

org.opensearch.action.support.single.instance.TransportInstanceSingleOperationAction<Request,Response>

Direct Known Subclasses:

TransportUpdateAction

public abstract class TransportInstanceSingleOperationAction<Request extends InstanceShardOperationRequest<Request>,Response extends ActionResponse>
extends HandledTransportAction<Request,Response>

Field Summary

Fields

Modifier and Type	Field	Description
protected ClusterService	clusterService
protected IndexNameExpressionResolver	indexNameExpressionResolver
protected ThreadPool	threadPool
protected TransportService	transportService

Fields inherited from class org.opensearch.action.support.TransportAction

actionName, logger, taskManager

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TransportInstanceSingleOperationAction(java.lang.String actionName, ThreadPool threadPool, ClusterService clusterService, TransportService transportService, ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver, Writeable.Reader<Request> request)

Method Summary

Modifier and Type	Method	Description
protected ClusterBlockException	checkGlobalBlock(ClusterState state)
protected ClusterBlockException	checkRequestBlock(ClusterState state, Request request)
protected void	doExecute(Task task, Request request, ActionListener<Response> listener)
protected abstract java.lang.String	executor(ShardId shardId)
protected abstract Response	newResponse(StreamInput in)
protected abstract void	resolveRequest(ClusterState state, Request request)	Resolves the request.
protected boolean	retryOnFailure(java.lang.Exception e)
protected abstract void	shardOperation(Request request, ActionListener<Response> listener)
protected abstract ShardIterator	shards(ClusterState clusterState, Request request)	Should return an iterator with a single shard!
protected TransportRequestOptions	transportOptions()

Methods inherited from class org.opensearch.action.support.TransportAction

execute, execute, execute

Methods inherited from class java.lang.Object

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

Field Details

threadPool

protected final ThreadPool threadPool

clusterService

protected final ClusterService clusterService

transportService

protected final TransportService transportService

indexNameExpressionResolver

protected final IndexNameExpressionResolver indexNameExpressionResolver

Constructor Details

TransportInstanceSingleOperationAction

protected TransportInstanceSingleOperationAction(java.lang.String actionName, ThreadPool threadPool, ClusterService clusterService, TransportService transportService, ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver, Writeable.Reader<Request> request)

Method Details

doExecute

protected void doExecute(Task task, Request request, ActionListener<Response> listener)

Specified by:

doExecute in class TransportAction<Request extends InstanceShardOperationRequest<Request>,Response extends ActionResponse>

executor

protected abstract java.lang.String executor(ShardId shardId)

shardOperation

protected abstract void shardOperation(Request request, ActionListener<Response> listener)

newResponse

protected abstract Response newResponse(StreamInput in) throws java.io.IOException

Throws:

java.io.IOException

checkGlobalBlock

protected ClusterBlockException checkGlobalBlock(ClusterState state)

checkRequestBlock

protected ClusterBlockException checkRequestBlock(ClusterState state, Request request)

resolveRequest

protected abstract void resolveRequest(ClusterState state, Request request)

Resolves the request. Throws an exception if the request cannot be resolved.

retryOnFailure

protected boolean retryOnFailure(java.lang.Exception e)

transportOptions

protected TransportRequestOptions transportOptions()

shards

protected abstract ShardIterator shards(ClusterState clusterState, Request request)

Should return an iterator with a single shard!