org.elasticsearch.rest.action.support

Class RestActions

java.lang.Object

org.elasticsearch.rest.action.support.RestActions

public class RestActions
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestActions.NodesResponseRestListener<NodesResponse extends BaseNodesResponse & ToXContent> NodesResponseRestBuilderListener automatically translates any BaseNodesResponse (multi-node) response that is ToXContent-compatible into a RestResponse with the necessary header info (e.g., "cluster_name").

Constructor Summary

Constructors

Constructor and Description
RestActions()

Method Summary

Modifier and Type	Method and Description
static void	buildBroadcastShardsHeader(XContentBuilder builder, ToXContent.Params params, BroadcastResponse response)
static void	buildBroadcastShardsHeader(XContentBuilder builder, ToXContent.Params params, int total, int successful, int failed, ShardOperationFailedException[] shardFailures)
static <NodeResponse extends BaseNodeResponse> void	buildNodesHeader(XContentBuilder builder, ToXContent.Params params, BaseNodesResponse<NodeResponse> response) Create the XContent header for any BaseNodesResponse.
static void	buildNodesHeader(XContentBuilder builder, ToXContent.Params params, int total, int successful, int failed, java.util.List<FailedNodeException> failures) Create the XContent header for any BaseNodesResponse.
static QueryBuilder	getQueryContent(BytesReference source, IndicesQueriesRegistry indicesQueriesRegistry, ParseFieldMatcher parseFieldMatcher)
static BytesReference	getRestContent(RestRequest request) Get Rest content from either payload or source parameter
static XContentType	guessBodyContentType(RestRequest request) guesses the content type from either payload or source parameter
static boolean	hasBodyContent(RestRequest request) Returns true if either payload or source parameter is present.
static <NodesResponse extends BaseNodesResponse & ToXContent> BytesRestResponse	nodesResponse(XContentBuilder builder, ToXContent.Params params, NodesResponse response) Automatically transform the ToXContent-compatible, nodes-level response into a a BytesRestResponse.
static long	parseVersion(RestRequest request)
static long	parseVersion(RestRequest request, long defaultVersion)
static QueryBuilder	urlParamsToQueryBuilder(RestRequest request)

Methods inherited from class java.lang.Object

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

Constructor Detail

RestActions

public RestActions()

Method Detail

parseVersion

public static long parseVersion(RestRequest request)

parseVersion

public static long parseVersion(RestRequest request,
                                long defaultVersion)

buildBroadcastShardsHeader

public static void buildBroadcastShardsHeader(XContentBuilder builder,
                                              ToXContent.Params params,
                                              BroadcastResponse response)
                                       throws java.io.IOException

Throws:

java.io.IOException

buildBroadcastShardsHeader

public static void buildBroadcastShardsHeader(XContentBuilder builder,
                                              ToXContent.Params params,
                                              int total,
                                              int successful,
                                              int failed,
                                              ShardOperationFailedException[] shardFailures)
                                       throws java.io.IOException

Throws:

java.io.IOException

buildNodesHeader

public static <NodeResponse extends BaseNodeResponse> void buildNodesHeader(XContentBuilder builder,
                                                                            ToXContent.Params params,
                                                                            BaseNodesResponse<NodeResponse> response)
                                                                     throws java.io.IOException

Create the XContent header for any BaseNodesResponse.

Parameters:

builder - XContent builder.

params - XContent parameters.

response - The response containing individual, node-level responses.

Throws:

java.io.IOException

See Also:

#buildNodesHeader(XContentBuilder, Params, int, int, int, List)

buildNodesHeader

public static void buildNodesHeader(XContentBuilder builder,
                                    ToXContent.Params params,
                                    int total,
                                    int successful,
                                    int failed,
                                    java.util.List<FailedNodeException> failures)
                             throws java.io.IOException

Create the XContent header for any BaseNodesResponse. This looks like: "_nodes" : { "total" : 3, "successful" : 1, "failed" : 2, "failures" : [ { ... }, { ... } ] } Prefer the overload that properly invokes this method to calling this directly.

Parameters:

builder - XContent builder.

params - XContent parameters.

total - The total number of nodes touched.

successful - The successful number of responses received.

failed - The number of failures (effectively total - successful).

failures - The failure exceptions related to failed.

Throws:

java.io.IOException

See Also:

#buildNodesHeader(XContentBuilder, Params, BaseNodesResponse)

nodesResponse

public static <NodesResponse extends BaseNodesResponse & ToXContent> BytesRestResponse nodesResponse(XContentBuilder builder,
                                                                                                     ToXContent.Params params,
                                                                                                     NodesResponse response)
                                                                                              throws java.io.IOException

Automatically transform the ToXContent-compatible, nodes-level response into a a BytesRestResponse.

This looks like: { "_nodes" : { ... }, "cluster_name" : "...", ... }

Parameters:

builder - XContent builder.

params - XContent parameters.

response - The nodes-level (plural) response.

Returns:

Never null.

Throws:

java.io.IOException - if building the response causes an issue

urlParamsToQueryBuilder

public static QueryBuilder urlParamsToQueryBuilder(RestRequest request)

getRestContent

public static BytesReference getRestContent(RestRequest request)

Get Rest content from either payload or source parameter

Parameters:

request - Rest request

Returns:

rest content

getQueryContent

public static QueryBuilder getQueryContent(BytesReference source,
                                           IndicesQueriesRegistry indicesQueriesRegistry,
                                           ParseFieldMatcher parseFieldMatcher)

guessBodyContentType

public static XContentType guessBodyContentType(RestRequest request)

guesses the content type from either payload or source parameter

Parameters:

request - Rest request

Returns:

rest content type or null if not applicable.

hasBodyContent

public static boolean hasBodyContent(RestRequest request)

Returns true if either payload or source parameter is present. Otherwise false