Package org.apache.juneau.rest.server.ops

Class EchoMixin.Builder

java.lang.Object

org.apache.juneau.rest.server.ops.EchoMixin.Builder

Enclosing class:

EchoMixin

public static class EchoMixin.Builder
extends Object

Builder for EchoMixin instances.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Constructor — package access for EchoMixin.create().

Method Summary

Modifier and Type	Method	Description
EchoMixin.Builder	bodyLimit(long value)	Sets the body capture cap.
EchoMixin	build()	Builds a EchoMixin instance.
EchoMixin.Builder	enabled()	Enables the /echo/* endpoint — shorthand for enabled(Boolean.TRUE).
EchoMixin.Builder	enabled(Boolean value)	Sets the explicit enablement tri-state for the /echo/* endpoint.
EchoMixin.Builder	redactedHeaders(String... values)	Replaces the redacted-header set with the supplied values.
EchoMixin.Builder	redactHeader(String value)	Adds an additional header name to the redacted-header set.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder()

Constructor — package access for EchoMixin.create().

Method Details

enabled

public EchoMixin.Builder enabled(Boolean value)

Sets the explicit enablement tri-state for the /echo/* endpoint.

This is a non-logging switch that is independent of the JUL logger level. The default is unset (null), which defers to the ${juneau.echo.enabled:false} deployment fallback (system property / relaxed environment variable) — see the class-level Javadoc for the resolution rules and the global-fallback blast-radius warning.

Parameters:

value - Boolean.TRUE to enable, Boolean.FALSE to explicitly disable (overriding the global fallback), or null to leave unset (defer to the fallback).

Returns:

This object.

enabled

public EchoMixin.Builder enabled()

Enables the /echo/* endpoint — shorthand for enabled(Boolean.TRUE).

Returns:

This object.

bodyLimit

public EchoMixin.Builder bodyLimit(long value)

Sets the body capture cap.

Captured content is truncated when the inbound body exceeds this size; the truncated flag in the response is set to true.

Parameters:

value - Cap, in bytes. Must be >= 0.

Returns:

This object.

redactedHeaders

public EchoMixin.Builder redactedHeaders(String... values)

Replaces the redacted-header set with the supplied values.

Header names are matched case-insensitively. Pass an empty array to disable redaction (not recommended outside of integration tests).

Parameters:

values - The header names to redact. Can be null (equivalent to an empty array — disables redaction); null or blank elements are skipped.

Returns:

This object.

redactHeader

public EchoMixin.Builder redactHeader(String value)

Adds an additional header name to the redacted-header set.

Parameters:

value - The header name to redact (case-insensitive). Must not be null or blank.

Returns:

This object.

build

public EchoMixin build()

Builds a EchoMixin instance.

Returns:

A configured instance.