Package org.apache.juneau.rest.client

Class BasicRestClientDebugFormatter

java.lang.Object

org.apache.juneau.rest.client.BasicRestClientDebugFormatter

All Implemented Interfaces:

RestClientDebugFormatter

public class BasicRestClientDebugFormatter
extends Object
implements RestClientDebugFormatter

Default RestClientDebugFormatter implementation — secure by default.

Request/response bodies are never dumped by default; dumping is a deliberate operator opt-in behind the JUNEAU_REST_DEBUG_ALLOW_DUMP_BODIES environment-variable master gate, mirroring org.apache.juneau.rest.server.logging.BasicRestDebugFormatter's server-side contract. See bodyScrubber(RestDebugBodyScrubber) and RestClientDebugFormatter.isBodyRenderable(String) for the rest of the pipeline.

Since:

10.0.0

Field Summary

Fields

Modifier and Type	Field	Description
protected int	bodyCap	The body capture cap in bytes.
protected RestDebugBodyScrubber	bodyScrubber	Optional body scrubber applied to body text when the master gate is set.
static final int	DEFAULT_BODY_CAP	Default body capture cap, in bytes (8 KB).
protected Set<String>	redactedHeaders	The set of header names whose values are masked.

Constructor Summary

Constructors

Constructor	Description
BasicRestClientDebugFormatter()	Constructor.

Method Summary

Modifier and Type	Method	Description
int	bodyCap()	Maximum number of request/response body bytes to capture for FINEST rendering.
BasicRestClientDebugFormatter	bodyCap(int value)	Overrides the body capture cap.
BasicRestClientDebugFormatter	bodyScrubber(RestDebugBodyScrubber value)	Sets the body scrubber applied to body text when the JUNEAU_REST_DEBUG_ALLOW_DUMP_BODIES gate is set.
String	formatBasic(RestRequest req, RestResponse res)	Renders the basic (INFO-tier) portion of a debug record.
String	formatBody(RestRequest req, RestResponse res)	Renders the body (FINEST-tier) portion of a debug record.
String	formatHeaders(RestRequest req, RestResponse res)	Renders the headers (FINE-tier) portion of a debug record.
BasicRestClientDebugFormatter	redactedHeaders(Collection<String> value)	Overrides the redacted-header set.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.juneau.rest.client.RestClientDebugFormatter

isBodyRenderable

Field Details

DEFAULT_BODY_CAP

public static final int DEFAULT_BODY_CAP

Default body capture cap, in bytes (8 KB).

See Also:

• Constant Field Values

redactedHeaders

protected Set<String> redactedHeaders

The set of header names whose values are masked.

bodyScrubber

protected RestDebugBodyScrubber bodyScrubber

Optional body scrubber applied to body text when the master gate is set.

bodyCap

protected int bodyCap

The body capture cap in bytes.

Constructor Details

BasicRestClientDebugFormatter

public BasicRestClientDebugFormatter()

Constructor.

Method Details

redactedHeaders

public BasicRestClientDebugFormatter redactedHeaders(Collection<String> value)

Overrides the redacted-header set.

Parameters:

value - The new set of header names to mask.

Returns:

This object.

bodyScrubber

public BasicRestClientDebugFormatter bodyScrubber(RestDebugBodyScrubber value)

Sets the body scrubber applied to body text when the JUNEAU_REST_DEBUG_ALLOW_DUMP_BODIES gate is set.

The scrubber only ever runs once dumping is already permitted by the gate; it chooses scrubbed-vs-raw body text. It is fail-closed: a throw or a null return yields a placeholder, never the raw body.

Parameters:

value - The scrubber, or null for none (the default, which dumps raw when gated).

Returns:

This object.

bodyCap

public BasicRestClientDebugFormatter bodyCap(int value)

Overrides the body capture cap.

Parameters:

value - The new cap in bytes.

Returns:

This object.

bodyCap

public int bodyCap()

Description copied from interface: RestClientDebugFormatter

Maximum number of request/response body bytes to capture for FINEST rendering.

Specified by:

bodyCap in interface RestClientDebugFormatter

Returns:

The capture cap in bytes.

formatBasic

public String formatBasic(RestRequest req,
 RestResponse res)

Description copied from interface: RestClientDebugFormatter

Renders the basic (INFO-tier) portion of a debug record.

Specified by:

formatBasic in interface RestClientDebugFormatter

Parameters:

req - The request.

res - The response.

Returns:

The formatted message chunk.

formatHeaders

public String formatHeaders(RestRequest req,
 RestResponse res)

Description copied from interface: RestClientDebugFormatter

Renders the headers (FINE-tier) portion of a debug record.

Specified by:

formatHeaders in interface RestClientDebugFormatter

Parameters:

req - The request.

res - The response.

Returns:

The formatted message chunk.

formatBody

public String formatBody(RestRequest req,
 RestResponse res)

Description copied from interface: RestClientDebugFormatter

Renders the body (FINEST-tier) portion of a debug record.

Specified by:

formatBody in interface RestClientDebugFormatter

Parameters:

req - The request.

res - The response.

Returns:

The formatted message chunk.