org.apache.juneau.rest.mock2

Class MockRestClient

java.lang.Object

org.apache.juneau.ContextBuilder

org.apache.juneau.BeanContextBuilder

org.apache.juneau.rest.client.RestClientBuilder

org.apache.juneau.rest.mock2.MockRestClient

public class MockRestClient
extends RestClientBuilder

Mocked RestClient.

• Overview > juneau-rest-mock

Field Summary

Fields inherited from class org.apache.juneau.ContextBuilder

psb

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MockRestClient(Object impl) Constructor.

Method Summary

Modifier and Type	Method and Description
RestClient	build() Build the object.
static RestClient	build(Object impl, Marshall m) Convenience method for creating a RestClient over the specified REST implementation bean or bean class.
static RestClient	build(Object impl, Serializer s, Parser p) Convenience method for creating a RestClient over the specified REST implementation bean or bean class.
static MockRestClient	create(Object impl) Creates a new RestClient builder configured with the specified REST implementation bean or bean class.
static MockRestClient	create(Object impl, Marshall m) Creates a new RestClient builder configured with the specified REST implementation bean or bean class.
static MockRestClient	create(Object impl, Serializer s, Parser p) Creates a new RestClient builder configured with the specified REST implementation bean or bean class.
MockRestClient	debug() Enable debug mode.
MockRestClient	html() Convenience method for setting Accept and Content-Type headers to "text/html".
MockRestClient	json() Convenience method for setting Accept and Content-Type headers to "application/json".
MockRestClient	marshall(Marshall value) Configuration property: Marshall
MockRestClient	msgpack() Convenience method for setting Accept and Content-Type headers to "octal/msgpack".
MockRestClient	openapi() Convenience method for setting Accept and Content-Type headers to "text/openapi".
MockRestClient	parser(Parser value) Configuration property: Parser.
MockRestClient	plainText() Convenience method for setting Accept and Content-Type headers to "text/plain".
MockRestClient	serializer(Serializer value) Configuration property: Serializer.
MockRestClient	simpleJson() Convenience method for setting Accept and Content-Type headers to "application/json+simple".
MockRestClient	uon() Convenience method for setting Accept and Content-Type headers to "text/uon".
MockRestClient	urlEnc() Convenience method for setting Accept and Content-Type headers to "application/x-www-form-urlencoded".
MockRestClient	xml() Convenience method for setting Accept and Content-Type headers to "text/xml".

Methods inherited from class org.apache.juneau.rest.client.RestClientBuilder

accept, acceptCharset, acceptEncoding, acceptLanguage, add, addBeanTypes, addBeanTypes, addInterceptorFirst, addInterceptorFirst, addInterceptorLast, addInterceptorLast, addRootType, addRootType, addTo, addTo, annotations, apply, applyAnnotations, applyAnnotations, applyAnnotations, authorization, autoCloseStreams, autoCloseStreams, backoffManager, basicAuth, beanClassVisibility, beanConstructorVisibility, beanDictionary, beanDictionary, beanDictionaryRemove, beanDictionaryRemove, beanDictionaryReplace, beanDictionaryReplace, beanFieldVisibility, beanFilters, beanFilters, beanFiltersRemove, beanFiltersRemove, beanFiltersReplace, beanFiltersReplace, beanMapPutReturnsOldValue, beanMapPutReturnsOldValue, beanMethodVisibility, beansRequireDefaultConstructor, beansRequireDefaultConstructor, beansRequireSerializable, beansRequireSerializable, beansRequireSettersForGetters, beansRequireSettersForGetters, beansRequireSomeProperties, beanTypePropertyName, binaryInputFormat, binaryOutputFormat, bpi, bpi, bpi, bpro, bpro, bpro, bpwo, bpwo, bpwo, bpx, bpx, bpx, cacheControl, cipherSuites, clientVersion, connection, connectionBackoffStrategy, connectionManager, connectionManagerShared, connectionReuseStrategy, connectionTimeToLive, contentDecoderRegistry, contentLength, contentType, createConnectionManager, createHttpClient, createHttpClientBuilder, date, debug, debugOutputLines, defaultAuthSchemeRegistry, defaultConnectionConfig, defaultCookieSpecRegistry, defaultCookieStore, defaultCredentialsProvider, defaultHeaders, defaultRequestConfig, defaultSocketConfig, detectRecursions, detectRecursions, dictionary, dictionary, dictionaryRemove, dictionaryRemove, dictionaryReplace, dictionaryReplace, disableAuthCaching, disableAutomaticRetries, disableConnectionState, disableContentCompression, disableCookieManagement, disableRedirectHandling, enableLaxSSL, enableSSL, evictExpiredConnections, evictIdleConnections, example, exampleJson, executorService, expect, fileCharset, forwarded, from, getHttpClient, getHttpClientBuilder, header, headers, host, hostnameVerifier, httpClient, httpClient, httpClientBuilder, httpClientConnectionManager, httpProcessor, ifMatch, ifModifiedSince, ifNoneMatch, ifRange, ifUnmodifiedSince, ignoreInvocationExceptionsOnGetters, ignoreInvocationExceptionsOnGetters, ignoreInvocationExceptionsOnSetters, ignoreInvocationExceptionsOnSetters, ignorePropertiesWithoutSetters, ignoreRecursions, ignoreRecursions, ignoreUnknownBeanProperties, ignoreUnknownBeanProperties, ignoreUnknownNullBeanProperties, implClass, implClasses, initialDepth, inputStreamCharset, interceptors, keepAliveStrategy, keepHttpClientOpen, keepHttpClientOpen, keyManagers, listenerP, listenerS, locale, logTo, maxConnPerRoute, maxConnTotal, maxDepth, maxForwards, maxIndent, mediaType, notBeanClasses, notBeanClasses, notBeanClassesRemove, notBeanClassesRemove, notBeanClassesReplace, notBeanClassesReplace, notBeanPackages, notBeanPackages, notBeanPackagesRemove, notBeanPackagesRemove, notBeanPackagesReplace, notBeanPackagesReplace, noTrace, origin, paramFormat, paramFormatPlain, parser, partParser, partParser, partSerializer, partSerializer, pojoSwaps, pojoSwaps, pojoSwapsRemove, pojoSwapsRemove, pojoSwapsReplace, pojoSwapsReplace, pooled, pragma, proxy, proxyAuthenticationStrategy, proxyAuthorization, publicSuffixMatcher, query, quoteChar, range, redirectStrategy, referer, removeFrom, requestExecutor, retryable, retryHandler, rootUrl, routePlanner, schemePortResolver, secureRandom, serializer, serviceUnavailableRetryStrategy, set, set, sortCollections, sortCollections, sortMaps, sortMaps, sortProperties, sortProperties, sq, sslContext, sslHostnameVerifier, sslProtocols, sslSocketFactory, strict, strict, targetAuthenticationStrategy, te, timeZone, trimEmptyCollections, trimEmptyCollections, trimEmptyMaps, trimEmptyMaps, trimNullProperties, trimStringsP, trimStringsP, trimStringsS, trimStringsS, trustManagers, unbuffered, unbuffered, upgrade, uriContext, uriRelativity, uriResolution, useEnumNames, useEnumNames, useInterfaceProxies, useJavaBeanIntrospector, useJavaBeanIntrospector, userAgent, userAgent, userTokenHandler, useSystemProperties, useWhitespace, useWhitespace, via, warning, ws

Methods inherited from class org.apache.juneau.BeanContextBuilder

examples, excludeProperties, excludeProperties, excludeProperties, fluentSetters, fluentSetters, includeProperties, includeProperties, includeProperties, propertyNamer

Methods inherited from class org.apache.juneau.ContextBuilder

build, getPropertyStore, getPropertyStoreBuilder, peek, peek

Methods inherited from class java.lang.Object

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

Constructor Detail

MockRestClient

protected MockRestClient(Object impl)

Constructor.

Parameters:

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

Method Detail

create

public static MockRestClient create(Object impl)

Creates a new RestClient builder 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.

create

public static MockRestClient create(Object impl,
                                    Marshall m)

Creates a new RestClient builder 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.

m - The marshall to use for serializing and parsing HTTP bodies.
Can be null (will remove the existing serializer/parser).

Returns:

A new builder.

create

public static MockRestClient create(Object impl,
                                    Serializer s,
                                    Parser p)

Creates a new RestClient builder 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.

s - The serializer to use for serializing HTTP bodies.
Can be null (will remove the existing serializer).

p - The parser to use for parsing HTTP bodies.
Can be null (will remove the existing parser).

Returns:

A new builder.

build

public static RestClient build(Object impl,
                               Marshall m)

Convenience method for creating a RestClient over the specified REST implementation bean or bean class.

Equivalent to calling:

MockRestClient.create(impl, m).build();

Parameters:

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

m - The marshall to use for specifying the Accept and Content-Type headers.
If null, headers will be reset.

Returns:

A new MockRest object.

build

public static RestClient build(Object impl,
                               Serializer s,
                               Parser p)

Convenience method for creating a RestClient over the specified REST implementation bean or bean class.

Equivalent to calling:

MockRestClient.create(impl, s, p).build();

Parameters:

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

s - The serializer to use for serializing HTTP bodies.
Can be null (will remove the existing serializer).

p - The parser to use for parsing HTTP bodies.
Can be null (will remove the existing parser).

Returns:

A new MockRest object.

build

public RestClient build()

Description copied from class: ContextBuilder

Build the object.

Overrides:

build in class RestClientBuilder

Returns:

The built object. Subsequent calls to this method will create new instances.

debug

public MockRestClient debug()

Enable debug mode.

Overrides:

debug in class RestClientBuilder

Returns:

This object (for method chaining).

json

public MockRestClient json()

Convenience method for setting Accept and Content-Type headers to "application/json".

Overrides:

json in class RestClientBuilder

Returns:

This object (for method chaining).

simpleJson

public MockRestClient simpleJson()

Convenience method for setting Accept and Content-Type headers to "application/json+simple".

Overrides:

simpleJson in class RestClientBuilder

Returns:

This object (for method chaining).

xml

public MockRestClient xml()

Convenience method for setting Accept and Content-Type headers to "text/xml".

Overrides:

xml in class RestClientBuilder

Returns:

This object (for method chaining).

html

public MockRestClient html()

Convenience method for setting Accept and Content-Type headers to "text/html".

Overrides:

html in class RestClientBuilder

Returns:

This object (for method chaining).

plainText

public MockRestClient plainText()

Convenience method for setting Accept and Content-Type headers to "text/plain".

Overrides:

plainText in class RestClientBuilder

Returns:

This object (for method chaining).

msgpack

public MockRestClient msgpack()

Convenience method for setting Accept and Content-Type headers to "octal/msgpack".

Overrides:

msgpack in class RestClientBuilder

Returns:

This object (for method chaining).

uon

public MockRestClient uon()

Convenience method for setting Accept and Content-Type headers to "text/uon".

Overrides:

uon in class RestClientBuilder

Returns:

This object (for method chaining).

urlEnc

public MockRestClient urlEnc()

Convenience method for setting Accept and Content-Type headers to "application/x-www-form-urlencoded".

Overrides:

urlEnc in class RestClientBuilder

Returns:

This object (for method chaining).

openapi

public MockRestClient openapi()

Convenience method for setting Accept and Content-Type headers to "text/openapi".

Overrides:

openapi in class RestClientBuilder

Returns:

This object (for method chaining).

marshall

public MockRestClient marshall(Marshall value)

Description copied from class: RestClientBuilder

Configuration property: Marshall

Shortcut for specifying the RestClient.RESTCLIENT_serializer and RestClient.RESTCLIENT_parser using the serializer and parser defined in a marshall.

Overrides:

marshall in class RestClientBuilder

Parameters:

value - The values to add to this setting.

Returns:

This object (for method chaining).

serializer

public MockRestClient serializer(Serializer value)

Description copied from class: RestClientBuilder

Configuration property: Serializer.

Same as RestClientBuilder.serializer(Class) but takes in a serializer instance.

• RestClient.RESTCLIENT_serializer

Overrides:

serializer in class RestClientBuilder

Parameters:

value - The new value for this setting.
The default is JsonSerializer.

Returns:

This object (for method chaining).

parser

public MockRestClient parser(Parser value)

Description copied from class: RestClientBuilder

Configuration property: Parser.

Same as RestClientBuilder.parser(Parser) except takes in a parser instance.

• RestClient.RESTCLIENT_parser

Overrides:

parser in class RestClientBuilder

Parameters:

value - The new value for this setting.
The default value is JsonParser.DEFAULT.

Returns:

This object (for method chaining).