org.apache.juneau.rest.mock2

Class MockRestClient

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContext

org.apache.juneau.rest.client2.RestClient

org.apache.juneau.rest.mock2.MockRestClient

All Implemented Interfaces:

Closeable, AutoCloseable, HttpClient, HttpClientConnection, HttpConnection, MetaProvider, RestCallHandler, RestCallInterceptor

public class MockRestClient
extends RestClient
implements HttpClientConnection

Mocked RestClient.

This class is used for performing serverless unit testing of @Rest-annotated and @Remote-annotated classes.

The class itself extends from RestClient providing it with the rich feature set of that API and combines it with the Apache HttpClient HttpClientConnection interface for processing requests. The class converts HttpRequest objects to instances of MockServletRequest and MockServletResponse which are passed directly to the call handler on the resource class RestContext.execute(HttpServletRequest,HttpServletResponse). In effect, you're fully testing your REST API as if it were running in a live servlet container, yet not actually having to run in a servlet container. All aspects of the client and server side code are tested, yet no servlet container is required. The actual over-the-wire transmission is the only aspect being bypassed.

The following shows a simple example of invoking a PUT method on a simple REST interface and asserting the correct status code and response body:

Example:

public class MockTest { // A simple bean with one field. public static class MyBean { public int foo = 1; } // Our REST resource to test. // Simply echos the response. @Rest( serializers=SimpleJsonSerializer.class, parsers=JsonParser.class ) public static class EchoRest { @RestMethod( name=PUT, path="/echo" ) public MyBean echo(@Body MyBean bean) { return bean; } } // Our JUnit test. @Test public void testEcho() throws Exception { MyBean myBean = new MyBean(); // Do a round-trip on the bean through the REST interface myBean = MockRestClient .create(EchoRest.class) .simpleJson() .build() .put("/echo", myBean) .run() .assertStatus().is(200) .assertBody().is("{foo:1}") .getBody().as(MyBean.class); assertEquals(1, myBean.foo); } }

Breaking apart the fluent method call above will help you understand how this works.

@Test public void testEcho() throws Exception { // Instantiate our mock client. MockRestClient client = MockRestClient .create(EchoRest.class) .simpleJson() .build(); // Create a request. RestRequest req = client.put("/echo", myBean); // Execute it (by calling RestCallHandler.service(...) and then returning the response object). RestResponse res = req.run(); // Run assertion tests on the results. res.assertStatus().is(200); res.assertBody().is("'foo'"); // Convert the body of the response to a bean. myBean = res.getBody().as(MyBean.class); }

The create(Object) method can take in either Class objects or pre-instantiated beans. The latter is particularly useful for testing Spring beans.

The MockRestRequest object has convenience methods provided to allow you to set any properties directly on the underlying HttpServletRequest object. The following example shows how this can be used to directly set roles on the request object to perform security testing.

Example:

@Rest(roleGuard="ADMIN") public class A { @RestMethod public String get() { return "OK"; } } @Test public void mytest() throws Exception { MockRestClient a = MockRestClient.build(A.class); // Admin user should get 200, but anyone else should get 403-Unauthorized. a.get().roles("ADMIN").run().assertStatus().is(200); a.get().roles("USER").run().assertStatus().is(403); }

Debug mode is provided that will cause your HTTP requests and responses to be sent to the console:

Example:

MockRestClient mr = MockRestClient .create(MyRest.class) .debug() .simpleJson() .build();

The class can also be used for testing of @Remote-annotated interfaces against @Rest-annotated resources.

Example:

// Our remote resource to test. @Remote public interface MyRemoteInterface { @RemoteMethod(httpMethod="GET", path="/echoQuery") public int echoQuery(@Query(name="id") int id); } // Our mocked-up REST interface to test against. @Rest public class MyRest { @RestMethod(name=GET, path="/echoQuery") public int echoQuery(@Query("id") String id) { return id; } } @Test public void testProxy() { MyRemoteInterface mri = MockRestClient .create(MyRest.class) .json() .build() .getRemote(MyRemoteInterface.class); assertEquals(123, mri.echoQuery(123)); }

• Overview > juneau-rest-mock

Field Summary

Fields

Modifier and Type	Field and Description
static String	MOCKRESTCLIENT_contextPath
static String	MOCKRESTCLIENT_mockHttpClientConnectionManager
static String	MOCKRESTCLIENT_pathVars
static String	MOCKRESTCLIENT_restBean
static String	MOCKRESTCLIENT_restBeanCtx
static String	MOCKRESTCLIENT_servletPath

Fields inherited from class org.apache.juneau.rest.client2.RestClient

RESTCLIENT_callHandler, RESTCLIENT_console, RESTCLIENT_errorCodes, RESTCLIENT_executorService, RESTCLIENT_executorServiceShutdownOnClose, RESTCLIENT_formData, RESTCLIENT_headers, RESTCLIENT_ignoreErrors, RESTCLIENT_interceptors, RESTCLIENT_interceptors_add, RESTCLIENT_keepHttpClientOpen, RESTCLIENT_leakDetection, RESTCLIENT_logger, RESTCLIENT_logRequests, RESTCLIENT_logRequestsLevel, RESTCLIENT_logRequestsPredicate, RESTCLIENT_logToConsole, RESTCLIENT_parsers, RESTCLIENT_partParser, RESTCLIENT_partSerializer, RESTCLIENT_query, RESTCLIENT_rootUri, RESTCLIENT_serializers

Fields inherited from class org.apache.juneau.BeanContext

BEAN_annotations, BEAN_beanClassVisibility, BEAN_beanConstructorVisibility, BEAN_beanDictionary, BEAN_beanDictionary_add, BEAN_beanDictionary_remove, BEAN_beanFieldVisibility, BEAN_beanFilters, BEAN_beanFilters_add, BEAN_beanFilters_remove, BEAN_beanMapPutReturnsOldValue, BEAN_beanMethodVisibility, BEAN_beansRequireDefaultConstructor, BEAN_beansRequireSerializable, BEAN_beansRequireSettersForGetters, BEAN_beansRequireSomeProperties, BEAN_bpi, BEAN_bpro, BEAN_bpwo, BEAN_bpx, BEAN_examples, BEAN_excludeProperties, BEAN_fluentSetters, BEAN_ignoreInvocationExceptionsOnGetters, BEAN_ignoreInvocationExceptionsOnSetters, BEAN_ignorePropertiesWithoutSetters, BEAN_ignoreTransientFields, BEAN_ignoreUnknownBeanProperties, BEAN_ignoreUnknownNullBeanProperties, BEAN_implClasses, BEAN_includeProperties, BEAN_notBeanClasses, BEAN_notBeanClasses_add, BEAN_notBeanClasses_remove, BEAN_notBeanPackages, BEAN_notBeanPackages_add, BEAN_notBeanPackages_remove, BEAN_pojoSwaps, BEAN_pojoSwaps_add, BEAN_pojoSwaps_remove, BEAN_propertyNamer, BEAN_sortProperties, BEAN_swaps, BEAN_swaps_add, BEAN_swaps_remove, BEAN_typePropertyName, BEAN_useEnumNames, BEAN_useInterfaceProxies, BEAN_useJavaBeanIntrospector, DEFAULT, DEFAULT_SORTED

Fields inherited from class org.apache.juneau.Context

CONTEXT_debug, CONTEXT_locale, CONTEXT_mediaType, CONTEXT_timeZone

Constructor Summary

Constructors

Constructor and Description
MockRestClient(PropertyStore ps) Constructor.

Method Summary

Modifier and Type	Method and Description
static MockRestClient	build(Object impl) Creates a new RestClient with no registered serializer or parser.
static MockRestClient	buildJson(Object impl) Creates a new RestClient with JSON marshalling support.
static MockRestClient	buildJsonLax(Object impl) Creates a new RestClient with JSON marshalling support.
static MockRestClient	buildLax(Object impl) Creates a new RestClient with no registered serializer or parser.
static MockRestClient	buildSimpleJson(Object impl) Creates a new RestClient with Simplified-JSON marshalling support.
static MockRestClient	buildSimpleJsonLax(Object impl) Creates a new RestClient with Simplified-JSON marshalling support.
MockRestRequest	callback(String callString) Performs a REST call where the entire call is specified in a simple string.
void	close() Calls Closeable.close() on the underlying CloseableHttpClient.
static MockRestClientBuilder	create(Object impl) Creates a new RestClientBuilder configured with the specified REST implementation bean or bean class.
static MockRestClientBuilder	createLax(Object impl) Creates a new RestClientBuilder configured with the specified REST implementation bean or bean class.
protected MockRestRequest	createRequest(URI uri, String method, boolean hasBody) Creates a RestRequest object from the specified HttpRequest object.
protected MockRestResponse	createResponse(RestRequest req, HttpResponse httpResponse, Parser parser) Creates a RestResponse object from the specified HttpResponse object.
MockRestRequest	delete(Object url) Perform a DELETE request against the specified URI.
void	flush()
MockRestRequest	formPost(Object url) Same as RestClient.formPost(Object, Object) but doesn't specify the input yet.
MockRestRequest	formPost(Object url, Object body) Perform a POST request with a content type of application/x-www-form-urlencoded against the specified URI.
MockRestRequest	formPostPairs(Object url, Object... parameters) Perform a POST request with a content type of application/x-www-form-urlencoded against the specified URI.
MockRestRequest	get() Perform a GET request against the root URI.
MockRestRequest	get(Object url) Perform a GET request against the specified URI.
HttpRequest	getCurrentClientRequest() Returns the current client-side REST request.
MockRestResponse	getCurrentClientResponse() Returns the current client-side REST response.
MockServletRequest	getCurrentServerRequest() Returns the current server-side REST request.
MockServletResponse	getCurrentServerResponse() Returns the current server-side REST response.
HttpConnectionMetrics	getMetrics()
int	getSocketTimeout()
MockRestRequest	head(Object url) Perform a HEAD request against the specified URI.
boolean	isOpen()
boolean	isResponseAvailable(int timeout)
boolean	isStale()
MockRestRequest	options(Object url) Perform an OPTIONS request against the specified URI.
MockRestRequest	patch(Object url) Same as RestClient.patch(Object, Object) but don't specify the input yet.
MockRestRequest	patch(Object url, Object body) Perform a PATCH request against the specified URI.
MockRestRequest	patch(Object url, String body, String contentType) Perform a PATCH request against the specified URI as a plain text body bypassing the serializer.
MockRestRequest	post(Object url) Same as RestClient.post(Object, Object) but don't specify the input yet.
MockRestRequest	post(Object url, Object body) Perform a POST request against the specified URI.
MockRestRequest	post(Object url, String body, String contentType) Perform a POST request against the specified URI as a plain text body bypassing the serializer.
MockRestRequest	put(Object url) Same as RestClient.put(Object, Object) but don't specify the input yet.
MockRestRequest	put(Object url, Object body) Perform a PUT request against the specified URI.
MockRestRequest	put(Object url, String body, String contentType) Perform a PUT request against the specified URI using a plain text body bypassing the serializer.
void	receiveResponseEntity(HttpResponse response)
HttpResponse	receiveResponseHeader()
MockRestRequest	request(String method, Object url) Perform a generic REST call.
MockRestRequest	request(String method, Object url, boolean hasBody) Perform a generic REST call.
MockRestRequest	request(String method, Object url, Object body) Perform a generic REST call.
void	sendRequestEntity(HttpEntityEnclosingRequest request)
void	sendRequestHeader(HttpRequest request)
void	setSocketTimeout(int timeout)
void	shutdown()

Methods inherited from class org.apache.juneau.rest.client2.RestClient

builder, closeQuietly, create, execute, execute, execute, execute, execute, execute, execute, execute, finalize, getConnectionManager, getParams, getRemote, getRemote, getRemote, getRrpcInterface, getRrpcInterface, getRrpcInterface, log, log, onClose, onConnect, onInit, run, toMap

Methods inherited from class org.apache.juneau.BeanContext

_class, createBeanSession, createBeanSession, createDefaultBeanSessionArgs, createDefaultSessionArgs, createSession, createSession, createSession, dumpCacheStats, getAnnotations, getAnnotations, getAnnotations, getAnnotations, getAnnotations, getAnnotations, getAnnotations, getAnnotations, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionaryClasses, getBeanFieldVisibility, getBeanFilters, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanToStringSerializer, getBeanTypePropertyName, getBpi, getBpi, getBpro, getBpro, getBpwo, getBpwo, getBpx, getBpx, getClassMeta, getClassMeta, getClassMetaForObject, getDeclaredAnnotations, getDeclaredAnnotations, getExamples, getImplClassConstructor, getImplClasses, getLastAnnotation, getLastAnnotation, getLastAnnotation, getLastAnnotation, getLastAnnotation, getLastAnnotation, getLastAnnotation, getLastAnnotation, getLastDeclaredAnnotation, getLastDeclaredAnnotation, getNotBeanClasses, getNotBeanPackagesNames, getNotBeanPackagesPrefixes, getPropertyNamer, getSwaps, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasDeclaredAnnotation, hasDeclaredAnnotation, hasSameCache, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnorePropertiesWithoutSetters, isIgnoreTransientFields, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isNotABean, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, object, resolveClassMeta, string

Methods inherited from class org.apache.juneau.Context

equals, getArrayProperty, getArrayProperty, getBooleanProperty, getCdlProperty, getClassArrayProperty, getClassArrayProperty, getClassArrayProperty, getClassListProperty, getClassListProperty, getClassMapProperty, getClassMapProperty, getClassProperty, getClassSetProperty, getClassSetProperty, getDefaultLocale, getDefaultMediaType, getDefaultTimeZone, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceProperty, getInstanceProperty, getInstanceProperty, getIntegerProperty, getListProperty, getListProperty, getLongProperty, getMapProperty, getProperty, getProperty, getPropertyKeys, getPropertyStore, getSetProperty, getSetProperty, getStringProperty, getStringPropertyWithNone, hashCode, identityCode, isDebug, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MOCKRESTCLIENT_restBean

public static final String MOCKRESTCLIENT_restBean

See Also:

Constant Field Values

MOCKRESTCLIENT_restBeanCtx

public static final String MOCKRESTCLIENT_restBeanCtx

See Also:

Constant Field Values

MOCKRESTCLIENT_servletPath

public static final String MOCKRESTCLIENT_servletPath

See Also:

Constant Field Values

MOCKRESTCLIENT_contextPath

public static final String MOCKRESTCLIENT_contextPath

See Also:

Constant Field Values

MOCKRESTCLIENT_mockHttpClientConnectionManager

public static final String MOCKRESTCLIENT_mockHttpClientConnectionManager

See Also:

Constant Field Values

MOCKRESTCLIENT_pathVars

public static final String MOCKRESTCLIENT_pathVars

See Also:

Constant Field Values

Constructor Detail

MockRestClient

public MockRestClient(PropertyStore ps)

Constructor.

Parameters:

ps - The REST bean or bean class annotated with @Rest.
If a class, it must have a no-arg constructor.

Method Detail

create

public static MockRestClientBuilder create(Object impl)

Creates a new RestClientBuilder configured with the specified REST implementation bean or bean class.

Parameters:

impl - The REST bean or bean class annotated with @Rest.
If a class, it must have a no-arg constructor.

Returns:

A new builder.

createLax

public static MockRestClientBuilder createLax(Object impl)

Creates a new RestClientBuilder configured with the specified REST implementation bean or bean class.

Same as create(Object) but HTTP 400+ codes don't trigger RestCallExceptions.

Parameters:

impl - The REST bean or bean class annotated with @Rest.
If a class, it must have a no-arg constructor.

Returns:

A new builder.

build

public static MockRestClient build(Object impl)

Creates a new RestClient with no registered serializer or parser.

Equivalent to calling:

MockRestClient.create(impl).build();

Parameters:

impl - The REST bean or bean class annotated with @Rest.
If a class, it must have a no-arg constructor.

Returns:

A new builder.

buildLax

public static MockRestClient buildLax(Object impl)

Creates a new RestClient with no registered serializer or parser.

Same as build(Object) but HTTP 400+ codes don't trigger RestCallExceptions.

Equivalent to calling:

MockRestClient.create(impl).ignoreErrors().build();

Parameters:

impl - The REST bean or bean class annotated with @Rest.
If a class, it must have a no-arg constructor.

Returns:

A new builder.

buildJson

public static MockRestClient buildJson(Object impl)

Creates a new RestClient with JSON marshalling support.

Equivalent to calling:

MockRestClient.create(impl).json().build();

Parameters:

impl - The REST bean or bean class annotated with @Rest.
If a class, it must have a no-arg constructor.

Returns:

A new builder.

buildJsonLax

public static MockRestClient buildJsonLax(Object impl)

Creates a new RestClient with JSON marshalling support.

Same as buildJson(Object) but HTTP 400+ codes don't trigger RestCallExceptions.

Equivalent to calling:

MockRestClient.create(impl).json().ignoreErrors().build();

Parameters:

impl - The REST bean or bean class annotated with @Rest.
If a class, it must have a no-arg constructor.

Returns:

A new builder.

buildSimpleJson

public static MockRestClient buildSimpleJson(Object impl)

Creates a new RestClient with Simplified-JSON marshalling support.

Equivalent to calling:

MockRestClient.create(impl).json().build();

Parameters:

impl - The REST bean or bean class annotated with @Rest.
If a class, it must have a no-arg constructor.

Returns:

A new builder.

buildSimpleJsonLax

public static MockRestClient buildSimpleJsonLax(Object impl)

Creates a new RestClient with Simplified-JSON marshalling support.

Same as buildSimpleJson(Object) but HTTP 400+ codes don't trigger RestCallExceptions.

Equivalent to calling:

MockRestClient.create(impl).json().ignoreErrors().build();

Parameters:

impl - The REST bean or bean class annotated with @Rest.
If a class, it must have a no-arg constructor.

Returns:

A new builder.

get

public MockRestRequest get(Object url)
                    throws RestCallException

Description copied from class: RestClient

Perform a GET request against the specified URI.

Overrides:

get in class RestClient

Parameters:

url - The URI of the remote REST resource.
Can be any of the following types:

• URIBuilder
• URI
• URL
• String
• Object - Converted to String using toString()

Returns:

A RestRequest object that can be further tailored before executing the request and getting the response as a parsed object.

Throws:

RestCallException - If any authentication errors occurred.

get

public MockRestRequest get()
                    throws RestCallException

Description copied from class: RestClient

Perform a GET request against the root URI.

Overrides:

get in class RestClient

Returns:

A RestRequest object that can be further tailored before executing the request and getting the response as a parsed object.

Throws:

RestCallException - If any authentication errors occurred.

put

public MockRestRequest put(Object url,
                           Object body)
                    throws RestCallException

Description copied from class: RestClient

Perform a PUT request against the specified URI.

Overrides:

put in class RestClient

Parameters:

url - The URI of the remote REST resource.
Can be any of the following types:

• URIBuilder
• URI
• URL
• String
• Object - Converted to String using toString()

body - The object to serialize and transmit to the URI as the body of the request. Can be of the following types:

• Reader - Raw contents of Reader will be serialized to remote resource.
• InputStream - Raw contents of InputStream will be serialized to remote resource.
• Object - POJO to be converted to text using the Serializer registered with the RestClient.
• HttpEntity / HttpResource - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.
• NameValuePairSupplier - Converted to a URL-encoded FORM post.
• Supplier - A supplier of anything on this list.

Returns:

A RestRequest object that can be further tailored before executing the request and getting the response as a parsed object.

Throws:

RestCallException - If any authentication errors occurred.

put

public MockRestRequest put(Object url,
                           String body,
                           String contentType)
                    throws RestCallException

Description copied from class: RestClient

Perform a PUT request against the specified URI using a plain text body bypassing the serializer.

Overrides:

put in class RestClient

Parameters:

url - The URI of the remote REST resource.
Can be any of the following types:

• URIBuilder
• URI
• URL
• String
• Object - Converted to String using toString()

body - The object to serialize and transmit to the URI as the body of the request bypassing the serializer.

contentType - The content type of the request.

Returns:

A RestRequest object that can be further tailored before executing the request and getting the response as a parsed object.

Throws:

RestCallException - If any authentication errors occurred.

put

public MockRestRequest put(Object url)
                    throws RestCallException

Description copied from class: RestClient

Same as RestClient.put(Object, Object) but don't specify the input yet.

You must call either RestRequest.body(Object) or RestRequest.formData(String, Object) to set the contents on the result object.

Overrides:

put in class RestClient

Parameters:

url - The URI of the remote REST resource.
Can be any of the following types:

• URIBuilder
• URI
• URL
• String
• Object - Converted to String using toString()

Returns:

A RestRequest object that can be further tailored before executing the request and getting the response as a parsed object.

Throws:

RestCallException - REST call failed.

post

public MockRestRequest post(Object url,
                            Object body)
                     throws RestCallException

Description copied from class: RestClient

Perform a POST request against the specified URI.

• Use RestClient.formPost(Object, Object) for application/x-www-form-urlencoded form posts.

Overrides:

post in class RestClient

Parameters:

url - The URI of the remote REST resource.
Can be any of the following types:

• URIBuilder
• URI
• URL
• String
• Object - Converted to String using toString()

body - The object to serialize and transmit to the URI as the body of the request. Can be of the following types:

• Reader - Raw contents of Reader will be serialized to remote resource.
• InputStream - Raw contents of InputStream will be serialized to remote resource.
• Object - POJO to be converted to text using the Serializer registered with the RestClient.
• HttpEntity / HttpResource - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.
• NameValuePairSupplier - Converted to a URL-encoded FORM post.
• Supplier - A supplier of anything on this list.

Returns:

A RestRequest object that can be further tailored before executing the request and getting the response as a parsed object.

Throws:

RestCallException - If any authentication errors occurred.

post

public MockRestRequest post(Object url,
                            String body,
                            String contentType)
                     throws RestCallException

Description copied from class: RestClient

Perform a POST request against the specified URI as a plain text body bypassing the serializer.

Overrides:

post in class RestClient

Parameters:

url - The URI of the remote REST resource.
Can be any of the following types:

• URIBuilder
• URI
• URL
• String
• Object - Converted to String using toString()

body - The object to serialize and transmit to the URI as the body of the request bypassing the serializer.

contentType - The content type of the request.

Returns:

A RestRequest object that can be further tailored before executing the request and getting the response as a parsed object.

Throws:

RestCallException - If any authentication errors occurred.

post

public MockRestRequest post(Object url)
                     throws RestCallException

Description copied from class: RestClient

Same as RestClient.post(Object, Object) but don't specify the input yet.

You must call either RestRequest.body(Object) or RestRequest.formData(String, Object) to set the contents on the result object.

• Use RestClient.formPost(Object, Object) for application/x-www-form-urlencoded form posts.

Overrides:

post in class RestClient

Parameters:

url - The URI of the remote REST resource.
Can be any of the following types:

• URIBuilder
• URI
• URL
• String
• Object - Converted to String using toString()

Returns:

A RestRequest object that can be further tailored before executing the request and getting the response as a parsed object.

Throws:

RestCallException - REST call failed.

delete

public MockRestRequest delete(Object url)
                       throws RestCallException

Description copied from class: RestClient

Perform a DELETE request against the specified URI.

Overrides:

delete in class RestClient

Parameters:

url - The URI of the remote REST resource.
Can be any of the following types:

• URIBuilder
• URI
• URL
• String
• Object - Converted to String using toString()

Returns:

A RestRequest object that can be further tailored before executing the request and getting the response as a parsed object.

Throws:

RestCallException - If any authentication errors occurred.

options

public MockRestRequest options(Object url)
                        throws RestCallException

Description copied from class: RestClient

Perform an OPTIONS request against the specified URI.

Overrides:

options in class RestClient

Parameters:

url - The URI of the remote REST resource.
Can be any of the following types:

• URIBuilder
• URI
• URL
• String
• Object - Converted to String using toString()

Returns:

A RestRequest object that can be further tailored before executing the request and getting the response as a parsed object.

Throws:

RestCallException - If any authentication errors occurred.

head

public MockRestRequest head(Object url)
                     throws RestCallException

Description copied from class: RestClient

Perform a HEAD request against the specified URI.

Overrides:

head in class RestClient

Parameters:

url - The URI of the remote REST resource.
Can be any of the following types:

• URIBuilder
• URI
• URL
• String
• Object - Converted to String using toString()

Returns:

A RestRequest object that can be further tailored before executing the request and getting the response as a parsed object.

Throws:

RestCallException - If any authentication errors occurred.

formPost

public MockRestRequest formPost(Object url,
                                Object body)
                         throws RestCallException

Description copied from class: RestClient

Perform a POST request with a content type of application/x-www-form-urlencoded against the specified URI.

Overrides:

formPost in class RestClient

Parameters:

url - The URI of the remote REST resource.
Can be any of the following types:

• URIBuilder
• URI
• URL
• String
• Object - Converted to String using toString()

body - The object to serialize and transmit to the URI as the body of the request.

• NameValuePair - URL-encoded as a single name-value pair.
• NameValuePair array - URL-encoded as name value pairs.
• NameValuePairSupplier - URL-encoded as name value pairs.
• Reader/InputStream- Streamed directly and Content-Type set to "application/x-www-form-urlencoded"
• HttpResource/BasicHttpResource - Raw contents will be serialized to remote resource. Additional headers and media type will be set on request.
• HttpEntity/BasicHttpEntity - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.
• Object - Converted to a SerializedHttpEntity using UrlEncodingSerializer to serialize.
• Supplier - A supplier of anything on this list.

Returns:

A RestRequest object that can be further tailored before executing the request and getting the response as a parsed object.

Throws:

RestCallException - If any authentication errors occurred.

formPost

public MockRestRequest formPost(Object url)
                         throws RestCallException

Description copied from class: RestClient

Same as RestClient.formPost(Object, Object) but doesn't specify the input yet.

Overrides:

formPost in class RestClient

Parameters:

url - The URI of the remote REST resource.
Can be any of the following types:

• URIBuilder
• URI
• URL
• String
• Object - Converted to String using toString()

Returns:

A RestRequest object that can be further tailored before executing the request and getting the response as a parsed object.

Throws:

RestCallException - If any authentication errors occurred.

formPostPairs

public MockRestRequest formPostPairs(Object url,
                                     Object... parameters)
                              throws RestCallException

Description copied from class: RestClient

Perform a POST request with a content type of application/x-www-form-urlencoded against the specified URI.

Overrides:

formPostPairs in class RestClient

Parameters:

url - The URI of the remote REST resource.
Can be any of the following types:

• URIBuilder
• URI
• URL
• String
• Object - Converted to String using toString()

parameters - The parameters of the form post.
The parameters represent name/value pairs and must be an even number of arguments.
Parameters are converted to BasicNameValuePair objects.

Returns:

A RestRequest object that can be further tailored before executing the request and getting the response as a parsed object.

Throws:

RestCallException - If any authentication errors occurred.

patch

public MockRestRequest patch(Object url,
                             Object body)
                      throws RestCallException

Description copied from class: RestClient

Perform a PATCH request against the specified URI.

Overrides:

patch in class RestClient

Parameters:

url - The URI of the remote REST resource.
Can be any of the following types:

• URIBuilder
• URI
• URL
• String
• Object - Converted to String using toString()

body - The object to serialize and transmit to the URI as the body of the request. Can be of the following types:

• Reader - Raw contents of Reader will be serialized to remote resource.
• InputStream - Raw contents of InputStream will be serialized to remote resource.
• HttpResource/BasicHttpResource - Raw contents will be serialized to remote resource. Additional headers and media type will be set on request.
• HttpEntity/BasicHttpEntity - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.
• Object - POJO to be converted to text using the Serializer registered with the RestClient.
• NameValuePairSupplier - Converted to a URL-encoded FORM post.
• Supplier - A supplier of anything on this list.

Returns:

A RestRequest object that can be further tailored before executing the request and getting the response as a parsed object.

Throws:

RestCallException - If any authentication errors occurred.

patch

public MockRestRequest patch(Object url,
                             String body,
                             String contentType)
                      throws RestCallException

Description copied from class: RestClient

Perform a PATCH request against the specified URI as a plain text body bypassing the serializer.

Overrides:

patch in class RestClient

Parameters:

url - The URI of the remote REST resource.
Can be any of the following types:

• URIBuilder
• URI
• URL
• String
• Object - Converted to String using toString()

body - The object to serialize and transmit to the URI as the body of the request bypassing the serializer.

contentType - The content type of the request.

Returns:

A RestRequest object that can be further tailored before executing the request and getting the response as a parsed object.

Throws:

RestCallException - If any authentication errors occurred.

patch

public MockRestRequest patch(Object url)
                      throws RestCallException

Description copied from class: RestClient

Same as RestClient.patch(Object, Object) but don't specify the input yet.

You must call RestRequest.body(Object) to set the contents on the result object.

Overrides:

patch in class RestClient

Parameters:

url - The URI of the remote REST resource.
Can be any of the following types:

• URIBuilder
• URI
• URL
• String
• Object - Converted to String using toString()

Returns:

A RestRequest object that can be further tailored before executing the request and getting the response as a parsed object.

Throws:

RestCallException - REST call failed.

callback

public MockRestRequest callback(String callString)
                         throws RestCallException

Description copied from class: RestClient

Performs a REST call where the entire call is specified in a simple string.

This method is useful for performing callbacks when the target of a callback is passed in on an initial request, for example to signal when a long-running process has completed.

The call string can be any of the following formats:

• "[method] [uri]" - e.g. "GET http://localhost/callback"
• "[method] [uri] [payload]" - e.g. "POST http://localhost/callback some text payload"
• "[method] [headers] [uri] [payload]" - e.g. "POST {'Content-Type':'text/json'} http://localhost/callback {'some':'json'}"

The payload will always be sent using a simple StringEntity.

Overrides:

callback in class RestClient

Parameters:

callString - The call string.

Returns:

A RestRequest object that can be further tailored before executing the request and getting the response as a parsed object.

Throws:

RestCallException - REST call failed.

request

public MockRestRequest request(String method,
                               Object url,
                               Object body)
                        throws RestCallException

Description copied from class: RestClient

Perform a generic REST call.

Overrides:

request in class RestClient

Parameters:

method - The HTTP method.

url - The URI of the remote REST resource.
Can be any of the following types:

• URIBuilder
• URI
• URL
• String
• Object - Converted to String using toString()

body - The HTTP body content. Can be of the following types:

• Reader - Raw contents of Reader will be serialized to remote resource.
• InputStream - Raw contents of InputStream will be serialized to remote resource.
• HttpResource/BasicHttpResource - Raw contents will be serialized to remote resource. Additional headers and media type will be set on request.
• HttpEntity/BasicHttpEntity - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.
• Object - POJO to be converted to text using the Serializer registered with the RestClient.
• NameValuePairSupplier - Converted to a URL-encoded FORM post.
• Supplier - A supplier of anything on this list.

This parameter is IGNORED if the method type normally does not have content.

Returns:

A RestRequest object that can be further tailored before executing the request and getting the response as a parsed object.

Throws:

RestCallException - If any authentication errors occurred.

request

public MockRestRequest request(String method,
                               Object url)
                        throws RestCallException

Description copied from class: RestClient

Perform a generic REST call.

Overrides:

request in class RestClient

Parameters:

method - The HTTP method.

url - The URI of the remote REST resource.
Can be any of the following types:

• URIBuilder
• URI
• URL
• String
• Object - Converted to String using toString()

Returns:

A RestRequest object that can be further tailored before executing the request and getting the response as a parsed object.

Throws:

RestCallException - If any authentication errors occurred.

request

public MockRestRequest request(String method,
                               Object url,
                               boolean hasBody)
                        throws RestCallException

Description copied from class: RestClient

Perform a generic REST call.

Typically you're going to use RestClient.request(String, Object) or RestClient.request(String, Object, Object), but this method is provided to allow you to perform non-standard HTTP methods (e.g. HTTP FOO).

Overrides:

request in class RestClient

Parameters:

method - The method name (e.g. "GET", "OPTIONS").

url - The URI of the remote REST resource.
Can be any of the following types:

• URIBuilder
• URI
• URL
• String
• Object - Converted to String using toString()

hasBody - Boolean flag indicating if the specified request has content associated with it.

Returns:

A RestRequest object that can be further tailored before executing the request and getting the response as a parsed object.

Throws:

RestCallException - If any authentication errors occurred.

getCurrentClientRequest

public HttpRequest getCurrentClientRequest()

Returns the current client-side REST request.

Note that this uses a ThreadLocal object for storage and so will not work on requests executed in separate threads such as when using Futures.

Returns:

The current client-side REST request, or null if not set.

getCurrentClientResponse

public MockRestResponse getCurrentClientResponse()

Returns the current client-side REST response.

Note that this uses a ThreadLocal object for storage and so will not work on requests executed in separate threads such as when using Futures.

Returns:

The current client-side REST response, or null if not set.

getCurrentServerRequest

public MockServletRequest getCurrentServerRequest()

Returns the current server-side REST request.

Note that this uses a ThreadLocal object for storage and so will not work on requests executed in separate threads such as when using Futures.

Returns:

The current server-side REST request, or null if not set.

getCurrentServerResponse

public MockServletResponse getCurrentServerResponse()

Returns the current server-side REST response.

Note that this uses a ThreadLocal object for storage and so will not work on requests executed in separate threads such as when using Futures.

Returns:

The current server-side REST response, or null if not set.

createRequest

protected MockRestRequest createRequest(URI uri,
                                        String method,
                                        boolean hasBody)
                                 throws RestCallException

Description copied from class: RestClient

Creates a RestRequest object from the specified HttpRequest object.

Subclasses can override this method to provide their own specialized RestRequest objects.

Overrides:

createRequest in class RestClient

Parameters:

uri - The target.

method - The HTTP method (uppercase).

hasBody - Whether this method has a request entity.

Returns:

A new RestRequest object.

Throws:

RestCallException - If an exception or non-200 response code occurred during the connection attempt.

createResponse

protected MockRestResponse createResponse(RestRequest req,
                                          HttpResponse httpResponse,
                                          Parser parser)
                                   throws RestCallException

Description copied from class: RestClient

Creates a RestResponse object from the specified HttpResponse object.

Subclasses can override this method to provide their own specialized RestResponse objects.

Overrides:

createResponse in class RestClient

Parameters:

req - The request creating this response.

httpResponse - The response object to wrap.

parser - The parser to use to parse the response.

Returns:

A new RestResponse object.

Throws:

RestCallException - If an exception or non-200 response code occurred during the connection attempt.

close

public void close()
           throws IOException

Description copied from class: RestClient

Calls Closeable.close() on the underlying CloseableHttpClient.

It's good practice to call this method after the client is no longer used.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface HttpConnection

Overrides:

close in class RestClient

Throws:

IOException - Thrown by underlying stream.

isOpen

public boolean isOpen()

Specified by:

isOpen in interface HttpConnection

isStale

public boolean isStale()

Specified by:

isStale in interface HttpConnection

setSocketTimeout

public void setSocketTimeout(int timeout)

Specified by:

setSocketTimeout in interface HttpConnection

getSocketTimeout

public int getSocketTimeout()

Specified by:

getSocketTimeout in interface HttpConnection

shutdown

public void shutdown()
              throws IOException

Specified by:

shutdown in interface HttpConnection

Throws:

IOException

getMetrics

public HttpConnectionMetrics getMetrics()

Specified by:

getMetrics in interface HttpConnection

isResponseAvailable

public boolean isResponseAvailable(int timeout)
                            throws IOException

Specified by:

isResponseAvailable in interface HttpClientConnection

Throws:

IOException

sendRequestHeader

public void sendRequestHeader(HttpRequest request)
                       throws HttpException,
                              IOException

Specified by:

sendRequestHeader in interface HttpClientConnection

Throws:

HttpException

IOException

sendRequestEntity

public void sendRequestEntity(HttpEntityEnclosingRequest request)
                       throws HttpException,
                              IOException

Specified by:

sendRequestEntity in interface HttpClientConnection

Throws:

HttpException

IOException

receiveResponseHeader

public HttpResponse receiveResponseHeader()
                                   throws HttpException,
                                          IOException

Specified by:

receiveResponseHeader in interface HttpClientConnection

Throws:

HttpException

IOException

receiveResponseEntity

public void receiveResponseEntity(HttpResponse response)
                           throws HttpException,
                                  IOException

Specified by:

receiveResponseEntity in interface HttpClientConnection

Throws:

HttpException

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface HttpClientConnection

Throws:

IOException