com.ca.codesv.protocols.http.fluent

Class AbstractHttpRequestVerificationBuilder

java.lang.Object

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

com.ca.codesv.protocols.http.fluent.AbstractHttpRequestVerificationBuilder

All Implemented Interfaces:

HttpRequestMessageBuilder<HttpRequestVerificationBuilder>, HttpRequestVerificationBuilder, HttpVerificationBuilder

Direct Known Subclasses:

HttpRequestVerificationBuilderImpl

public abstract class AbstractHttpRequestVerificationBuilder
extends AbstractHttpRequestMessageBuilder<HttpRequestVerificationBuilder>
implements HttpRequestVerificationBuilder

HTTP Verification Builder.

Field Summary

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

apiWrapper

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
HttpRequestVerificationBuilder	absentBodyPayload() Matches absence of given body payload.
HttpRequestVerificationBuilder	absentCookie(java.lang.String name) Matches absence of given cookie.
HttpRequestVerificationBuilder	absentHeader(java.lang.String name) Matches absence of given header.
HttpRequestVerificationBuilder	absentQuery(java.lang.String name) Matches absence of given query parameter.
protected RequestMessageMatcher	buildMatcherInternal() Builder of a request matcher.
protected abstract void	buildVerification(RequestMessageMatcher requestMatcher, org.hamcrest.Matcher<java.lang.Integer> countMatcher) This is called when verification is being built.
void	invoked(int count) Provides a response message builder object.
void	invoked(org.hamcrest.Matcher<java.lang.Integer> countMatcher) Provides a response message builder object.
HttpRequestVerificationBuilder	matchesBasicAuthorization(org.hamcrest.Matcher<java.lang.String> usernameMatcher, org.hamcrest.Matcher<java.lang.String> passwordMatcher) Matches Authorization HTTP header for Basic authorization with Matcher.
HttpRequestVerificationBuilder	matchesBody(org.hamcrest.Matcher<java.lang.String> bodyMatcher) Matches a given string body payload with Matcher.
HttpRequestVerificationBuilder	matchesBodyFromFile(java.lang.String filePath) Matches a body from given file.
HttpRequestVerificationBuilder	matchesBodyPayload(org.hamcrest.Matcher<HttpPayload> bodyMatcher) Matches a given body payload with Matcher.
HttpRequestVerificationBuilder	matchesCookie(java.lang.String cookieName, org.hamcrest.Matcher<java.lang.String> cookieValueMatcher) Matches a given cookie value with Matcher.
HttpRequestVerificationBuilder	matchesHeader(java.lang.String name, org.hamcrest.Matcher<java.lang.String> matcher) Matches a given request header value with Matcher.
HttpRequestVerificationBuilder	matchesHeaderField(org.hamcrest.Matcher<java.lang.String> nameMatcher) Matches a given request header field name with Matcher.
HttpRequestVerificationBuilder	matchesHeaderFromFile(java.lang.String filePath, java.lang.String headerName) Matches a given request from file and specific header.
HttpRequestVerificationBuilder	matchesMessage(org.hamcrest.Matcher<com.ca.codesv.sdk.Request> requestMessage) Matches a given request object with Matcher.
HttpRequestVerificationBuilder	matchesPathParameter(java.lang.String parameterName, org.hamcrest.Matcher<java.lang.String> parameterMatcher) Matches a given path parameter value with Matcher.
HttpRequestVerificationBuilder	matchesQuery(java.lang.String queryParameterName, org.hamcrest.Matcher<java.lang.String> queryParameterMatcher) Matches a given query parameter with Matcher.
HttpRequestVerificationBuilder	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.HttpRequestMessageBuilder

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

Constructor Detail

AbstractHttpRequestVerificationBuilder

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

Method Detail

absentHeader

public HttpRequestVerificationBuilder absentHeader(java.lang.String name)

Description copied from interface: HttpRequestMessageBuilder

Matches absence of given header.

Specified by:

absentHeader in interface HttpRequestMessageBuilder<HttpRequestVerificationBuilder>

Parameters:

name - name of the header

Returns:

a class that extends this

absentQuery

public HttpRequestVerificationBuilder absentQuery(java.lang.String name)

Description copied from interface: HttpRequestMessageBuilder

Matches absence of given query parameter.

Specified by:

absentQuery in interface HttpRequestMessageBuilder<HttpRequestVerificationBuilder>

Parameters:

name - name of the query parameter

Returns:

a class that extends this

absentCookie

public HttpRequestVerificationBuilder absentCookie(java.lang.String name)

Description copied from interface: HttpRequestMessageBuilder

Matches absence of given cookie.

Specified by:

absentCookie in interface HttpRequestMessageBuilder<HttpRequestVerificationBuilder>

Parameters:

name - name of the cookie

Returns:

a class that extends this

usingRequestParser

public HttpRequestVerificationBuilder 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<HttpRequestVerificationBuilder>

Parameters:

parser - parser of Request

Returns:

a class that extends this

matchesMessage

public HttpRequestVerificationBuilder 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<HttpRequestVerificationBuilder>

Parameters:

requestMessage - Matcher that matches a Request

Returns:

a class that extends this

matchesHeader

public HttpRequestVerificationBuilder 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<HttpRequestVerificationBuilder>

Parameters:

name - name of the header

matcher - Matcher that matches a string

Returns:

a class that extends this

matchesHeaderField

public HttpRequestVerificationBuilder 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<HttpRequestVerificationBuilder>

Parameters:

nameMatcher - Matcher that matches a name of a header

Returns:

a class that extends this

matchesHeaderFromFile

public HttpRequestVerificationBuilder 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<HttpRequestVerificationBuilder>

Parameters:

filePath - path to HTTP request in txt file

headerName - name of the header

Returns:

a class that extends this

matchesQuery

public HttpRequestVerificationBuilder 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<HttpRequestVerificationBuilder>

Parameters:

queryParameterName - name of query parameter

queryParameterMatcher - Matcher that matches a value of query

Returns:

a class that extends this

matchesBodyPayload

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

Description copied from interface: HttpRequestMessageBuilder

Matches a given body payload with Matcher.

Specified by:

matchesBodyPayload in interface HttpRequestMessageBuilder<HttpRequestVerificationBuilder>

Parameters:

bodyMatcher - Matcher that matches a HttpPayload

Returns:

a class that extends this

absentBodyPayload

public HttpRequestVerificationBuilder absentBodyPayload()

Description copied from interface: HttpRequestMessageBuilder

Matches absence of given body payload.

Specified by:

absentBodyPayload in interface HttpRequestMessageBuilder<HttpRequestVerificationBuilder>

Returns:

a class that extends this

matchesBody

public HttpRequestVerificationBuilder 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<HttpRequestVerificationBuilder>

Parameters:

bodyMatcher - Matcher that matches a string body of Request

Returns:

a class that extends this

matchesBodyFromFile

public HttpRequestVerificationBuilder matchesBodyFromFile(java.lang.String filePath)

Description copied from interface: HttpRequestMessageBuilder

Matches a body from given file.

Specified by:

matchesBodyFromFile in interface HttpRequestMessageBuilder<HttpRequestVerificationBuilder>

Parameters:

filePath - path to HTTP request stored in txt file

Returns:

a class that extends this

matchesCookie

public HttpRequestVerificationBuilder 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<HttpRequestVerificationBuilder>

Parameters:

cookieName - name fo the cookie

cookieValueMatcher - Matcher that matches a value of the cookie

Returns:

a class that extends this

matchesBasicAuthorization

public HttpRequestVerificationBuilder 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<HttpRequestVerificationBuilder>

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 HttpRequestVerificationBuilder 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<HttpRequestVerificationBuilder>

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<HttpRequestVerificationBuilder>

invoked

public void invoked(org.hamcrest.Matcher<java.lang.Integer> countMatcher)

Description copied from interface: HttpVerificationBuilder

Provides a response message builder object.

Specified by:

invoked in interface HttpVerificationBuilder

Parameters:

countMatcher - Matcher which matches number of invocations

invoked

public void invoked(int count)

Description copied from interface: HttpVerificationBuilder

Provides a response message builder object.

Specified by:

invoked in interface HttpVerificationBuilder

Parameters:

count - number of invocations

buildVerification

protected abstract void buildVerification(RequestMessageMatcher requestMatcher,
                                          org.hamcrest.Matcher<java.lang.Integer> countMatcher)

This is called when verification is being built.