io.restassured.specification

Interface LogSpecification<T>

All Known Subinterfaces:

RequestLogSpecification, ResponseLogSpecification

All Known Implementing Classes:

RequestLogSpecificationImpl, ResponseLogSpecificationImpl

public interface LogSpecification<T>

Base interface for request- and response log specifications.

Method Summary

Modifier and Type	Method and Description
T	all() Logs everything in the specification, including e.g.
T	all(boolean shouldPrettyPrint) Logs everything in the specification, including e.g.
T	body() Logs only the content of the body.
T	body(boolean shouldPrettyPrint) Logs only the content of the body and pretty-print the body if specified.
T	cookies() Logs only the cookies.
T	everything() * Logs everything in the specification, including e.g.
T	everything(boolean shouldPrettyPrint) * Logs everything in the specification, including e.g.
T	headers() Logs only the headers.
T	ifValidationFails() Logs everything if a test validation fails.
T	ifValidationFails(LogDetail logDetail) Logs with the supplied log detail only if the validation fails.
T	ifValidationFails(LogDetail logDetail, boolean shouldPrettyPrint) Logs all parameters only if the validations fail.

Method Detail

body

T body()

Logs only the content of the body. The body will be pretty-printed by default if content-type is either XML, JSON or HTML.

Returns:

The specification

body

T body(boolean shouldPrettyPrint)

Logs only the content of the body and pretty-print the body if specified. Note that pretty-printing can only take place if the content-type is either XML, JSON or HTML.

Parameters:

shouldPrettyPrint - true if the body should be pretty-printed, false otherwise.

Returns:

The specification

all

T all()

Logs everything in the specification, including e.g. headers, cookies, body. Pretty-prints the body if content-type is either either XML, JSON or HTML..

Returns:

The specification

all

T all(boolean shouldPrettyPrint)

Logs everything in the specification, including e.g. headers, cookies, body with the option to pretty-print the body if the content-type is either XML, JSON or HTML..

Parameters:

shouldPrettyPrint - true if the body should be pretty-printed, false otherwise.

Returns:

The specification

everything

T everything()

* Logs everything in the specification, including e.g. headers, cookies, body. Pretty-prints the body if content-type is either either XML, JSON or HTML..

Returns:

The specification

everything

T everything(boolean shouldPrettyPrint)

* Logs everything in the specification, including e.g. headers, cookies, body with the option to pretty-print the body if the content-type is either XML, JSON or HTML..

Parameters:

shouldPrettyPrint - true if the body should be pretty-printed, false otherwise.

Returns:

The specification

headers

T headers()

Logs only the headers.

Returns:

The specification

cookies

T cookies()

Logs only the cookies.

Returns:

The specification

ifValidationFails

T ifValidationFails()

Logs everything if a test validation fails.

Returns:

The specification

ifValidationFails

T ifValidationFails(LogDetail logDetail)

Logs with the supplied log detail only if the validation fails.

Parameters:

logDetail - The log detail

Returns:

The specification

ifValidationFails

T ifValidationFails(LogDetail logDetail,
                    boolean shouldPrettyPrint)

Logs all parameters only if the validations fail.

Parameters:

logDetail - The log detail

shouldPrettyPrint - true if the body should be pretty-printed, false otherwise.

Returns:

The specification