com.ca.codesv.sdk

Class GenericResponseBuilder

java.lang.Object

com.ca.codesv.sdk.GenericResponseBuilder

All Implemented Interfaces:

ResponseBuilder

public final class GenericResponseBuilder
extends java.lang.Object
implements ResponseBuilder

GenericResponseBuilder provides a builder for Response objects in the most generic way possible. When writing a protocol specific response builder, this will likely be used to ultimately construct the underlying Response object. It can also be used directly in the API to build Responses manually, but this would be an advanced use case which most people will have no need for.

Method Summary

Modifier and Type	Method and Description
Response	build() This method is primarily intended to be called by the framework to produce the Response object which will be used during playback.
GenericResponseBuilder	clearMetaData() Removes all meta-data entries previously added.
GenericResponseBuilder	disableMagicDates() Disables magic dates.
GenericResponseBuilder	disableMagicStrings() Disables magic strings.
GenericResponseBuilder	enableMagicDates() This is the default and is provided to undo the effects of disableMagicDates().
GenericResponseBuilder	enableMagicStrings() This is the default and is provided to undo the effects of disableMagicStrings().
static GenericResponseBuilder	get()
GenericResponseBuilder	removeMetaDataEntries(java.lang.String key) Removes all meta-data entries for the specified key.
GenericResponseBuilder	removeMetaDataEntry(java.lang.String key, java.lang.String value) Removes a particular meta-data mapping.
GenericResponseBuilder	withBody(byte[] body) Specifies the response body to use.
GenericResponseBuilder	withBody(java.lang.String body) Specifies the response body to use.
GenericResponseBuilder	withBody(java.lang.String body, java.nio.charset.Charset charset) Specifies the response body to use.
GenericResponseBuilder	withComputedDelay(Function<Response,java.lang.Long> delayProvider) Allows specification of a Function to use for computing the delay to use when responding to the caller.
GenericResponseBuilder	withFixedDelay(long fixedDelay) Allows specification of a fixed delay to use when responding to the caller.
GenericResponseBuilder	withMetaDataEntry(java.lang.String key, java.lang.String value) Adds a meta-data mapping.
GenericResponseBuilder	withRandomDelay(long lowerBound, long upperBound) Allows specification of a random delay to use when responding to the caller.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static GenericResponseBuilder get()

Returns:

new instance of GenericResponseBuilder.

withBody

public GenericResponseBuilder withBody(java.lang.String body)

Specifies the response body to use. This method assumes that Charset.defaultCharset() should be used for converting the string to bytes. If that is incorrect, use withBody(String, Charset) or withBody(byte[]) instead.

Parameters:

body - string that will be added as body to the response

Returns:

this for additional configuration

withBody

public GenericResponseBuilder withBody(java.lang.String body,
                                       java.nio.charset.Charset charset)

Specifies the response body to use.

Parameters:

body - string that will be added as body to the response

charset - charset of string that will be add as body

Returns:

this for additional configuration

withBody

public GenericResponseBuilder withBody(byte[] body)

Specifies the response body to use.

Parameters:

body - response body

Returns:

this for additional configuration

withMetaDataEntry

public GenericResponseBuilder withMetaDataEntry(java.lang.String key,
                                                java.lang.String value)

Adds a meta-data mapping.

Parameters:

key - name of the key for metadata

value - value of metadata

Returns:

this for additional configuration

removeMetaDataEntry

public GenericResponseBuilder removeMetaDataEntry(java.lang.String key,
                                                  java.lang.String value)

Removes a particular meta-data mapping.

Parameters:

key - name of key in metadata

value - value of key

Returns:

this for additional configuration

removeMetaDataEntries

public GenericResponseBuilder removeMetaDataEntries(java.lang.String key)

Removes all meta-data entries for the specified key.

Parameters:

key - name of key in metadata

Returns:

this for additional configuration

clearMetaData

public GenericResponseBuilder clearMetaData()

Removes all meta-data entries previously added.

Returns:

this for additional configuration

withFixedDelay

public GenericResponseBuilder withFixedDelay(long fixedDelay)

Allows specification of a fixed delay to use when responding to the caller. The default is 0.

Parameters:

fixedDelay - delay of response

Returns:

this for additional configuration

withRandomDelay

public GenericResponseBuilder withRandomDelay(long lowerBound,
                                              long upperBound)

Allows specification of a random delay to use when responding to the caller. When this is used, every time the delay is fetched from the Response object, a different, random delay will be returned which conforms to the bounds provided here.

The default is a fixed delay of 0.

Parameters:

lowerBound - The lower bound for the random delay (inclusive).

upperBound - The upper bound for the random delay (exclusive).

Returns:

this for additional configuration

withComputedDelay

public GenericResponseBuilder withComputedDelay(Function<Response,java.lang.Long> delayProvider)

Allows specification of a Function to use for computing the delay to use when responding to the caller. When this is used, every time the delay is fetched from the Response object, the function will be called again to re-compute the delay.

The default is a fixed delay of 0.

Parameters:

delayProvider - function

Returns:

this for additional configuration

disableMagicDates

public GenericResponseBuilder disableMagicDates()

Disables magic dates.

Returns:

this for additional configuration

enableMagicDates

public GenericResponseBuilder enableMagicDates()

This is the default and is provided to undo the effects of disableMagicDates().

Returns:

this for additional configuration

disableMagicStrings

public GenericResponseBuilder disableMagicStrings()

Disables magic strings.

Returns:

this for additional configuration

enableMagicStrings

public GenericResponseBuilder enableMagicStrings()

This is the default and is provided to undo the effects of disableMagicStrings().

Returns:

this for additional configuration

build

public Response build()

Description copied from interface: ResponseBuilder

This method is primarily intended to be called by the framework to produce the Response object which will be used during playback. However, no harm will result from calling it elsewhere.

It is important to note that this method may not reset or alter the state of the builder. It must be possible to call this method multiple times in a row and get equivalent (but different) objects.

Specified by:

build in interface ResponseBuilder