Package org.apache.juneau.rest.server.management

Class DumpsSettings

java.lang.Object

org.apache.juneau.rest.server.management.DumpsSettings

public class DumpsSettings
extends Object

Deny-by-default exposure settings for the diagnostic dump endpoints (/threaddump, /heapdump).

Both dumps are off by default on security grounds — a thread dump can leak sensitive state and a heap dump can be large and contain secrets. A consumer opts in explicitly by registering a DumpsSettings bean (built with DumpsSettings.Builder.enableThreadDump() / DumpsSettings.Builder.enableHeapDump()) in the resource's bean store. When no such bean is present, DumpsManager resolves the default (both disabled) and the endpoints respond 403 Forbidden.

See Also:

• DumpsManager
• Management Surface (Actuator-style endpoints)

Since:

10.0.0

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final DumpsSettings	DEFAULT	The default (deny-all) settings used when no bean is registered.

Method Summary

Modifier and Type	Method	Description
static DumpsSettings.Builder	create()	Builder creator.
boolean	isHeapDumpEnabled()
boolean	isThreadDumpEnabled()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final DumpsSettings DEFAULT

The default (deny-all) settings used when no bean is registered.

Method Details

create

public static DumpsSettings.Builder create()

Builder creator.

Returns:

A new builder (both dumps disabled).

isThreadDumpEnabled

public boolean isThreadDumpEnabled()

Returns:

true if the /threaddump endpoint is enabled.

isHeapDumpEnabled

public boolean isHeapDumpEnabled()

Returns:

true if the /heapdump endpoint is enabled.