com.ca.codesv.protocols.http.fluent

Class AbstractHttpTransactionBuilder

java.lang.Object

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

com.ca.codesv.protocols.http.fluent.AbstractHttpTransactionBuilder

All Implemented Interfaces:

HttpRequestMessageBuilder<HttpTransactionBuilder>, HttpResponseBuilder, HttpTransactionBuilder

Direct Known Subclasses:

HttpTransactionBuilderImpl

public abstract class AbstractHttpTransactionBuilder
extends AbstractHttpRequestMessageBuilder<HttpTransactionBuilder>
implements HttpTransactionBuilder

HTTP Transaction Builder.

Field Summary

Fields inherited from class com.ca.codesv.protocols.http.fluent.AbstractHttpRequestMessageBuilder

apiWrapper

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractHttpTransactionBuilder(ApiWrapper apiWrapper, AbstractHttpRequestMessageBuilder<AbstractHttpRequestMessageBuilder> requestMessageBuilder)

Method Summary

Modifier and Type	Method and Description
HttpTransactionBuilder	absentBodyPayload() Matches absence of given body payload.
HttpTransactionBuilder	absentCookie(java.lang.String name) Matches absence of given cookie.
HttpTransactionBuilder	absentHeader(java.lang.String name) Matches absence of given header.
HttpTransactionBuilder	absentQuery(java.lang.String name) Matches absence of given query parameter.
protected RequestMessageMatcher	buildMatcherInternal() Builder of a request matcher.
protected abstract HttpTransactionVerificationBuilder	buildTransaction(RequestMessageMatcher requestMatcher, HttpResponseMessage responseMessage) This is called when transaction is being built.
protected abstract HttpTransactionVerificationBuilder	buildTransaction(RequestMessageMatcher requestMatcher, HttpResponseMessage responseMessage, boolean fromCloud) This is called when transaction is being built from dsl received from cloud repo.
HttpTransactionVerificationBuilder	doReturn(HttpResponseMessageBuilder responseMessageBuilder) Provides a response message builder object.
HttpTransactionBuilder	matchesBasicAuthorization(org.hamcrest.Matcher<java.lang.String> usernameMatcher, org.hamcrest.Matcher<java.lang.String> passwordMatcher) Matches Authorization HTTP header for Basic authorization with Matcher.
HttpTransactionBuilder	matchesBody(org.hamcrest.Matcher<java.lang.String> bodyMatcher) Matches a given string body payload with Matcher.
HttpTransactionBuilder	matchesBodyFromFile(java.lang.String filePath) Matches a body from given file.
HttpTransactionBuilder	matchesBodyPayload(org.hamcrest.Matcher<HttpPayload> bodyMatcher) Matches a given body payload with Matcher.
HttpTransactionBuilder	matchesCookie(java.lang.String cookieName, org.hamcrest.Matcher<java.lang.String> cookieValueMatcher) Matches a given cookie value with Matcher.
HttpTransactionBuilder	matchesHeader(java.lang.String name, org.hamcrest.Matcher<java.lang.String> matcher) Matches a given request header value with Matcher.
HttpTransactionBuilder	matchesHeaderField(org.hamcrest.Matcher<java.lang.String> nameMatcher) Matches a given request header field name with Matcher.
HttpTransactionBuilder	matchesHeaderFromFile(java.lang.String filePath, java.lang.String headerName) Matches a given request from file and specific header.
HttpTransactionBuilder	matchesMessage(org.hamcrest.Matcher<com.ca.codesv.sdk.Request> requestMessage) Matches a given request object with Matcher.
HttpTransactionBuilder	matchesPathParameter(java.lang.String parameterName, org.hamcrest.Matcher<java.lang.String> parameterMatcher) Matches a given path parameter value with Matcher.
HttpTransactionBuilder	matchesQuery(java.lang.String queryParameterName, org.hamcrest.Matcher<java.lang.String> queryParameterMatcher) Matches a given query parameter with Matcher.
HttpTransactionBuilder	usingRequestParser(com.ca.codesv.sdk.function.Consumer<com.ca.codesv.sdk.Request> parser) Adds custom request parser that modifies each received request.

Methods inherited from class com.ca.codesv.protocols.http.fluent.AbstractHttpRequestMessageBuilder

matchesAuthorization, matchesAuthorization, matchesAuthorization, matchesBasicAuthorization, matchesBasicAuthorization, matchesBody, matchesBody, matchesBodyPayload, matchesCookie, matchesCookie, matchesHeader, matchesHeader, matchesHeaderField, matchesHeaderField, matchesMessage, matchesPathParameter, matchesPathParameter, matchesQuery, matchesQuery

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.HttpTransactionBuilder

usingHttps

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

matchesAuthorization, matchesAuthorization, matchesAuthorization, matchesBasicAuthorization, matchesBasicAuthorization, matchesBody, matchesBody, matchesBodyPayload, matchesCookie, matchesCookie, matchesHeader, matchesHeader, matchesHeaderField, matchesHeaderField, matchesMessage, matchesPathParameter, matchesPathParameter, matchesQuery, matchesQuery

Constructor Detail

AbstractHttpTransactionBuilder

protected AbstractHttpTransactionBuilder(ApiWrapper apiWrapper,
                                         AbstractHttpRequestMessageBuilder<AbstractHttpRequestMessageBuilder> requestMessageBuilder)

Method Detail

usingRequestParser

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

Description copied from interface: HttpRequestMessageBuilder

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

Specified by:

usingRequestParser in interface HttpRequestMessageBuilder<HttpTransactionBuilder>

Parameters:

parser - parser of Request

Returns:

a class that extends this

matchesMessage

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

Description copied from interface: HttpRequestMessageBuilder

Matches a given request object with Matcher.

Specified by:

matchesMessage in interface HttpRequestMessageBuilder<HttpTransactionBuilder>

Parameters:

requestMessage - Matcher that matches a Request

Returns:

a class that extends this

matchesHeader

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

Description copied from interface: HttpRequestMessageBuilder

Matches a given request header value with Matcher.

Specified by:

matchesHeader in interface HttpRequestMessageBuilder<HttpTransactionBuilder>

Parameters:

name - name of the header

matcher - Matcher that matches a string

Returns:

a class that extends this

absentHeader

public HttpTransactionBuilder absentHeader(java.lang.String name)

Description copied from interface: HttpRequestMessageBuilder

Matches absence of given header.

Specified by:

absentHeader in interface HttpRequestMessageBuilder<HttpTransactionBuilder>

Parameters:

name - name of the header

Returns:

a class that extends this

matchesHeaderFromFile

public HttpTransactionBuilder matchesHeaderFromFile(java.lang.String filePath,
                                                    java.lang.String headerName)

Description copied from interface: HttpRequestMessageBuilder

Matches a given request from file and specific header.

Specified by:

matchesHeaderFromFile in interface HttpRequestMessageBuilder<HttpTransactionBuilder>

Parameters:

filePath - path to HTTP request in txt file

headerName - name of the header

Returns:

a class that extends this

matchesHeaderField

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

Description copied from interface: HttpRequestMessageBuilder

Matches a given request header field name with Matcher.

Specified by:

matchesHeaderField in interface HttpRequestMessageBuilder<HttpTransactionBuilder>

Parameters:

nameMatcher - Matcher that matches a name of a header

Returns:

a class that extends this

matchesQuery

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

Description copied from interface: HttpRequestMessageBuilder

Matches a given query parameter with Matcher.

Specified by:

matchesQuery in interface HttpRequestMessageBuilder<HttpTransactionBuilder>

Parameters:

queryParameterName - name of query parameter

queryParameterMatcher - Matcher that matches a value of query

Returns:

a class that extends this

absentQuery

public HttpTransactionBuilder absentQuery(java.lang.String name)

Description copied from interface: HttpRequestMessageBuilder

Matches absence of given query parameter.

Specified by:

absentQuery in interface HttpRequestMessageBuilder<HttpTransactionBuilder>

Parameters:

name - name of the query parameter

Returns:

a class that extends this

matchesBodyPayload

public HttpTransactionBuilder matchesBodyPayload(org.hamcrest.Matcher<HttpPayload> bodyMatcher)

Description copied from interface: HttpRequestMessageBuilder

Matches a given body payload with Matcher.

Specified by:

matchesBodyPayload in interface HttpRequestMessageBuilder<HttpTransactionBuilder>

Parameters:

bodyMatcher - Matcher that matches a HttpPayload

Returns:

a class that extends this

matchesBody

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

Description copied from interface: HttpRequestMessageBuilder

Matches a given string body payload with Matcher.

Specified by:

matchesBody in interface HttpRequestMessageBuilder<HttpTransactionBuilder>

Parameters:

bodyMatcher - Matcher that matches a string body of Request

Returns:

a class that extends this

absentBodyPayload

public HttpTransactionBuilder absentBodyPayload()

Description copied from interface: HttpRequestMessageBuilder

Matches absence of given body payload.

Specified by:

absentBodyPayload in interface HttpRequestMessageBuilder<HttpTransactionBuilder>

Returns:

a class that extends this

matchesBodyFromFile

public HttpTransactionBuilder matchesBodyFromFile(java.lang.String filePath)

Description copied from interface: HttpRequestMessageBuilder

Matches a body from given file.

Specified by:

matchesBodyFromFile in interface HttpRequestMessageBuilder<HttpTransactionBuilder>

Parameters:

filePath - path to HTTP request stored in txt file

Returns:

a class that extends this

matchesCookie

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

Description copied from interface: HttpRequestMessageBuilder

Matches a given cookie value with Matcher.

Specified by:

matchesCookie in interface HttpRequestMessageBuilder<HttpTransactionBuilder>

Parameters:

cookieName - name fo the cookie

cookieValueMatcher - Matcher that matches a value of the cookie

Returns:

a class that extends this

absentCookie

public HttpTransactionBuilder absentCookie(java.lang.String name)

Description copied from interface: HttpRequestMessageBuilder

Matches absence of given cookie.

Specified by:

absentCookie in interface HttpRequestMessageBuilder<HttpTransactionBuilder>

Parameters:

name - name of the cookie

Returns:

a class that extends this

matchesBasicAuthorization

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

Description copied from interface: HttpRequestMessageBuilder

Matches Authorization HTTP header for Basic authorization with Matcher.

Specified by:

matchesBasicAuthorization in interface HttpRequestMessageBuilder<HttpTransactionBuilder>

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

matchesPathParameter

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

Description copied from interface: HttpRequestMessageBuilder

Matches a given path parameter value with Matcher.

Specified by:

matchesPathParameter in interface HttpRequestMessageBuilder<HttpTransactionBuilder>

Parameters:

parameterName - name of the parameter

parameterMatcher - Matcher that matches a parameter

Returns:

a class that extends this

buildMatcherInternal

protected RequestMessageMatcher buildMatcherInternal()

Description copied from class: AbstractHttpRequestMessageBuilder

Builder of a request matcher.

Specified by:

buildMatcherInternal in class AbstractHttpRequestMessageBuilder<HttpTransactionBuilder>

doReturn

public HttpTransactionVerificationBuilder doReturn(HttpResponseMessageBuilder responseMessageBuilder)

Description copied from interface: HttpTransactionBuilder

Provides a response message builder object.

Specified by:

doReturn in interface HttpResponseBuilder

Specified by:

doReturn in interface HttpTransactionBuilder

Parameters:

responseMessageBuilder - builder used for building a Response

Returns:

HttpTransactionVerificationBuilder for next configuration

buildTransaction

protected abstract HttpTransactionVerificationBuilder buildTransaction(RequestMessageMatcher requestMatcher,
                                                                       HttpResponseMessage responseMessage)

This is called when transaction is being built.

buildTransaction

protected abstract HttpTransactionVerificationBuilder buildTransaction(RequestMessageMatcher requestMatcher,
                                                                       HttpResponseMessage responseMessage,
                                                                       boolean fromCloud)

This is called when transaction is being built from dsl received from cloud repo. For such transaction backwards upload is blocked.