io.apimatic.core.configurations.http.client

Class ApiLoggingConfiguration.Builder

java.lang.Object

io.apimatic.core.configurations.http.client.ApiLoggingConfiguration.Builder

Enclosing class:

ApiLoggingConfiguration

public static class ApiLoggingConfiguration.Builder
extends Object

Class to build instances of ApiLoggingConfiguration.

Constructor Summary

Constructors

Constructor and Description
Builder() Default Constructor to initiate builder with default properties.

Method Summary

Modifier and Type	Method and Description
ApiLoggingConfiguration.Builder	addHeaderFilter(String header) Add given header as a filter for logging headers.
ApiLoggingConfiguration	build() Builds a new LoggingConfiguration object using the set fields.
ApiLoggingConfiguration.Builder	clearHeaderFilter() Clear all filters for headers.
ApiLoggingConfiguration.Builder	headerFilters(Set<String> headerFilters) Copy all from given collection to replace and set filters for headers.
ApiLoggingConfiguration.Builder	headerLoggingPolicy(io.apimatic.coreinterfaces.http.LoggingPolicy headerLoggingPolicy) Set logging policy for headers.
ApiLoggingConfiguration.Builder	level(io.apimatic.coreinterfaces.http.LoggingLevel level) Set level for logging.
ApiLoggingConfiguration.Builder	logEverything() Enable all logs.
ApiLoggingConfiguration.Builder	logNothing() Disable all logs.
ApiLoggingConfiguration.Builder	logRequestBody(boolean logRequestBody) Enable or disable logging of request body or form parameters.
ApiLoggingConfiguration.Builder	logRequestHeaders(boolean logRequestHeaders) Enable or disable logging of headers for requests.
ApiLoggingConfiguration.Builder	logRequestInfo(boolean logRequestInfo) Enable or disable logging of request info.
ApiLoggingConfiguration.Builder	logResponseBody(boolean logResponseBody) Enable or disable logging of response body.
ApiLoggingConfiguration.Builder	logResponseHeaders(boolean logResponseHeaders) Enable or disable logging of headers for responses.
ApiLoggingConfiguration.Builder	logResponseInfo(boolean logResponseInfo) Enable or disable logging of response info.
ApiLoggingConfiguration.Builder	prettyPrintLogs(boolean prettyPrintLogs) Enable or disable pretty printing for logging.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Default Constructor to initiate builder with default properties.

Method Detail

logRequestInfo

public ApiLoggingConfiguration.Builder logRequestInfo(boolean logRequestInfo)

Enable or disable logging of request info. Request info contains "url" and "method"

Parameters:

logRequestInfo - Whether to enable logging.

Returns:

ApiLoggingConfiguration.Builder.

logResponseInfo

public ApiLoggingConfiguration.Builder logResponseInfo(boolean logResponseInfo)

Enable or disable logging of response info. Response info contains "statusCode", "url", and "timeTaken".

Parameters:

logResponseInfo - Whether to enable logging.

Returns:

ApiLoggingConfiguration.Builder.

logRequestHeaders

public ApiLoggingConfiguration.Builder logRequestHeaders(boolean logRequestHeaders)

Enable or disable logging of headers for requests.

Parameters:

logRequestHeaders - Whether to enable logging.

Returns:

ApiLoggingConfiguration.Builder.

logResponseHeaders

public ApiLoggingConfiguration.Builder logResponseHeaders(boolean logResponseHeaders)

Enable or disable logging of headers for responses.

Parameters:

logResponseHeaders - Whether to enable logging.

Returns:

ApiLoggingConfiguration.Builder.

logRequestBody

public ApiLoggingConfiguration.Builder logRequestBody(boolean logRequestBody)

Enable or disable logging of request body or form parameters.

Parameters:

logRequestBody - Whether to enable logging.

Returns:

ApiLoggingConfiguration.Builder.

logResponseBody

public ApiLoggingConfiguration.Builder logResponseBody(boolean logResponseBody)

Enable or disable logging of response body.

Parameters:

logResponseBody - Whether to enable logging.

Returns:

ApiLoggingConfiguration.Builder.

logEverything

public ApiLoggingConfiguration.Builder logEverything()

Enable all logs.

Returns:

ApiLoggingConfiguration.Builder.

logNothing

public ApiLoggingConfiguration.Builder logNothing()

Disable all logs.

Returns:

ApiLoggingConfiguration.Builder.

prettyPrintLogs

public ApiLoggingConfiguration.Builder prettyPrintLogs(boolean prettyPrintLogs)

Enable or disable pretty printing for logging.

Parameters:

prettyPrintLogs - Boolean value to enable or disable.

Returns:

ApiLoggingConfiguration.Builder.

level

public ApiLoggingConfiguration.Builder level(io.apimatic.coreinterfaces.http.LoggingLevel level)

Set level for logging.

Parameters:

level - specify level of all logs.

Returns:

ApiLoggingConfiguration.Builder.

headerLoggingPolicy

public ApiLoggingConfiguration.Builder headerLoggingPolicy(io.apimatic.coreinterfaces.http.LoggingPolicy headerLoggingPolicy)

Set logging policy for headers.

Parameters:

headerLoggingPolicy - specify logging policy for headers.

Returns:

ApiLoggingConfiguration.Builder.

headerFilters

public ApiLoggingConfiguration.Builder headerFilters(Set<String> headerFilters)

Copy all from given collection to replace and set filters for headers.

Parameters:

headerFilters - Set of string headers.

Returns:

ApiLoggingConfiguration.Builder.

clearHeaderFilter

public ApiLoggingConfiguration.Builder clearHeaderFilter()

Clear all filters for headers.

Returns:

ApiLoggingConfiguration.Builder.

addHeaderFilter

public ApiLoggingConfiguration.Builder addHeaderFilter(String header)

Add given header as a filter for logging headers.

Parameters:

header - String header to be added as filter.

Returns:

ApiLoggingConfiguration.Builder.

build

public ApiLoggingConfiguration build()

Builds a new LoggingConfiguration object using the set fields.

Returns:

ApiLoggingConfiguration.