com.ca.codesv.protocols.http.fluent

Interface HttpRequestMessageBuilder<T extends HttpRequestMessageBuilder>

All Known Subinterfaces:

HttpRequestVerificationBuilder, HttpTransactionBuilder

All Known Implementing Classes:

AbstractHttpRequestMessageBuilder, AbstractHttpRequestVerificationBuilder, AbstractHttpTransactionBuilder, HttpRequestMessageBuilderImpl, HttpRequestVerificationBuilderImpl, HttpTransactionBuilderImpl

public interface HttpRequestMessageBuilder<T extends HttpRequestMessageBuilder>

HTTP Request message builder interface.

Method Summary

Modifier and Type	Method and Description
T	absentBodyPayload() Matches absence of given body payload.
T	absentCookie(java.lang.String name) Matches absence of given cookie.
T	absentHeader(java.lang.String name) Matches absence of given header.
T	absentQuery(java.lang.String name) Matches absence of given query parameter.
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(org.hamcrest.Matcher<java.lang.String> usernameMatcher, org.hamcrest.Matcher<java.lang.String> passwordMatcher) Matches Authorization HTTP header for Basic authorization with Matcher.
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(org.hamcrest.Matcher<java.lang.String> bodyMatcher) Matches a given string body payload with Matcher.
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	matchesBodyFromFile(java.lang.String filePath) Matches a body from given file.
T	matchesBodyPayload(org.hamcrest.Matcher<HttpPayload> bodyMatcher) Matches a given body payload with Matcher.
T	matchesBodyPayload(com.ca.codesv.sdk.function.Predicate<HttpPayload> bodyPredicate) Matches a given body payload with Predicate.
T	matchesCookie(java.lang.String cookieName, org.hamcrest.Matcher<java.lang.String> cookieValueMatcher) Matches a given cookie value with Matcher.
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, org.hamcrest.Matcher<java.lang.String> matcher) Matches a given request header value with Matcher.
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(org.hamcrest.Matcher<java.lang.String> nameMatcher) Matches a given request header field name with Matcher.
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	matchesHeaderFromFile(java.lang.String filePath, java.lang.String headerName) Matches a given request from file and specific header.
T	matchesMessage(org.hamcrest.Matcher<com.ca.codesv.sdk.Request> requestMessage) Matches a given request object with Matcher.
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, org.hamcrest.Matcher<java.lang.String> parameterMatcher) Matches a given path parameter value with Matcher.
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, org.hamcrest.Matcher<java.lang.String> queryParameterMatcher) Matches a given query parameter with Matcher.
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.
T	usingRequestParser(com.ca.codesv.sdk.function.Consumer<com.ca.codesv.sdk.Request> parser) Adds custom request parser that modifies each received request.

Method Detail

usingRequestParser

T usingRequestParser(com.ca.codesv.sdk.function.Consumer<com.ca.codesv.sdk.Request> parser)

Adds custom request parser that modifies each received request. Request object is mutable.

Parameters:

parser - parser of Request

Returns:

a class that extends this

matchesMessage

T matchesMessage(org.hamcrest.Matcher<com.ca.codesv.sdk.Request> requestMessage)

Matches a given request object with Matcher.

Parameters:

requestMessage - Matcher that matches a Request

Returns:

a class that extends this

matchesMessage

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

Matches a given request object with Predicate.

Parameters:

requestMessage - Matcher that matches a Request

Returns:

a class that extends this

matchesHeader

T matchesHeader(java.lang.String name,
                org.hamcrest.Matcher<java.lang.String> matcher)

Matches a given request header value with Matcher.

Parameters:

name - name of the header

matcher - Matcher that matches a string

Returns:

a class that extends this

matchesHeader

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

Matches a given request header value with Predicate.

Parameters:

name - name of the header

predicate - predicate

Returns:

a class that extends this

matchesHeader

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

Matches a given request header value.

Parameters:

name - name of the header

value - value of specified header

Returns:

a class that extends this

absentHeader

T absentHeader(java.lang.String name)

Matches absence of given header.

Parameters:

name - name of the header

Returns:

a class that extends this

matchesHeaderFromFile

T matchesHeaderFromFile(java.lang.String filePath,
                        java.lang.String headerName)

Matches a given request from file and specific header.

Parameters:

filePath - path to HTTP request in txt file

headerName - name of the header

Returns:

a class that extends this

matchesHeaderField

T matchesHeaderField(org.hamcrest.Matcher<java.lang.String> nameMatcher)

Matches a given request header field name with Matcher.

Parameters:

nameMatcher - Matcher that matches a name of a header

Returns:

a class that extends this

matchesHeaderField

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

Matches a given request header field name with Predicate.

Parameters:

namePredicate - predicate

Returns:

a class that extends this

matchesHeaderField

T matchesHeaderField(java.lang.String name)

Matches a given request header field name.

Parameters:

name - name of the header

Returns:

a class that extends this

matchesQuery

T matchesQuery(java.lang.String queryParameterName,
               org.hamcrest.Matcher<java.lang.String> queryParameterMatcher)

Matches a given query parameter with Matcher.

Parameters:

queryParameterName - name of query parameter

queryParameterMatcher - Matcher that matches a value of query

Returns:

a class that extends this

matchesQuery

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

Matches a given query parameter with Predicate.

Parameters:

queryParameterName - name of the query parameter

queryParameterPredicate - predicate

Returns:

a class that extends this

matchesQuery

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

Matches a given query parameter.

Parameters:

queryParameterName - name of the query parameter

queryParameterValue - value of query that should match

Returns:

a class that extends this

absentQuery

T absentQuery(java.lang.String name)

Matches absence of given query parameter.

Parameters:

name - name of the query parameter

Returns:

a class that extends this

matchesBodyPayload

T matchesBodyPayload(org.hamcrest.Matcher<HttpPayload> bodyMatcher)

Matches a given body payload with Matcher.

Parameters:

bodyMatcher - Matcher that matches a HttpPayload

Returns:

a class that extends this

matchesBodyPayload

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

Matches a given body payload with Predicate.

Parameters:

bodyPredicate - predicate

Returns:

a class that extends this

absentBodyPayload

T absentBodyPayload()

Matches absence of given body payload.

Returns:

a class that extends this

matchesBody

T matchesBody(org.hamcrest.Matcher<java.lang.String> bodyMatcher)

Matches a given string body payload with Matcher.

Parameters:

bodyMatcher - Matcher that matches a string body of Request

Returns:

a class that extends this

matchesBody

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

Matches a given string body payload with Predicate.

Parameters:

bodyPredicate - predicate

Returns:

a class that extends this

matchesBody

T matchesBody(java.lang.String body)

Matches a given string body payload.

Parameters:

body - text

Returns:

a class that extends this

matchesBodyFromFile

T matchesBodyFromFile(java.lang.String filePath)

Matches a body from given file.

Parameters:

filePath - path to HTTP request stored in txt file

Returns:

a class that extends this

matchesCookie

T matchesCookie(java.lang.String cookieName,
                org.hamcrest.Matcher<java.lang.String> cookieValueMatcher)

Matches a given cookie value with Matcher.

Parameters:

cookieName - name fo the cookie

cookieValueMatcher - Matcher that matches a value of the cookie

Returns:

a class that extends this

matchesCookie

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

Matches a given cookie value with Predicate.

Parameters:

cookieName - name of the cookie

cookieValuePredicate - predicate

Returns:

a class that extends this

matchesCookie

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

Matches a given cookie value.

Parameters:

cookieName - name of the cookie

cookieValue - value of the cookie

Returns:

a class that extends this

absentCookie

T absentCookie(java.lang.String name)

Matches absence of given cookie.

Parameters:

name - name of the cookie

Returns:

a class that extends this

matchesAuthorization

T matchesAuthorization(java.lang.String authorizationValue)

Matches Authorization HTTP header.

Parameters:

authorizationValue - value of authorization header

Returns:

a class that extends this

matchesAuthorization

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

Matches Authorization HTTP header with Matcher.

Parameters:

authorizationValue - Matcher that matches a value of authorization header

Returns:

a class that extends this

matchesAuthorization

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

Matches Authorization HTTP header with Predicate.

Parameters:

authorizationValuePredicate - predicate

Returns:

a class that extends this

matchesBasicAuthorization

T matchesBasicAuthorization(org.hamcrest.Matcher<java.lang.String> usernameMatcher,
                            org.hamcrest.Matcher<java.lang.String> passwordMatcher)

Matches Authorization HTTP header for Basic authorization with Matcher.

Parameters:

usernameMatcher - Matcher that matches a apiKey part of authorization header

passwordMatcher - Matcher that matches a apiSecret part of authorization header

Returns:

a class that extends this

matchesBasicAuthorization

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.

Parameters:

usernamePredicate - predicate for apiKey part of authorization header

passwordPredicate - predicate for apiSecret part of authorization header

Returns:

a class that extends this

matchesBasicAuthorization

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

Matches Authorization HTTP header for Basic authorization.

Parameters:

username - apiKey

password - apiSecret

Returns:

a class that extends this

matchesPathParameter

T matchesPathParameter(java.lang.String parameterName,
                       org.hamcrest.Matcher<java.lang.String> parameterMatcher)

Matches a given path parameter value with Matcher.

Parameters:

parameterName - name of the parameter

parameterMatcher - Matcher that matches a parameter

Returns:

a class that extends this

matchesPathParameter

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

Matches a given path parameter value with Predicate.

Parameters:

parameterName - name of the parameter

parameterValuePredicate - predicate

Returns:

a class that extends this

matchesPathParameter

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

Matches a given path parameter value.

Parameters:

parameterName - name of the path parameter

parameterValue - value of path parameter

Returns:

a class that extends this