com.ca.codesv.protocols.http.fluent

Class AbstractHttpRequestMessageBuilder<T extends HttpRequestMessageBuilder>

java.lang.Object

com.ca.codesv.protocols.http.fluent.AbstractHttpRequestMessageBuilder<T>

All Implemented Interfaces:

HttpRequestMessageBuilder<T>

Direct Known Subclasses:

AbstractHttpRequestVerificationBuilder, AbstractHttpTransactionBuilder, HttpRequestMessageBuilderImpl

public abstract class AbstractHttpRequestMessageBuilder<T extends HttpRequestMessageBuilder>
extends java.lang.Object
implements HttpRequestMessageBuilder<T>

HTTP Request message builder.

Field Summary

Fields

Modifier and Type	Field and Description
protected ApiWrapper	apiWrapper

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractHttpRequestMessageBuilder(ApiWrapper apiWrapper)

Method Summary

Modifier and Type	Method and Description
protected abstract RequestMessageMatcher	buildMatcherInternal() Builder of a request matcher.
T	matchesAuthorization(org.hamcrest.Matcher<java.lang.String> authorizationValue) Matches Authorization HTTP header with Matcher.
T	matchesAuthorization(com.ca.codesv.sdk.function.Predicate<java.lang.String> authorizationValuePredicate) Matches Authorization HTTP header with Predicate.
T	matchesAuthorization(java.lang.String authorizationValue) Matches Authorization HTTP header.
T	matchesBasicAuthorization(com.ca.codesv.sdk.function.Predicate<java.lang.String> usernamePredicate, com.ca.codesv.sdk.function.Predicate<java.lang.String> passwordPredicate) Matches Authorization HTTP header for Basic authorization with Predicate.
T	matchesBasicAuthorization(java.lang.String username, java.lang.String password) Matches Authorization HTTP header for Basic authorization.
T	matchesBody(com.ca.codesv.sdk.function.Predicate<java.lang.String> bodyPredicate) Matches a given string body payload with Predicate.
T	matchesBody(java.lang.String body) Matches a given string body payload.
T	matchesBodyPayload(com.ca.codesv.sdk.function.Predicate<HttpPayload> bodyPredicate) Matches a given body payload with Predicate.
T	matchesCookie(java.lang.String cookieName, com.ca.codesv.sdk.function.Predicate<java.lang.String> cookieValuePredicate) Matches a given cookie value with Predicate.
T	matchesCookie(java.lang.String cookieName, java.lang.String cookieValue) Matches a given cookie value.
T	matchesHeader(java.lang.String name, com.ca.codesv.sdk.function.Predicate<java.lang.String> predicate) Matches a given request header value with Predicate.
T	matchesHeader(java.lang.String name, java.lang.String value) Matches a given request header value.
T	matchesHeaderField(com.ca.codesv.sdk.function.Predicate<java.lang.String> namePredicate) Matches a given request header field name with Predicate.
T	matchesHeaderField(java.lang.String name) Matches a given request header field name.
T	matchesMessage(com.ca.codesv.sdk.function.Predicate<com.ca.codesv.sdk.Request> requestMessage) Matches a given request object with Predicate.
T	matchesPathParameter(java.lang.String parameterName, com.ca.codesv.sdk.function.Predicate<java.lang.String> parameterValuePredicate) Matches a given path parameter value with Predicate.
T	matchesPathParameter(java.lang.String parameterName, java.lang.String parameterValue) Matches a given path parameter value.
T	matchesQuery(java.lang.String queryParameterName, com.ca.codesv.sdk.function.Predicate<java.lang.String> queryParameterPredicate) Matches a given query parameter with Predicate.
T	matchesQuery(java.lang.String queryParameterName, java.lang.String queryParameterValue) Matches a given query parameter.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ca.codesv.protocols.http.fluent.HttpRequestMessageBuilder

absentBodyPayload, absentCookie, absentHeader, absentQuery, matchesBasicAuthorization, matchesBody, matchesBodyFromFile, matchesBodyPayload, matchesCookie, matchesHeader, matchesHeaderField, matchesHeaderFromFile, matchesMessage, matchesPathParameter, matchesQuery, usingRequestParser

Field Detail

apiWrapper

protected final ApiWrapper apiWrapper

Constructor Detail

AbstractHttpRequestMessageBuilder

protected AbstractHttpRequestMessageBuilder(ApiWrapper apiWrapper)

Method Detail

matchesMessage

public T matchesMessage(com.ca.codesv.sdk.function.Predicate<com.ca.codesv.sdk.Request> requestMessage)

Description copied from interface: HttpRequestMessageBuilder

Matches a given request object with Predicate.

Specified by:

matchesMessage in interface HttpRequestMessageBuilder<T extends HttpRequestMessageBuilder>

Parameters:

requestMessage - Matcher that matches a Request

Returns:

a class that extends this

matchesHeader

public T matchesHeader(java.lang.String name,
                       com.ca.codesv.sdk.function.Predicate<java.lang.String> predicate)

Description copied from interface: HttpRequestMessageBuilder

Matches a given request header value with Predicate.

Specified by:

matchesHeader in interface HttpRequestMessageBuilder<T extends HttpRequestMessageBuilder>

Parameters:

name - name of the header

predicate - predicate

Returns:

a class that extends this

matchesHeader

public T matchesHeader(java.lang.String name,
                       java.lang.String value)

Description copied from interface: HttpRequestMessageBuilder

Matches a given request header value.

Specified by:

matchesHeader in interface HttpRequestMessageBuilder<T extends HttpRequestMessageBuilder>

Parameters:

name - name of the header

value - value of specified header

Returns:

a class that extends this

matchesHeaderField

public T matchesHeaderField(com.ca.codesv.sdk.function.Predicate<java.lang.String> namePredicate)

Description copied from interface: HttpRequestMessageBuilder

Matches a given request header field name with Predicate.

Specified by:

matchesHeaderField in interface HttpRequestMessageBuilder<T extends HttpRequestMessageBuilder>

Parameters:

namePredicate - predicate

Returns:

a class that extends this

matchesHeaderField

public T matchesHeaderField(java.lang.String name)

Description copied from interface: HttpRequestMessageBuilder

Matches a given request header field name.

Specified by:

matchesHeaderField in interface HttpRequestMessageBuilder<T extends HttpRequestMessageBuilder>

Parameters:

name - name of the header

Returns:

a class that extends this

matchesQuery

public T matchesQuery(java.lang.String queryParameterName,
                      com.ca.codesv.sdk.function.Predicate<java.lang.String> queryParameterPredicate)

Description copied from interface: HttpRequestMessageBuilder

Matches a given query parameter with Predicate.

Specified by:

matchesQuery in interface HttpRequestMessageBuilder<T extends HttpRequestMessageBuilder>

Parameters:

queryParameterName - name of the query parameter

queryParameterPredicate - predicate

Returns:

a class that extends this

matchesQuery

public T matchesQuery(java.lang.String queryParameterName,
                      java.lang.String queryParameterValue)

Description copied from interface: HttpRequestMessageBuilder

Matches a given query parameter.

Specified by:

matchesQuery in interface HttpRequestMessageBuilder<T extends HttpRequestMessageBuilder>

Parameters:

queryParameterName - name of the query parameter

queryParameterValue - value of query that should match

Returns:

a class that extends this

matchesBodyPayload

public T matchesBodyPayload(com.ca.codesv.sdk.function.Predicate<HttpPayload> bodyPredicate)

Description copied from interface: HttpRequestMessageBuilder

Matches a given body payload with Predicate.

Specified by:

matchesBodyPayload in interface HttpRequestMessageBuilder<T extends HttpRequestMessageBuilder>

Parameters:

bodyPredicate - predicate

Returns:

a class that extends this

matchesBody

public T matchesBody(com.ca.codesv.sdk.function.Predicate<java.lang.String> bodyPredicate)

Description copied from interface: HttpRequestMessageBuilder

Matches a given string body payload with Predicate.

Specified by:

matchesBody in interface HttpRequestMessageBuilder<T extends HttpRequestMessageBuilder>

Parameters:

bodyPredicate - predicate

Returns:

a class that extends this

matchesBody

public T matchesBody(java.lang.String body)

Description copied from interface: HttpRequestMessageBuilder

Matches a given string body payload.

Specified by:

matchesBody in interface HttpRequestMessageBuilder<T extends HttpRequestMessageBuilder>

Parameters:

body - text

Returns:

a class that extends this

matchesCookie

public T matchesCookie(java.lang.String cookieName,
                       com.ca.codesv.sdk.function.Predicate<java.lang.String> cookieValuePredicate)

Description copied from interface: HttpRequestMessageBuilder

Matches a given cookie value with Predicate.

Specified by:

matchesCookie in interface HttpRequestMessageBuilder<T extends HttpRequestMessageBuilder>

Parameters:

cookieName - name of the cookie

cookieValuePredicate - predicate

Returns:

a class that extends this

matchesCookie

public T matchesCookie(java.lang.String cookieName,
                       java.lang.String cookieValue)

Description copied from interface: HttpRequestMessageBuilder

Matches a given cookie value.

Specified by:

matchesCookie in interface HttpRequestMessageBuilder<T extends HttpRequestMessageBuilder>

Parameters:

cookieName - name of the cookie

cookieValue - value of the cookie

Returns:

a class that extends this

matchesAuthorization

public T matchesAuthorization(java.lang.String authorizationValue)

Description copied from interface: HttpRequestMessageBuilder

Matches Authorization HTTP header.

Specified by:

matchesAuthorization in interface HttpRequestMessageBuilder<T extends HttpRequestMessageBuilder>

Parameters:

authorizationValue - value of authorization header

Returns:

a class that extends this

matchesAuthorization

public T matchesAuthorization(org.hamcrest.Matcher<java.lang.String> authorizationValue)

Description copied from interface: HttpRequestMessageBuilder

Matches Authorization HTTP header with Matcher.

Specified by:

matchesAuthorization in interface HttpRequestMessageBuilder<T extends HttpRequestMessageBuilder>

Parameters:

authorizationValue - Matcher that matches a value of authorization header

Returns:

a class that extends this

matchesAuthorization

public T matchesAuthorization(com.ca.codesv.sdk.function.Predicate<java.lang.String> authorizationValuePredicate)

Description copied from interface: HttpRequestMessageBuilder

Matches Authorization HTTP header with Predicate.

Specified by:

matchesAuthorization in interface HttpRequestMessageBuilder<T extends HttpRequestMessageBuilder>

Parameters:

authorizationValuePredicate - predicate

Returns:

a class that extends this

matchesBasicAuthorization

public T matchesBasicAuthorization(com.ca.codesv.sdk.function.Predicate<java.lang.String> usernamePredicate,
                                   com.ca.codesv.sdk.function.Predicate<java.lang.String> passwordPredicate)

Description copied from interface: HttpRequestMessageBuilder

Matches Authorization HTTP header for Basic authorization with Predicate.

Specified by:

matchesBasicAuthorization in interface HttpRequestMessageBuilder<T extends HttpRequestMessageBuilder>

Parameters:

usernamePredicate - predicate for apiKey part of authorization header

passwordPredicate - predicate for apiSecret part of authorization header

Returns:

a class that extends this

matchesBasicAuthorization

public T matchesBasicAuthorization(java.lang.String username,
                                   java.lang.String password)

Description copied from interface: HttpRequestMessageBuilder

Matches Authorization HTTP header for Basic authorization.

Specified by:

matchesBasicAuthorization in interface HttpRequestMessageBuilder<T extends HttpRequestMessageBuilder>

Parameters:

username - apiKey

password - apiSecret

Returns:

a class that extends this

matchesPathParameter

public T matchesPathParameter(java.lang.String parameterName,
                              com.ca.codesv.sdk.function.Predicate<java.lang.String> parameterValuePredicate)

Description copied from interface: HttpRequestMessageBuilder

Matches a given path parameter value with Predicate.

Specified by:

matchesPathParameter in interface HttpRequestMessageBuilder<T extends HttpRequestMessageBuilder>

Parameters:

parameterName - name of the parameter

parameterValuePredicate - predicate

Returns:

a class that extends this

matchesPathParameter

public T matchesPathParameter(java.lang.String parameterName,
                              java.lang.String parameterValue)

Description copied from interface: HttpRequestMessageBuilder

Matches a given path parameter value.

Specified by:

matchesPathParameter in interface HttpRequestMessageBuilder<T extends HttpRequestMessageBuilder>

Parameters:

parameterName - name of the path parameter

parameterValue - value of path parameter

Returns:

a class that extends this

buildMatcherInternal

protected abstract RequestMessageMatcher buildMatcherInternal()

Builder of a request matcher.