Uses of Class
org.apache.juneau.rest.server.RestRequest

Packages that use RestRequest

Package	Description
org.apache.juneau.console	Engine-agnostic themeable admin-console chrome: Theme, the stock theme stylesheets, the bundled chrome.css asset, and ConsoleChromeMixin.
org.apache.juneau.console.bus	Server half of the console message bus.
org.apache.juneau.console.data	Server helpers for console data sources: SeriesSource streams rows as CSV or NDJSON, and SeriesAggregator answers the aggregate request a data source sends when its result is too large to load raw.
org.apache.juneau.console.freemarker	FreeMarker-only delivery of the admin-console chrome: the reserved-classpath base.ftlh template, the <@tag> macro, and ConsoleFreemarkerMixin (registers a reserved-path ClassTemplateLoader on top of the host's own FreemarkerMixin configuration).
org.apache.juneau.console.views	A typed, declarative "rich DataTables view" toolkit that serializes to the frozen VIEW_META JSON wire contract consumed by the first-party client runtime.
org.apache.juneau.console.widgets	Reusable widget primitives for the Juneau REST server toolkit.
org.apache.juneau.microservice.examples	Example / demo Microservice REST Resources
org.apache.juneau.microservice.management	Actuator-style management-surface endpoints (microservice-module flavors).
org.apache.juneau.petstore.console	Petstore admin console: the /console page tree.
org.apache.juneau.petstore.console.dev	Petstore console Developer pages: custom cards, themes, rendering flavors and the secure API demo.
org.apache.juneau.petstore.console.dev.flavors	Petstore console Rendering flavors: one console page per petstore view technology.
org.apache.juneau.petstore.console.ops	Petstore console operations pages: background jobs and the audit log.
org.apache.juneau.petstore.console.orders	Petstore console orders page and its JSON endpoints.
org.apache.juneau.petstore.console.pets	Petstore console pets pages and their JSON endpoints.
org.apache.juneau.petstore.console.users	Petstore console users page and its JSON endpoints.
org.apache.juneau.petstore.jetty	Apache Juneau Petstore - Jetty/Microservice deployment.
org.apache.juneau.petstore.rest	Petstore REST resources.
org.apache.juneau.petstore.springboot	Apache Juneau Petstore - Spring Boot deployment.
org.apache.juneau.rest.server	REST Server API
org.apache.juneau.rest.server.arg	REST Method Argument Beans
org.apache.juneau.rest.server.auth	Authentication (AuthN) guards, servlet-layer filters, SPIs, and request-time helpers for juneau-rest-server.
org.apache.juneau.rest.server.beans	REST Interface Helper Classes
org.apache.juneau.rest.server.converter	REST Response Converters
org.apache.juneau.rest.server.docs	API-docs mixin pack — composable @Rest(mixins=...) resources that publish Swagger v2 and OpenAPI 3.1 spec endpoints with Swagger-UI and Redoc HTML mounts.
org.apache.juneau.rest.server.guard	REST Guards
org.apache.juneau.rest.server.health	Built-in health, readiness, and liveness probe support for Juneau REST servers.
org.apache.juneau.rest.server.httppart	REST HTTP Parts
org.apache.juneau.rest.server.logging	JUL-level-driven REST debug logging API.
org.apache.juneau.rest.server.management	Actuator-style management-surface endpoints (server-module flavors).
org.apache.juneau.rest.server.mcp	Revision-neutral core for MCP endpoints built on juneau-rest-server.
org.apache.juneau.rest.server.mcp.v20260728	MCP 2026-07-28 binding for juneau-rest-server-mcp.
org.apache.juneau.rest.server.metrics.micrometer	Micrometer bridge for the juneau-rest-server MetricsRecorder SPI.
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.
org.apache.juneau.rest.server.servlet	REST Servlets
org.apache.juneau.rest.server.staticfile	REST Static Files Support
org.apache.juneau.rest.server.tracing	Tracing SPI for juneau-rest-server — per-request span hook backed by a caller-supplied TracerHook bean.
org.apache.juneau.rest.server.tracing.otel	OpenTelemetry bridge for the juneau-rest-server TracerHook SPI.
org.apache.juneau.rest.server.view	Engine-agnostic server-side-rendered view extension point.
org.apache.juneau.rest.server.view.freemarker	Apache FreeMarker view-rendering bridge — opt-in juneau-rest-server-view-freemarker module.
org.apache.juneau.rest.server.view.jsp	JSP view-rendering bridge — opt-in juneau-rest-server-view-jsp module.
org.apache.juneau.rest.server.view.mustache	Mustache view-rendering bridge — opt-in juneau-rest-server-view-mustache module.
org.apache.juneau.rest.server.view.thymeleaf	Thymeleaf view-rendering bridge — opt-in juneau-rest-server-view-thymeleaf module.
org.apache.juneau.rest.server.widget	HTML Widget API
org.apache.juneau.terminal.region	Raw command output in the browser: a byte-offset endpoint over a TerminalSource and an xterm.js panel that renders it the way a terminal would.

Uses of RestRequest in org.apache.juneau.console

Methods in org.apache.juneau.console with parameters of type RestRequest

Modifier and Type	Method	Description
static String	ConsoleChromeMixin.badgesJsUrl(RestRequest req)	Context-root-absolute, cache-busted URL of the count-badge script.
static String	ConsoleChromeMixin.chromeCssUrl(RestRequest req)	Returns a real, browser-fetchable URL for the shipped chrome.css, resolved against the request's context root (not the page resource) and carrying the same content-sensitive ?v=… cache-buster the theme stylesheets use.
static String	ConsoleChromeMixin.consoleAssetUrl(RestRequest req, String path)	Context-root-absolute, cache-busted URL of a console card runtime; the resolver of the charts and joblog toolkit packs.
static String	ConsoleChromeMixin.consoleJsUrl(RestRequest req)	Context-root-absolute, cache-busted URL of the console shell script.
HttpResource	ConsoleChromeMixin.getChromeCss(RestRequest req)	[GET /juneau-console/chrome.css] — serve the admin-console chrome stylesheet.
static ConsoleChromeMixin.SchemeHead	ConsoleChromeMixin.schemeHead(RestRequest req, String pin, boolean toggle)	Returns the colour-scheme head pieces for a page that does not render through the FreeMarker console directive.
static String	ConsoleChromeMixin.themeAssetUrl(RestRequest req, String name)	Returns a real, browser-fetchable URL for a shipped theme stylesheet, resolved against the request's context root (not the page resource) and carrying the same ?v=<buildVersion>-<hash8> content-sensitive cache-buster ConsoleChromeMixin.chromeCssUrl(RestRequest) uses.

Uses of RestRequest in org.apache.juneau.console.bus

Methods in org.apache.juneau.console.bus with parameters of type RestRequest

Modifier and Type	Method	Description
default JsonMap	BusEventsMixin.openBusSession(RestRequest req, RestResponse res)	[POST /juneau-bus/session] — opens a bus session.
default void	BusEventsMixin.streamBus(String id, RestRequest req, RestResponse res)	[GET /juneau-bus/stream/{sessionId}] — streams the session's frames as Server-Sent Events.

Uses of RestRequest in org.apache.juneau.console.data

Methods in org.apache.juneau.console.data with parameters of type RestRequest

Modifier and Type	Method	Description
static SeriesAggregator.Request	SeriesAggregator.Request.from(RestRequest req)	Parses the request's query parameters.

Uses of RestRequest in org.apache.juneau.console.freemarker

Methods in org.apache.juneau.console.freemarker with parameters of type RestRequest

Modifier and Type	Method	Description
String	ToolkitPackRegistry.AssetUrlResolver.resolve(RestRequest req, String path)
ToolkitPackRegistry.Resolved	ToolkitPackRegistry.resolve(List<String> names, RestRequest req, List<String> pageUrls, String template)	Resolves the root packs and their dependencies to absolute URLs, split by kind.
freemarker.template.Configuration	ConsoleFreemarkerMixin.resolveConfiguration(RestRequest req)	Resolves the active Configuration and fill-missing-stamps console shared variables onto it.
FreemarkerView	PageSpec.view(RestRequest req)	Builds the view for this spec.

Uses of RestRequest in org.apache.juneau.console.views

Methods in org.apache.juneau.console.views with parameters of type RestRequest

Modifier and Type	Method	Description
static void	TerminalViewEndpoints.events(Optional<TerminalViewSource> source, RestRequest req, RestResponse res)	Serves one page of the events endpoint (?after=) as JSON.
default void	AsyncJobsMixin.streamJob(String jobId, RestRequest req, RestResponse res)	[GET /juneau-jobs/{jobId}/stream] — stream a job's progress as Server-Sent Events.
default void	TerminalViewMixin.terminalViewEvents(String runId, RestRequest req, RestResponse res)	[GET /juneau-terminal-view/{runId}/events] — one page of events as JSON.
Optional<TerminalViewSource>	TerminalViewMixin.terminalViewSource(String runId, RestRequest req)	Resolves the source for a run id, applying the application's own access rules.
static String	ViewsMixin.viewAssetUrl(RestRequest req, String path)	Returns a real, browser-fetchable absolute URL for a served asset, resolved against the given request's context path and mount — carrying the same ?v=<buildVersion>-<hash8> content- sensitive cache-buster as ViewsMixin.viewAssetUrl(String) (see the class Javadoc's cache-busting section).

Uses of RestRequest in org.apache.juneau.console.widgets

Methods in org.apache.juneau.console.widgets with parameters of type RestRequest

Modifier and Type	Method	Description
static String	WidgetsMixin.widgetAssetUrl(RestRequest req, String path)	Returns a real, browser-fetchable absolute URL for a widget asset served by this mixin, resolved against the given request's context path and mount — carrying the same cache-buster as WidgetsMixin.widgetAssetUrl(String).

Uses of RestRequest in org.apache.juneau.microservice.examples

Methods in org.apache.juneau.microservice.examples with parameters of type RestRequest

Modifier and Type	Method	Description
Ok	DebugResource.createJettyDump(RestRequest req, RestResponse res)	[POST /jetty/dump] - Generates and saves the jetty thread dump file to jetty-thread-dump.log.
DirectoryResource.FileResource	DirectoryResource.getFile(RestRequest req, String path)	Returns information about the specified file or directory.
LogsResource.FileResource	LogsResource.getFile(RestRequest req, String path)	Returns information about the specified file or directory.
Reader	DebugResource.getJettyDump(RestRequest req, RestResponse res)	[GET /jetty/dump] - Generates and retrieves the jetty thread dump.
LogParser	LogsResource.viewParsedEntries(RestRequest req, String path, String start, String end, String thread, String[] loggers, String[] severity)	Views the parsed contents of a log file with filtering.

Uses of RestRequest in org.apache.juneau.microservice.management

Methods in org.apache.juneau.microservice.management with parameters of type RestRequest

Modifier and Type	Method	Description
JsonMap	InfoMixin.getInfo(RestRequest req)	[GET /info] - Application build/version/git metadata from the manifest.
JsonMap	InfoResource.getInfo(RestRequest req)	[GET /] - Application build/version/git metadata from the manifest.

Uses of RestRequest in org.apache.juneau.petstore.console

Methods in org.apache.juneau.petstore.console with parameters of type RestRequest

Modifier and Type	Method	Description
static String	ConsoleWrites.actor(RestRequest req)	Checks the write gate and returns the audit actor.
static boolean	PetstoreConsolePage.builder(RestRequest req)	Whether this request asks for the builder twin of a page (?builder, with or without a value).
SeeOther	PetstoreConsoleResource.index(RestRequest req)	GET /console redirects to the store dashboard.
View	AboutRest.page(RestRequest req)	The About page.
View	StoreRest.page(RestRequest req)	Renders the Store page, with the quick-stat tile values computed from the store.
static List<String>	ConsoleWrites.roles(RestRequest req)	The viewer's roles, for <@facts> and server-side omission of role-gated cards.
static View	PetstoreConsolePage.twin(RestRequest req, PageSpec spec)	Renders a builder-twin page, marked with PetstoreConsolePage.PAGE_HEADER.

Uses of RestRequest in org.apache.juneau.petstore.console.dev

Methods in org.apache.juneau.petstore.console.dev with parameters of type RestRequest

Modifier and Type	Method	Description
SeeOther	DevRest.index(RestRequest req)	Redirects the section root to its first child.
View	ChartsRest.page(RestRequest req)	Renders the Charts page.
View	CustomCardsRest.page(RestRequest req)	The Custom cards page.
View	DashboardRest.page(RestRequest req, String variant, Integer v)	Renders the Dashboard page.
View	DataRest.page(RestRequest req)	Renders the Data sources page.
View	SecureRest.page(RestRequest req)	The Secure page.
View	ThemesRest.page(RestRequest req, String theme)	Renders the Themes page.
void	DashboardRest.series(RestRequest req, RestResponse res, String variant, String q, String start, String end, String lateOnly)	The orders source: day,reason,orders, one row per UTC day.

Uses of RestRequest in org.apache.juneau.petstore.console.dev.flavors

Methods in org.apache.juneau.petstore.console.dev.flavors with parameters of type RestRequest

Modifier and Type	Method	Description
SeeOther	FlavorsRest.index(RestRequest req)	Redirects to the first flavor.
View	Flavor.page(RestRequest req)	The console page for this flavor, from its builder twin on ?builder.
View	FreemarkerFlavorRest.page(RestRequest req)	The console page, from its builder twin on ?builder.
View	HtmlFlavorRest.page(RestRequest req)	The console page, from its builder twin on ?builder.
View	MustacheFlavorRest.page(RestRequest req)	The console page, from its builder twin on ?builder.
View	FlavorsRest.react(RestRequest req)	The React flavor page, from its builder twin on ?builder.

Uses of RestRequest in org.apache.juneau.petstore.console.ops

Methods in org.apache.juneau.petstore.console.ops with parameters of type RestRequest

Modifier and Type	Method	Description
Map<String,Object>	JobsRest.groomRunKey(RestRequest req, String id)	Issues a regroom key bound to one groom run and the caller.
SeeOther	OpsRest.index(RestRequest req)	GET /console/ops redirects to the Jobs page.
View	AuditRest.page(RestRequest req)	Renders the Audit page.
View	JobsRest.page(RestRequest req, String run)	Renders the Jobs page.
ActionResult	JobsRest.regroom(RestRequest req, RestResponse res, String id, JsonMap json)	Grooms a run's pet again.
Object	JobsRest.restock(RestRequest req, RestResponse res, JsonMap json)	Submits a restock.
Object	JobsRest.restockSpecies(RestRequest req, RestResponse res, String id, JsonMap json)	Restocks one species from its row's detail panel.
Map<String,Object>	JobsRest.speciesKey(RestRequest req, String id)	Issues a restock key bound to one species and the caller.
Optional<TerminalSource>	JobsRest.terminalSource(String id, RestRequest req)

Uses of RestRequest in org.apache.juneau.petstore.console.orders

Methods in org.apache.juneau.petstore.console.orders with parameters of type RestRequest

Modifier and Type	Method	Description
ActionResult	OrdersRest.approve(RestRequest req, long id)	Approves a placed order.
ActionResult	OrdersRest.cancel(RestRequest req, long id)	Deletes (cancels) an order.
ActionResult	OrdersRest.create(RestRequest req, JsonMap body)	Places a new order.
ActionResult	OrdersRest.deliver(RestRequest req, long id)	Delivers an approved order.
View	OrdersRest.page(RestRequest req)	The Orders page.

Uses of RestRequest in org.apache.juneau.petstore.console.pets

Methods in org.apache.juneau.petstore.console.pets with parameters of type RestRequest

Modifier and Type	Method	Description
ActionResult	ChangesRest.apply(RestRequest req, long id)	Applies one change (the bulk perRow action).
ActionResult	PetsRest.create(RestRequest req, JsonMap body)	Creates a pet.
ActionResult	PetsRest.delete(RestRequest req, long id)	Deletes a pet.
SeeOther	PetsRest.detail(RestRequest req, long id)	The bare pet URL; lands on the first tab.
View	PetsRest.detailOrder(RestRequest req, RestResponse res, long id, long orderId)	P4 at nav depth 4: the Orders tab with one of this pet's orders selected.
View	PetsRest.detailTab(RestRequest req, RestResponse res, long id, String tab)	P4, one tab.
BulkResult	ChangesRest.discard(RestRequest req, BulkRequest body, String fail)	Discards changes in one aggregate call.
View	ChangesRest.page(RestRequest req)	The Pending changes page.
View	PetsRest.page(RestRequest req)	The Pets page.
JsonMap	ChangesRest.pending(RestRequest req)	The header badge source: pending changes, flagged mine for the caller.
ActionResult	ChangesRest.retry(RestRequest req, long id)	Retries a failed change.
ActionResult	PetsRest.sell(RestRequest req, long id)	Marks a pet sold.
View	PetsRest.sold(RestRequest req)	The Sold pets page.
ActionResult	PetsRest.stage(RestRequest req, long id, JsonMap body)	Stages an inline edit for review on the Pending changes page.
ActionResult	PetsRest.update(RestRequest req, long id, JsonMap body)	Replaces a pet.

Uses of RestRequest in org.apache.juneau.petstore.console.users

Methods in org.apache.juneau.petstore.console.users with parameters of type RestRequest

Modifier and Type	Method	Description
ActionResult	UsersRest.create(RestRequest req, JsonMap body)	Creates a user.
ActionResult	UsersRest.delete(RestRequest req, String username)	Deletes a user.
View	UsersRest.page(RestRequest req)	The Users page.
ActionResult	UsersRest.update(RestRequest req, String username, JsonMap body)	Updates a user.

Uses of RestRequest in org.apache.juneau.petstore.jetty

Methods in org.apache.juneau.petstore.jetty with parameters of type RestRequest

Modifier and Type	Method	Description
SeeOther	RootResources.index(RestRequest req)	GET / goes to the console store page.

Uses of RestRequest in org.apache.juneau.petstore.rest

Methods in org.apache.juneau.petstore.rest with parameters of type RestRequest

Modifier and Type	Method	Description
HttpResource	PetstoreUiResource.app(RestRequest req, Locale locale)	[GET /] — the single-page app.

Uses of RestRequest in org.apache.juneau.petstore.springboot

Methods in org.apache.juneau.petstore.springboot with parameters of type RestRequest

Modifier and Type	Method	Description
SeeOther	RootResources.index(RestRequest req)	GET / goes to the console store page.

Uses of RestRequest in org.apache.juneau.rest.server

Methods in org.apache.juneau.rest.server that return RestRequest

Modifier and Type	Method	Description
RestRequest	RestOpContext.createRequest(RestSession session)	Creates a RestRequest object based on the specified incoming HttpServletRequest object.
RestRequest	RestOpSession.getRequest()	Returns the REST request object for this session.
RestRequest	RestRequest.setAuthResult(AuthResult value)	Sets the resolved resource-level authentication result.
RestRequest	RestRequest.setException(Throwable t)	Sets the "Exception" attribute to the specified throwable.
RestRequest	RestRequest.setNoTrace()	Shortcut for calling setNoTrace(true).
RestRequest	RestRequest.setNoTrace(Boolean b)	Sets the "NoTrace" attribute to the specified boolean.
RestRequest	RestRequest.setParserSessionProperties(Map<String,Object> values)	Sets multiple parser session properties programmatically.
RestRequest	RestRequest.setParserSessionProperty(String name, Object value)	Sets a parser session property programmatically.
RestRequest	RestRequest.setSerializerSessionProperties(Map<String,Object> values)	Sets multiple serializer session properties programmatically.
RestRequest	RestRequest.setSerializerSessionProperty(String name, Object value)	Sets a serializer session property programmatically.

Methods in org.apache.juneau.rest.server that return types with arguments of type RestRequest

Modifier and Type	Method	Description
FluentStringAssertion<RestRequest>	RestRequest.assertCharset()	Provides the ability to perform fluent-style assertions on the response character encoding.
FluentRequestContentAssertion<RestRequest>	RestRequest.assertContent()	Returns a fluent assertion for the request content.
FluentRequestFormParamAssertion<RestRequest>	RestRequest.assertFormParam(String name)	Returns a fluent assertion for the specified form parameter.
FluentRequestHeaderAssertion<RestRequest>	RestRequest.assertHeader(String name)	Returns a fluent assertion for the specified header.
FluentRequestQueryParamAssertion<RestRequest>	RestRequest.assertQueryParam(String name)	Returns a fluent assertion for the specified query parameter.
FluentRequestLineAssertion<RestRequest>	RestRequest.assertRequestLine()	Returns an assertion on the request line returned by getRequestLine().

Methods in org.apache.juneau.rest.server with parameters of type RestRequest

Modifier and Type	Method	Description
RestResponse	RestOpContext.createResponse(RestSession session, RestRequest req)	Creates a RestResponse object based on the specified incoming HttpServletResponse object and the request returned by RestOpContext.createRequest(RestSession).

Uses of RestRequest in org.apache.juneau.rest.server.arg

Constructor parameters in org.apache.juneau.rest.server.arg with type arguments of type RestRequest

Modifier	Constructor	Description
protected	RestRequestArgs(ThrowingFunction<RestRequest,T> function)	Constructor.

Uses of RestRequest in org.apache.juneau.rest.server.auth

Methods in org.apache.juneau.rest.server.auth with parameters of type RestRequest

Modifier and Type	Method	Description
abstract Optional<AuthResult>	RestAuthenticator.authenticate(RestRequest req)	Resolves identity + roles for the request.
Optional<AuthResult>	RestAuthenticator.Null.authenticate(RestRequest req)
boolean	ApiKeyGuard.guard(RestRequest req, RestResponse res)
boolean	BearerTokenGuard.guard(RestRequest req, RestResponse res)
boolean	ApiKeyGuard.isRequestAllowed(RestRequest req)
boolean	BearerTokenGuard.isRequestAllowed(RestRequest req)

Uses of RestRequest in org.apache.juneau.rest.server.beans

Methods in org.apache.juneau.rest.server.beans with parameters of type RestRequest

Modifier and Type	Method	Description
static ChildResourceDescriptions	ChildResourceDescriptions.of(RestRequest req)	Static creator.

Constructors in org.apache.juneau.rest.server.beans with parameters of type RestRequest

Modifier	Constructor	Description
	ChildResourceDescriptions(RestContext context, RestRequest req)	Constructor.
	ChildResourceDescriptions(RestContext context, RestRequest req, boolean sort)	Constructor.
	ChildResourceDescriptions(RestRequest req)	Constructor.

Uses of RestRequest in org.apache.juneau.rest.server.converter

Methods in org.apache.juneau.rest.server.converter with parameters of type RestRequest

Modifier and Type	Method	Description
Object	Introspectable.convert(RestRequest req, Object o)
Object	Queryable.convert(RestRequest req, Object o)
Object	RestConverter.convert(RestRequest req, Object res)	Performs post-call conversion on the specified response object.
Object	Traversable.convert(RestRequest req, Object o)

Uses of RestRequest in org.apache.juneau.rest.server.docs

Methods in org.apache.juneau.rest.server.docs with parameters of type RestRequest

Modifier and Type	Method	Description
OpenApi	OpenApiMixin.getOpenApi(RestRequest req)	[GET /openapi] — emit the OpenAPI 3.1 document for this resource.
void	OpenApiMixin.getOpenApiJson(RestRequest req, RestResponse res)	[GET /openapi.json] — emit the OpenAPI 3.1 document as JSON, ignoring the Accept header.
void	OpenApiMixin.getOpenApiYaml(RestRequest req, RestResponse res)	[GET /openapi.yaml] — emit the OpenAPI 3.1 document as YAML, ignoring the Accept header.
OpenApi	RedocMixin.getRedoc(RestRequest req)	[GET /redoc] — render the Redoc HTML view (or the spec, depending on Accept).
Swagger	SwaggerMixin.getSwagger(RestRequest req)	[GET /api] — emit the Swagger v2 spec for this resource.
Swagger	SwaggerUiMixin.getSwaggerUi(RestRequest req)	[GET /swagger] — render the Swagger-UI HTML view (or the spec, depending on Accept).

Uses of RestRequest in org.apache.juneau.rest.server.guard

Methods in org.apache.juneau.rest.server.guard with parameters of type RestRequest

Modifier and Type	Method	Description
boolean	RateLimitGuard.guard(RestRequest req, RestResponse res)
boolean	RestGuard.guard(RestRequest req, RestResponse res)	Checks the current HTTP request and throws a BasicHttpException if the guard does not permit the request.
boolean	DenyAllGuard.isRequestAllowed(RestRequest req)
boolean	RateLimitGuard.isRequestAllowed(RestRequest req)
abstract boolean	RestGuard.isRequestAllowed(RestRequest req)	Returns true if the specified request can pass through this guard.
boolean	RoleBasedRestGuard.isRequestAllowed(RestRequest req)

Method parameters in org.apache.juneau.rest.server.guard with type arguments of type RestRequest

Modifier and Type	Method	Description
RateLimitGuard.Builder	RateLimitGuard.Builder.keyBy(Function<RestRequest,String> value)	Sets the per-request key resolver.
RateLimitGuard.Builder	RateLimitGuard.Builder.whenLimitExceeded(BiConsumer<RestRequest,RateLimitGuard.RateLimitInfo> value)	Sets a callback invoked when a request is rejected due to an empty bucket.

Uses of RestRequest in org.apache.juneau.rest.server.health

Methods in org.apache.juneau.rest.server.health with parameters of type RestRequest

Modifier and Type	Method	Description
HealthAggregator.HealthResponse	HealthMixin.healthz(RestRequest req, RestResponse res)	Health probe endpoint.
HealthAggregator.HealthResponse	HealthResource.healthz(RestRequest req, RestResponse res)	Health probe endpoint.
HealthAggregator.HealthResponse	HealthMixin.livez(RestRequest req, RestResponse res)	Liveness probe endpoint.
HealthAggregator.HealthResponse	HealthResource.livez(RestRequest req, RestResponse res)	Liveness probe endpoint.
HealthAggregator.HealthResponse	HealthServlet.probe(RestRequest req, RestResponse res)	Health/readiness/liveness probe endpoint.
protected HealthProbe	HealthServlet.probeFor(RestRequest req)	Resolves which probe this request is for, keyed off the LAST PATH SEGMENT.
HealthAggregator.HealthResponse	HealthMixin.readyz(RestRequest req, RestResponse res)	Readiness probe endpoint.
HealthAggregator.HealthResponse	HealthResource.readyz(RestRequest req, RestResponse res)	Readiness probe endpoint.

Uses of RestRequest in org.apache.juneau.rest.server.httppart

Methods in org.apache.juneau.rest.server.httppart that return RestRequest

Modifier and Type	Method	Description
protected RestRequest	RequestHttpPart.getRequest()	Returns the request that created this part.

Constructors in org.apache.juneau.rest.server.httppart with parameters of type RestRequest

Modifier	Constructor	Description
	RequestAttribute(RestRequest request, String name, Object value)	Constructor.
	RequestAttributes(RestRequest req)	Constructor.
	RequestContent(RestRequest req)	Constructor.
	RequestFormParam(RestRequest request, jakarta.servlet.http.Part part)	Constructor.
	RequestFormParam(RestRequest request, String name, String value)	Constructor.
	RequestFormParamList(RestRequest req, boolean caseSensitive)	Constructor.
	RequestHeader(RestRequest request, String name, String value)	Constructor.
	RequestHeaderList(RestRequest req, RequestQueryParamList query, boolean caseSensitive)	Constructor.
	RequestHttpPart(HttpPartType partType, RestRequest request, String name, String value)	Constructor.
	RequestPathParam(RestRequest request, String name, String value)	Constructor.
	RequestPathParamList(RestSession session, RestRequest req, boolean caseSensitive)	Constructor.
	RequestQueryParam(RestRequest request, String name, String value)	Constructor.
	RequestQueryParamList(RestRequest req, Map<String,String[]> query, boolean caseSensitive)	Constructor.

Uses of RestRequest in org.apache.juneau.rest.server.logging

Methods in org.apache.juneau.rest.server.logging with parameters of type RestRequest

Modifier and Type	Method	Description
String	BasicRestDebugFormatter.formatBasic(RestRequest req, RestResponse res)
String	RestDebugFormatter.formatBasic(RestRequest req, RestResponse res)	Renders the basic (INFO-tier) portion of the debug record.
String	BasicRestDebugFormatter.formatBody(RestRequest req, RestResponse res)
default String	RestDebugFormatter.formatBody(RestRequest req, RestResponse res)	Renders the body (FINEST-tier) portion of the debug record.
String	BasicRestDebugFormatter.formatHeaders(RestRequest req, RestResponse res)
default String	RestDebugFormatter.formatHeaders(RestRequest req, RestResponse res)	Renders the headers (FINE-tier) portion of the debug record.

Uses of RestRequest in org.apache.juneau.rest.server.management

Methods in org.apache.juneau.rest.server.management with parameters of type RestRequest

Modifier and Type	Method	Description
InputStream	DumpsMixin.getHeapDump(RestRequest req, RestResponse res)	[GET /heapdump] - HotSpot heap dump (hprof) stream.
InputStream	DumpsResource.getHeapDump(RestRequest req, RestResponse res)	[GET /heapdump] - HotSpot heap dump (hprof) stream.
String	LoggersMixin.getLogger(RestRequest req, String name)	[GET /loggers/{name}] - One logger's configured level.
String	LoggersResource.getLogger(RestRequest req, String name)	[GET /{name}] - One logger's configured level.
Map<String,String>	LoggersMixin.getLoggers(RestRequest req)	[GET /loggers] - All loggers and their configured levels.
Map<String,String>	LoggersResource.getLoggers(RestRequest req)	[GET /] - All loggers and their configured levels.
String	DumpsMixin.getThreadDump(RestRequest req)	[GET /threaddump] - Full thread dump from the ThreadMXBean.
String	DumpsResource.getThreadDump(RestRequest req)	[GET /threaddump] - Full thread dump from the ThreadMXBean.
protected DumpsManager	DumpsMixin.manager(RestRequest req)	Returns the DumpsManager worker, resolved from the host bean store when a consumer registers one, else a built-in default.
protected DumpsManager	DumpsResource.manager(RestRequest req)	Returns the DumpsManager worker, resolved from the bean store when a consumer registers one, else a built-in default.
String	LoggersMixin.setLogger(RestRequest req, String name, String level)	[PUT /loggers/{name}] - Set a logger's level at runtime.
String	LoggersResource.setLogger(RestRequest req, String name, String level)	[PUT /{name}] - Set a logger's level at runtime.
String	LoggersMixin.setLoggerPost(RestRequest req, String name, String level)	[POST /loggers/{name}] - Set a logger's level at runtime (POST alias of LoggersMixin.setLogger(RestRequest,String,String)).
String	LoggersResource.setLoggerPost(RestRequest req, String name, String level)	[POST /{name}] - Set a logger's level at runtime (POST alias of LoggersResource.setLogger(RestRequest,String,String)).

Uses of RestRequest in org.apache.juneau.rest.server.mcp

Methods in org.apache.juneau.rest.server.mcp with parameters of type RestRequest

Modifier and Type	Method	Description
Object	AbstractMcpRestServlet.handleMcp(JsonRpcRequest req, RestRequest restReq)	MCP JSON-RPC endpoint.
default Object	McpEndpointMixin.handleMcpRequest(JsonRpcRequest req, RestRequest restReq)	Default MCP JSON-RPC endpoint handler.

Uses of RestRequest in org.apache.juneau.rest.server.mcp.v20260728

Methods in org.apache.juneau.rest.server.mcp.v20260728 with parameters of type RestRequest

Modifier and Type	Method	Description
default McpProtectedResourceMetadata	McpEndpoint.mcpProtectedResourceMetadataPathInserted(RestRequest req)	Serves the RFC 9728 Protected Resource Metadata document at the path-inserted well-known location (SEP-2351), but only when the requested suffix matches this resource's expected well-known path; otherwise 404.
McpProtectedResourceMetadata	McpRestServlet.mcpProtectedResourceMetadataPathInserted(RestRequest req)	Serves the RFC 9728 Protected Resource Metadata document at the path-inserted well-known location (SEP-2351), but only when the requested suffix matches this resource's expected well-known path; otherwise 404.
default McpProtectedResourceMetadata	McpEndpoint.mcpProtectedResourceMetadataRoot(RestRequest req)	Serves the RFC 9728 Protected Resource Metadata document at the root well-known location (SEP-2351 fallback).
McpProtectedResourceMetadata	McpRestServlet.mcpProtectedResourceMetadataRoot(RestRequest req)	Serves the RFC 9728 Protected Resource Metadata document at the root well-known location (SEP-2351 fallback).
static McpProtectedResourceMetadata	McpResourceServerSupport.metadataForWellKnownPathInserted(McpResourceServerConfig cfg, RestRequest req)	Serves this endpoint's PRM from the RFC 9728 path-inserted well-known location, but only when the requested suffix matches this resource's expected well-known path; otherwise 404.
static McpProtectedResourceMetadata	McpResourceServerSupport.metadataForWellKnownRoot(McpResourceServerConfig cfg, RestRequest req)	Serves this endpoint's PRM from the SEP-2351 root well-known location (fallback), failing fast on a non-root or re-mounted mount; a no-op-throwing 404 when RS auth is disabled.

Uses of RestRequest in org.apache.juneau.rest.server.metrics.micrometer

Methods in org.apache.juneau.rest.server.metrics.micrometer with parameters of type RestRequest

Modifier and Type	Method	Description
String	MetricsMixin.getMetrics(RestRequest req)	[GET /metrics] - Prometheus scrape of the consumer-provided MeterRegistry.
String	MetricsResource.getMetrics(RestRequest req)	[GET /] - Prometheus scrape of the consumer-provided MeterRegistry.

Uses of RestRequest in org.apache.juneau.rest.server.ops

Methods in org.apache.juneau.rest.server.ops with parameters of type RestRequest

Modifier and Type	Method	Description
void	EchoMixin.echo(RestRequest req, RestResponse res, String remainder)	[* /echo/*] — emit an introspection echo of the inbound request.
ChildResourceDescriptions	NavigationMixin.getChildren(RestRequest req)	[GET /] - Get child resources.
HttpResource	HtdocMixin.getHtdoc(RestRequest req, String path, Locale locale)	[GET /htdocs/*] - Retrieve static file.
void	AdminMixin.getRateLimit(RestRequest req, RestResponse res)	[GET /admin/ratelimit] — emit registered RateLimitGuard bean configuration.
void	AdminResource.getRateLimit(RestRequest req, RestResponse res)	[GET /ratelimit] — emit registered RateLimitGuard bean configuration.
void	AdminServlet.getRateLimit(RestRequest req, RestResponse res)	[GET /ratelimit] — emit registered RateLimitGuard bean configuration.
RouteDescriptions	RouteIndexMixin.getRoutes(RestRequest req)	[GET /options] — return the route index as a content-negotiated POJO.
RestContextStats	StatsMixin.getStats(RestRequest req)	[GET /stats] - Timing statistics.
void	AdminMixin.postCacheFlush(RestRequest req, RestResponse res)	[POST /admin/cache/flush] — run all registered cache-flush hooks (or a subset).
void	AdminResource.postCacheFlush(RestRequest req, RestResponse res)	[POST /cache/flush] — run all registered cache-flush hooks (or a subset).
void	AdminServlet.postCacheFlush(RestRequest req, RestResponse res)	[POST /cache/flush] — run all registered cache-flush hooks (or a subset).
void	AdminProvider.serveCacheFlush(RestRequest req, RestResponse res)	Runs all registered cache-flush hooks (or a subset).
void	AdminProvider.serveRateLimit(RestRequest req, RestResponse res)	Serves the registered RateLimitGuard bean configuration.

Uses of RestRequest in org.apache.juneau.rest.server.servlet

Methods in org.apache.juneau.rest.server.servlet that return RestRequest

Modifier and Type	Method	Description
RestRequest	RestResource.getRequest()	Returns the current thread-local HTTP request.
RestRequest	RestServlet.getRequest()	Returns the current thread-local HTTP request.

Uses of RestRequest in org.apache.juneau.rest.server.staticfile

Methods in org.apache.juneau.rest.server.staticfile with parameters of type RestRequest

Modifier and Type	Method	Description
HttpResource	StaticFilesMixin.getStaticFile(RestRequest req, String path, Locale locale)	[GET /static/*] — serve a static file from the active StaticFiles bean.
HttpResource	StaticFilesResource.getStaticFile(RestRequest req, String path, Locale locale)	[GET /*] — serve a static file from the active StaticFiles worker bean.
HttpResource	StaticFilesServlet.getStaticFile(RestRequest req, String path, Locale locale)	[GET /*] — serve a static file from the active StaticFiles worker bean.
HttpResource	WebJarsMixin.getWebJarFile(RestRequest req)	[GET /webjars/*] — serve one WebJar file.
HttpResource	StaticFilesMixin.headStaticFile(RestRequest req, String path, Locale locale)	[HEAD /static/*] — return GET headers for a static file without the body.
HttpResource	StaticFilesResource.headStaticFile(RestRequest req, String path, Locale locale)	[HEAD /*] — return GET headers for a static file without the body.
HttpResource	StaticFilesServlet.headStaticFile(RestRequest req, String path, Locale locale)	[HEAD /*] — return GET headers for a static file without the body.
HttpResource	WebJarsMixin.headWebJarFile(RestRequest req)	[HEAD /webjars/*] — the GET headers without the body (the response processor drops the body).
static String	WebJarResolver.resolve(RestRequest req, String asset)	Resolves an asset id to an absolute, cache-busted URL under the WebJarsMixin mount of the request's servlet.
static HttpResource	StaticFilesMixin.resolveStaticFile(RestRequest req, String path, Locale locale)	Shared static-file resolution chokepoint — resolves the requested path against the request's active StaticFiles bean.

Uses of RestRequest in org.apache.juneau.rest.server.tracing

Methods in org.apache.juneau.rest.server.tracing with parameters of type RestRequest

Modifier and Type	Method	Description
Optional<TraceContextCarrier>	TraceContextExtractor.extract(RestRequest request, Object[] resolvedArguments)	Attempts to recognize a non-HTTP trace-context carrier among the resolved operation arguments.
default TraceOperation	TraceContextExtractor.operation(RestRequest request, Object[] resolvedArguments)	Derives the TraceOperation a bridge should name/attribute its span with.
Scope	NoOpTracerHook.startSpan(RestRequest request)
Scope	TracerHook.startSpan(RestRequest request)	Opens a new span for the in-flight request.
default Scope	TracerHook.startSpan(RestRequest request, TraceContextCarrier carrier, TraceOperation operation)	Opens a new span for the in-flight request, given a pre-extracted non-HTTP TraceContextCarrier and derived TraceOperation.

Uses of RestRequest in org.apache.juneau.rest.server.tracing.otel

Methods in org.apache.juneau.rest.server.tracing.otel with parameters of type RestRequest

Modifier and Type	Method	Description
String	RestRequestTextMapGetter.get(RestRequest carrier, String key)
Iterable<String>	RestRequestTextMapGetter.keys(RestRequest carrier)
Scope	OtelTracerHook.startSpan(RestRequest request)
Scope	OtelTracerHook.startSpan(RestRequest request, TraceContextCarrier carrier, TraceOperation operation)

Uses of RestRequest in org.apache.juneau.rest.server.view

Methods in org.apache.juneau.rest.server.view with parameters of type RestRequest

Modifier and Type	Method	Description
void	RawTemplateDispatcher.render(String path, RestRequest req, RestResponse res)	Renders the raw template identified by the trailing request path onto the response.
void	ViewResource.render(String path, RestRequest req, RestResponse res)	[GET /*] — render the raw template identified by the trailing path under this child's subtree mount.
void	ViewServlet.render(String path, RestRequest req, RestResponse res)	[GET /*] — render the raw template identified by the trailing path under this servlet's sibling top-level mount.

Uses of RestRequest in org.apache.juneau.rest.server.view.freemarker

Methods in org.apache.juneau.rest.server.view.freemarker that return RestRequest

Modifier and Type	Method	Description
static RestRequest	FreemarkerRenderScope.request()	Returns the request for the in-flight FreeMarker render.

Methods in org.apache.juneau.rest.server.view.freemarker with parameters of type RestRequest

Modifier and Type	Method	Description
void	FreemarkerDispatcher.render(String path, RestRequest req, RestResponse res)	Renders a raw template through the FreeMarker engine onto the response.
void	FreemarkerMixin.render(String path, RestRequest req, RestResponse res)	[GET /freemarker/*] — render a raw template through the FreeMarker engine.
freemarker.template.Configuration	FreemarkerDispatcher.resolveConfiguration(RestRequest req)	Resolves the active Configuration.
freemarker.template.Configuration	FreemarkerMixin.resolveConfiguration(RestRequest req)	Resolves the active Configuration via the shared FreemarkerDispatcher worker.

Uses of RestRequest in org.apache.juneau.rest.server.view.jsp

Methods in org.apache.juneau.rest.server.view.jsp with parameters of type RestRequest

Modifier and Type	Method	Description
void	JspDispatcher.render(String path, RestRequest req, RestResponse res)	Forwards the request to the JSP engine for the raw .jsp resource at the trailing path.
void	JspMixin.render(String path, RestRequest req, RestResponse res)	[GET /jsp/*] — forward the request to the JSP engine.

Uses of RestRequest in org.apache.juneau.rest.server.view.mustache

Methods in org.apache.juneau.rest.server.view.mustache with parameters of type RestRequest

Modifier and Type	Method	Description
void	MustacheDispatcher.render(String path, RestRequest req, RestResponse res)	Renders a raw template through the Mustache engine onto the response.
void	MustacheMixin.render(String path, RestRequest req, RestResponse res)	[GET /mustache/*] — render a raw template through the Mustache engine.
com.github.mustachejava.MustacheFactory	MustacheDispatcher.resolveMustacheFactory(RestRequest req)	Resolves the active MustacheFactory.
com.github.mustachejava.MustacheFactory	MustacheMixin.resolveMustacheFactory(RestRequest req)	Resolves the active MustacheFactory via the shared MustacheDispatcher worker.

Uses of RestRequest in org.apache.juneau.rest.server.view.thymeleaf

Methods in org.apache.juneau.rest.server.view.thymeleaf with parameters of type RestRequest

Modifier and Type	Method	Description
void	ThymeleafDispatcher.render(String path, RestRequest req, RestResponse res)	Renders a raw template through the Thymeleaf engine onto the response.
void	ThymeleafMixin.render(String path, RestRequest req, RestResponse res)	[GET /thymeleaf/*] — render a raw template through the Thymeleaf engine.
org.thymeleaf.TemplateEngine	ThymeleafDispatcher.resolveTemplateEngine(RestRequest req)	Resolves the active TemplateEngine.
org.thymeleaf.TemplateEngine	ThymeleafMixin.resolveTemplateEngine(RestRequest req)	Resolves the active TemplateEngine via the shared ThymeleafDispatcher worker.

Uses of RestRequest in org.apache.juneau.rest.server.widget

Methods in org.apache.juneau.rest.server.widget with parameters of type RestRequest

Modifier and Type	Method	Description
String	MenuItemWidget.getAfterShowScript(RestRequest req, RestResponse res)	Optional Javascript to execute immediately after a menu item is shown.
String	MenuItemWidget.getBeforeShowScript(RestRequest req, RestResponse res)	Optional Javascript to execute immediately before a menu item is shown.
Div	ContentTypeMenuItem.getContent(RestRequest req, RestResponse res)
abstract Object	MenuItemWidget.getContent(RestRequest req, RestResponse res)	The content of the popup.
String	QueryMenuItem.getContent(RestRequest req, RestResponse res)
protected FileFinder	Widget.getFileFinder(RestRequest req)	Returns the file finder to use for finding files on the file system.
String	MenuItemWidget.getHtml(RestRequest req, RestResponse res)
String	PoweredByApache.getHtml(RestRequest req, RestResponse res)	Returns an Apache image tag hyperlinked to "http://apache.org"
String	PoweredByJuneau.getHtml(RestRequest req, RestResponse res)	Returns an Apache Juneau image tag hyperlinked to "http://juneau.apache.org"
String	Widget.getHtml(RestRequest req, RestResponse res)	Resolves the HTML content for this widget.
String	ContentTypeMenuItem.getLabel(RestRequest req, RestResponse res)
abstract String	MenuItemWidget.getLabel(RestRequest req, RestResponse res)	The label for the menu item as it's rendered in the menu bar.
String	QueryMenuItem.getLabel(RestRequest req, RestResponse res)
String	MenuItemWidget.getScript(RestRequest req, RestResponse res)	Returns the Javascript needed for the show and hide actions of the menu item.
String	Widget.getScript(RestRequest req, RestResponse res)	Resolves any Javascript that should be added to the <head>/<script> element.
String	MenuItemWidget.getStyle(RestRequest req, RestResponse res)	Defines a "menu-item" class that needs to be used on the outer element of the HTML returned by the MenuItemWidget.getHtml(RestRequest,RestResponse) method.
String	QueryMenuItem.getStyle(RestRequest req, RestResponse res)	Returns CSS for the tooltips.
String	Widget.getStyle(RestRequest req, RestResponse res)	Resolves any CSS styles that should be added to the <head>/<style> element.
protected String	Widget.loadHtml(RestRequest req, String name)	Loads the specified HTML file and strips HTML comments from the file.
protected String	Widget.loadHtmlWithVars(RestRequest req, RestResponse res, String name)	Same as Widget.loadHtml(RestRequest,String) but replaces request-time SVL variables.
protected String	Widget.loadScript(RestRequest req, String name)	Loads the specified javascript file and strips any Javascript comments from the file.
protected String	Widget.loadScriptWithVars(RestRequest req, RestResponse res, String name)	Same as Widget.loadScript(RestRequest,String) but replaces request-time SVL variables.
protected String	Widget.loadStyle(RestRequest req, String name)	Loads the specified CSS file and strips CSS comments from the file.
protected String	Widget.loadStyleWithVars(RestRequest req, RestResponse res, String name)	Same as Widget.loadStyle(RestRequest,String) but replaces request-time SVL variables.

Uses of RestRequest in org.apache.juneau.terminal.region

Methods in org.apache.juneau.terminal.region with parameters of type RestRequest

Modifier and Type	Method	Description
static void	TerminalEndpoints.bytes(Optional<TerminalSource> source, RestRequest req, RestResponse res)	Serves ?from=<offset>&max=<n> as raw bytes with the Term-* headers.
static String	TerminalEndpoints.terminalAssetUrl(RestRequest req, String path)	Returns the absolute URL of a terminal asset, resolved against the request, with a ?v=<buildVersion>-<hash8> cache-buster.
static String	TerminalMixin.terminalAssetUrl(RestRequest req, String path)	The absolute URL of a terminal asset; the toolkit pack resolver for the terminal pack.
default void	TerminalMixin.terminalBytes(String id, RestRequest req, RestResponse res)	[GET /juneau-terminal/{id}/bytes] — raw bytes from an offset.
default void	TerminalMixin.terminalRaw(String id, RestRequest req, RestResponse res)	[GET /juneau-terminal/{id}/raw] — the whole log as an attachment.
Optional<TerminalSource>	TerminalMixin.terminalSource(String id, RestRequest req)	Resolves the source for a terminal id, applying the application's own access rules.