com.paypal.sdk.logging.configuration

Class ApiRequestLoggingConfiguration

java.lang.Object

com.paypal.sdk.logging.configuration.ApiRequestLoggingConfiguration

All Implemented Interfaces:

ReadonlyRequestLoggingConfiguration

public class ApiRequestLoggingConfiguration
extends Object
implements ReadonlyRequestLoggingConfiguration

Class to hold request logging configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApiRequestLoggingConfiguration.Builder Builder class for ApiRequestLoggingConfiguration.

Method Summary

Modifier and Type	Method and Description
List<String>	getHeadersToExclude() Gets the list of headers to exclude from logging.
List<String>	getHeadersToInclude() Gets the list of headers to include in logging.
List<String>	getHeadersToUnmask() Retrieves the list of headers to unmask from sensitive headers.
ApiRequestLoggingConfiguration.Builder	newBuilder() Builds a new ApiRequestLoggingConfiguration.Builder object.
boolean	shouldIncludeQueryInPath() Checks if query parameters are included in the request path.
boolean	shouldLogBody() Checks if logging of request body is enabled.
boolean	shouldLogHeaders() Checks if logging of request headers is enabled.
String	toString() Converts ApiRequestLoggingConfiguration into string format.

Methods inherited from class java.lang.Object

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

Method Detail

shouldLogBody

public boolean shouldLogBody()

Checks if logging of request body is enabled.

Specified by:

shouldLogBody in interface ReadonlyRequestLoggingConfiguration

Returns:

True if logging of request body is enabled, otherwise false.

shouldLogHeaders

public boolean shouldLogHeaders()

Checks if logging of request headers is enabled.

Specified by:

shouldLogHeaders in interface ReadonlyRequestLoggingConfiguration

Returns:

True if logging of request headers is enabled, otherwise false.

getHeadersToInclude

public List<String> getHeadersToInclude()

Gets the list of headers to include in logging.

Specified by:

getHeadersToInclude in interface ReadonlyRequestLoggingConfiguration

Returns:

An unmodifiable list of headers to include.

getHeadersToExclude

public List<String> getHeadersToExclude()

Gets the list of headers to exclude from logging.

Specified by:

getHeadersToExclude in interface ReadonlyRequestLoggingConfiguration

Returns:

An unmodifiable list of headers to exclude.

getHeadersToUnmask

public List<String> getHeadersToUnmask()

Retrieves the list of headers to unmask from sensitive headers. These headers are excluded from masking.

Returns:

An unmodifiable list of headers to unmasked.

shouldIncludeQueryInPath

public boolean shouldIncludeQueryInPath()

Checks if query parameters are included in the request path.

Specified by:

shouldIncludeQueryInPath in interface ReadonlyRequestLoggingConfiguration

Returns:

True if query parameters are included in the path, otherwise false.

toString

public String toString()

Converts ApiRequestLoggingConfiguration into string format.

Overrides:

toString in class Object

Returns:

String representation of this class.

newBuilder

public ApiRequestLoggingConfiguration.Builder newBuilder()

Builds a new ApiRequestLoggingConfiguration.Builder object. Creates the instance with the current state.

Returns:

a new ApiRequestLoggingConfiguration.Builder object.