org.elasticsearch.test.rest

Class RestTestExecutionContext

java.lang.Object

org.elasticsearch.test.rest.RestTestExecutionContext

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class RestTestExecutionContext
extends java.lang.Object
implements java.io.Closeable

Execution context passed across the REST tests. Holds the REST client used to communicate with elasticsearch. Caches the last obtained test response and allows to stash part of it within variables that can be used as input values in following requests.

Constructor Summary

Constructors

Constructor and Description
RestTestExecutionContext(RestSpec restSpec)

Method Summary

Modifier and Type	Method and Description
RestResponse	callApi(java.lang.String apiName, java.util.Map<java.lang.String,java.lang.String> params, java.util.List<java.util.Map<java.lang.String,java.lang.Object>> bodies, java.util.Map<java.lang.String,java.lang.String> headers) Calls an elasticsearch api with the parameters and request body provided as arguments.
void	clear() Clears the last obtained response and the stashed fields
void	close() Closes the execution context and releases the underlying resources
org.elasticsearch.Version	esVersion() Returns the current es version as a string
void	initClient(java.net.URL[] urls, org.elasticsearch.common.settings.Settings settings) Creates the embedded REST client when needed.
java.lang.Object	response(java.lang.String path) Extracts a specific value from the last saved response
Stash	stash()

Methods inherited from class java.lang.Object

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

Constructor Detail

RestTestExecutionContext

public RestTestExecutionContext(RestSpec restSpec)

Method Detail

callApi

public RestResponse callApi(java.lang.String apiName,
                            java.util.Map<java.lang.String,java.lang.String> params,
                            java.util.List<java.util.Map<java.lang.String,java.lang.Object>> bodies,
                            java.util.Map<java.lang.String,java.lang.String> headers)
                     throws java.io.IOException,
                            RestException

Calls an elasticsearch api with the parameters and request body provided as arguments. Saves the obtained response in the execution context.

Throws:

RestException - if the returned status code is non ok

java.io.IOException

response

public java.lang.Object response(java.lang.String path)
                          throws java.io.IOException

Extracts a specific value from the last saved response

Throws:

java.io.IOException

initClient

public void initClient(java.net.URL[] urls,
                       org.elasticsearch.common.settings.Settings settings)
                throws java.io.IOException,
                       RestException

Creates the embedded REST client when needed. Needs to be called before each test.

Throws:

java.io.IOException

RestException

clear

public void clear()

Clears the last obtained response and the stashed fields

stash

public Stash stash()

esVersion

public org.elasticsearch.Version esVersion()

Returns the current es version as a string

close

public void close()

Closes the execution context and releases the underlying resources

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable