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

Class LoggersSettings

java.lang.Object

org.apache.juneau.rest.server.management.LoggersSettings

public class LoggersSettings
extends Object

Exposure settings for the /loggers endpoint.

The GET (read) endpoints are always exposed; the PUT/POST set-level endpoints mutate runtime logging and are therefore deny-by-default on the same sensitive-by-default posture as the diagnostic dumps. A consumer opts in explicitly by registering a LoggersSettings bean (built with LoggersSettings.Builder.enableWrite()) in the resource's bean store. When no such bean is present, LoggersManager resolves the default (writes disabled) and the set-level endpoints respond 403 Forbidden.

Backend selection (explicit)

The /loggers endpoint drives a LogBackend. By default that is java.util.logging. To drive a different backend (e.g. Logback or Log4j2 via the juneau-rest-server-management-logging add-on), declare it explicitly with LoggersSettings.Builder.backend(LogBackend) — the endpoint never classpath-scans for, and then drives, a backend the operator did not choose.

See Also:

• LoggersManager
• LogBackend
• Management Surface (Actuator-style endpoints)

Since:

10.0.0

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final LoggersSettings	DEFAULT	The default (read-only, JUL-backed) settings used when no bean is registered.

Method Summary

Modifier and Type	Method	Description
static LoggersSettings.Builder	create()	Builder creator.
LogBackend	getBackend()
boolean	isWriteEnabled()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final LoggersSettings DEFAULT

The default (read-only, JUL-backed) settings used when no bean is registered.

Method Details

create

public static LoggersSettings.Builder create()

Builder creator.

Returns:

A new builder (writes disabled).

isWriteEnabled

public boolean isWriteEnabled()

Returns:

true if the PUT/POST set-level endpoints are enabled.

getBackend

public LogBackend getBackend()

Returns:

The explicitly-declared LogBackend the /loggers endpoint drives, or JulLogBackend.INSTANCE when none was declared. Never null.