io.restassured.config

Class LogConfig

java.lang.Object

io.restassured.config.LogConfig

All Implemented Interfaces:

Config

public class LogConfig
extends Object
implements Config

Configure the logging for REST Assured.

Note that only things known to REST Assured (i.e. the request- and response specifications) will be logged. If you need to log what's actually sent on the wire refer to the HTTP Client logging docs or use an external tool such as Wireshark.

Constructor Summary

Constructors

Constructor and Description
LogConfig() Configure the default stream to use the System.out stream (default).
LogConfig(PrintStream defaultPrintStream, boolean prettyPrintingEnabled) Configure pretty printing and the default stream where logs should be written if not specified explicitly by a filter.

Method Summary

Modifier and Type	Method and Description
LogConfig	and() Syntactic sugar.
Set<String>	blacklistedHeaders()
LogConfig	blacklistHeader(String header, String... otherHeaders) Blacklist one or more headers.
LogConfig	blacklistHeaders(Collection<String> headers) Blacklist one or more headers.
PrintStream	defaultStream()
LogConfig	defaultStream(PrintStream printStream) Specify a new default stream to the print to.
LogConfig	enableLoggingOfRequestAndResponseIfValidationFails() Enable logging of both the request and the response if REST Assureds test validation fails.
LogConfig	enableLoggingOfRequestAndResponseIfValidationFails(LogDetail logDetail) Enable logging of both the request and the response if REST Assureds test validation fails with the specified log detail
LogConfig	enablePrettyPrinting(boolean shouldEnable) Specify a whether or not to enable pretty printing by default.
boolean	isLoggingOfRequestAndResponseIfValidationFailsEnabled()
boolean	isPrettyPrintingEnabled()
boolean	isUserConfigured()
static LogConfig	logConfig()
LogDetail	logDetailOfRequestAndResponseIfValidationFails()
boolean	shouldUrlEncodeRequestUri()
LogConfig	urlEncodeRequestUri(boolean urlEncodeRequestUri) Instruct REST Assured whether or not to URL encode the request URI when it's presented in the request specification log.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogConfig

public LogConfig()

Configure the default stream to use the System.out stream (default).

LogConfig

public LogConfig(PrintStream defaultPrintStream,
                 boolean prettyPrintingEnabled)

Configure pretty printing and the default stream where logs should be written if not specified explicitly by a filter. I.e. this stream will be used in cases where the log specification DSL is used, e.g.

 given().log().all()...
 

or

 expect().log.ifError(). ..
 

It will not override explicit streams defined by using the RequestLoggingFilter or the ResponseLoggingFilter.

Parameters:

defaultPrintStream - The default print stream to use for the LogSpecification's.

prettyPrintingEnabled - Enable or disable pretty printing when logging. Pretty printing is only possible when content-type is XML, JSON or HTML.

Method Detail

defaultStream

public PrintStream defaultStream()

Returns:

The default stream to use

blacklistedHeaders

public Set<String> blacklistedHeaders()

Returns:

The blacklisted headers

See Also:

blacklistHeader(String, String...)

defaultStream

public LogConfig defaultStream(PrintStream printStream)

Specify a new default stream to the print to.

Parameters:

printStream - The stream

Returns:

A new LogConfig instance

isPrettyPrintingEnabled

public boolean isPrettyPrintingEnabled()

Returns:

true if pretty printing is enabled, false otherwise.

isLoggingOfRequestAndResponseIfValidationFailsEnabled

public boolean isLoggingOfRequestAndResponseIfValidationFailsEnabled()

Returns:

true if request and response logging is enabled if test validation fails, false otherwise.

logDetailOfRequestAndResponseIfValidationFails

public LogDetail logDetailOfRequestAndResponseIfValidationFails()

Returns:

The log detail to use if request and response logging is enabled if test validation fails.

enablePrettyPrinting

public LogConfig enablePrettyPrinting(boolean shouldEnable)

Specify a whether or not to enable pretty printing by default.

Parameters:

shouldEnable - true if pretty-printing should be enabled, false otherwise.

Returns:

A new LogConfig instance

enableLoggingOfRequestAndResponseIfValidationFails

public LogConfig enableLoggingOfRequestAndResponseIfValidationFails()

Enable logging of both the request and the response if REST Assureds test validation fails.

Returns:

A new LogConfig instance

enableLoggingOfRequestAndResponseIfValidationFails

public LogConfig enableLoggingOfRequestAndResponseIfValidationFails(LogDetail logDetail)

Enable logging of both the request and the response if REST Assureds test validation fails with the specified log detail

Parameters:

logDetail - The log detail to show in the log

Returns:

A new LogConfig instance

urlEncodeRequestUri

public LogConfig urlEncodeRequestUri(boolean urlEncodeRequestUri)

Instruct REST Assured whether or not to URL encode the request URI when it's presented in the request specification log. By default url encoding of the request uri is enabled to show what the URL targeted by REST Assured actually looks like for real. But there may be cases where you want to make the URI more readable and this is when you might want to consider setting urlEncodeRequestUri to false. Note that this only affects logging.

Parameters:

urlEncodeRequestUri - Whether or not to url encode the request uri when it's presented in the request log

Returns:

A new LogConfig instance

blacklistHeader

public LogConfig blacklistHeader(String header,
                                 String... otherHeaders)

Blacklist one or more headers. If these headers show up during logging they will be replaced with 'HIDDEN'. The purpose of a blacklist is to prevent sensitive information to be included in the log.

Parameters:

header - The header to include in the blacklist

otherHeaders - Additional headers to include in the blacklist (optional)

Returns:

A new LogConfig instance

blacklistHeaders

public LogConfig blacklistHeaders(Collection<String> headers)

Blacklist one or more headers. If these headers show up during logging they will be hidden. The purpose of a blacklist is to prevent sensitive information to be included in the log. Note that this method replaces the previously defined blacklist.

Parameters:

headers - The headers to include in the blacklist

Returns:

A new LogConfig instance

shouldUrlEncodeRequestUri

public boolean shouldUrlEncodeRequestUri()

Returns:

true is the request URI should be URL encoded in the request log

logConfig

public static LogConfig logConfig()

Returns:

A static way to create a new LogConfig instance without calling "new" explicitly. Mainly for syntactic sugar.

and

public LogConfig and()

Syntactic sugar.

Returns:

The same log config instance.

isUserConfigured

public boolean isUserConfigured()

Specified by:

isUserConfigured in interface Config

Returns:

true if this config instance has been explicitly configured by the user, false if it has the default values.