Class LoggersMixin
/loggers runtime log-level management endpoint.
Composes the logger read/set endpoints into a host resource via
@Rest(mixins=LoggersMixin.class). Delegates to a shared LoggersManager
worker so the mixin and resource flavors cannot drift.
The mixin is annotated with @Rest(guards=DenyAllGuard.class), so every logger path returns
403 Forbidden until the importer registers a @Bean
RestGuardList factory on the host; that list replaces the annotation-derived deny-all, so pair the
mixin with whatever authentication/authorization the app applies to its management endpoints. Changing a level
through the PUT/POST set-level endpoint additionally requires a LoggersSettings bean with
writes enabled.
Backend:
- Drives
java.util.loggingby default; declare a Logback / Log4j2 backend explicitly viaLoggersSettings.Builder.backend(LogBackend)— seeLogBackend.
See Also:
- Since:
- 10.0.0
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.juneau.rest.server.servlet.RestMixin
RestMixin.Builder<R extends RestMixin,SELF extends RestMixin.Builder<R, SELF>>, RestMixin.DefaultBuilder<R extends RestMixin> -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetLogger(RestRequest req, String name) [GET /loggers/{name}] - One logger's configured level.getLoggers(RestRequest req) [GET /loggers] - All loggers and their configured levels.setLogger(RestRequest req, String name, String level) [PUT /loggers/{name}] - Set a logger's level at runtime.setLoggerPost(RestRequest req, String name, String level) [POST /loggers/{name}] - Set a logger's level at runtime (POST alias ofsetLogger(RestRequest,String,String)).Methods inherited from class org.apache.juneau.rest.server.servlet.RestMixin
builder, getHostContext, getRestBuilder, setContext
-
Constructor Details
-
LoggersMixin
public LoggersMixin()
-
-
Method Details
-
getLoggers
[GET /loggers] - All loggers and their configured levels.- Parameters:
req- The HTTP request.- Returns:
- A sorted map of logger name to configured level (empty string = inherited).
-
getLogger
[GET /loggers/{name}] - One logger's configured level.- Parameters:
req- The HTTP request.name- The logger name ("ROOT" for the root logger).- Returns:
- The configured level name, empty string if inherited.
- Throws:
NotFound- If no logger with that name is registered.
-
setLogger
[PUT /loggers/{name}] - Set a logger's level at runtime.Sensitive (mutating) — deny-by-default: responds
403unless aLoggersSettingsbean with writes enabled is registered.- Parameters:
req- The HTTP request.name- The logger name ("ROOT" for the root logger).level- The level name (e.g. FINE, INFO, OFF), or blank to inherit from the ancestor.- Returns:
- The newly-configured level (empty string if inherited).
- Throws:
Forbidden- If the set-level endpoint is not enabled.
-
setLoggerPost
[POST /loggers/{name}] - Set a logger's level at runtime (POST alias ofsetLogger(RestRequest,String,String)).- Parameters:
req- The HTTP request.name- The logger name ("ROOT" for the root logger).level- The level name, or blank to inherit.- Returns:
- The newly-configured level (empty string if inherited).
- Throws:
Forbidden- If the set-level endpoint is not enabled.
-