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

package org.apache.juneau.rest.server.ops

Ops / introspection mixin pack — composable @Rest(mixins=...) resources that ship the operational surface (request echo, JVM admin, route index) every long-running Juneau service eventually grows.

Three sibling mixins compose into the host @Rest-annotated resource. Each mixin owns its default mount paths, ships secure-by-default (disabled-by-default for echo, deny-all-guard for admin), and is independently mountable; the three together drop in as a pack via @Rest(mixins={EchoMixin.class, AdminMixin.class, RouteIndexMixin.class}).

• EchoMixin — /echo/* request echo (SVL-configurable mount); sensitive headers (Authorization, Cookie, etc.) are redacted by default.
• AdminMixin — /admin/threads, /admin/heap, /admin/cache/flush (POST), and /admin/ratelimit; default-deny via DenyAllGuard until the importer registers an @Bean RestGuardList factory.
• RouteIndexMixin — /options (SVL-configurable mount) returning a JSON list of every @RestOp-annotated method on the host (plus mixins), excluding @OpSwagger(ignore=true) ops.

Composition example:

@Rest( path="/api", mixins={ EchoMixin.class, AdminMixin.class, RouteIndexMixin.class } ) public class ApiResource extends RestServlet { // Required: register an auth guard chain; replaces the deny-all default. @Bean(name="guards") public RestGuardList guards(BeanStore bs) { return RestGuardList.create(bs) .append(new MyAuthGuard()) .build(); } @Bean AdminMixin admin() { return AdminMixin.create() .cacheFlush("primary", () -> primaryCache.invalidateAll()) .build(); } }

All endpoints carry @OpSwagger(ignore=true) — ops endpoints are not API-meaningful and are excluded from any generated Swagger / OpenAPI spec.

See Also:

• REST Server — Mixins and Multi-Mount Paths

Since:

10.0.0

Related Packages

Package	Description
org.apache.juneau.rest.server	REST Server API

Classes

Class	Description
AdminMixin	Mixin that serves operational-introspection endpoints under /admin/*: thread dump, heap statistics, configurable cache-flush hooks, and rate-limit-bucket inspection.
AdminMixin.Builder	Builder for AdminMixin instances.
AdminProvider	Flavor-neutral operational-introspection worker bean shared by the admin @Rest flavors.
AdminProvider.Builder	Builder for AdminProvider instances.
AdminResource	Child-resource flavor of the AdminMixin mixin.
AdminServlet	Standalone servlet companion of the AdminMixin mixin.
EchoMixin	Mixin that serves a request-echo / round-trip introspection endpoint at /echo/* (configurable).
EchoMixin.Builder	Builder for EchoMixin instances.
ErrorMixin	Mixin providing the residual [* /error] endpoint.
HtdocMixin	Mixin providing the residual [GET /htdocs/*] static-file endpoint.
NavigationMixin	Mixin providing the group-navigation endpoint ([GET /]) that lists the host resource's child resources.
RouteIndexMixin	Mixin that exposes a content-negotiated index of all @RestOp-annotated methods on the host resource (and any other mixins on it) at /options (configurable).
StatsMixin	Mixin providing the residual [GET /stats] timing-statistics endpoint.