Uses of Annotation Interface
org.apache.juneau.http.Path

Packages that use Path

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.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.microservice.examples	Example / demo Microservice REST Resources
org.apache.juneau.petstore.client	Typed @Remote client view of the petstore API.
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.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.rest	Petstore REST resources.
org.apache.juneau.rest.server.management	Actuator-style management-surface endpoints (server-module flavors).
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.remote	Remote service API
org.apache.juneau.rest.server.staticfile	REST Static Files Support
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.server.config.rest	Server Configuration REST
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 Path in org.apache.juneau.console

Method parameters in org.apache.juneau.console with annotations of type Path

Modifier and Type	Method	Description
HttpResource	ConsoleChromeMixin.getThemeCss(String file)	[GET /juneau-console/themes/{file}] — serve one of the shipped stock-theme stylesheets.

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

Method parameters in org.apache.juneau.console.bus with annotations of type Path

Modifier and Type	Method	Description
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 Path in org.apache.juneau.console.views

Method parameters in org.apache.juneau.console.views with annotations of type Path

Modifier and Type	Method	Description
default ActionResult	AsyncJobsMixin.cancelJob(String jobId, RestResponse res)	[POST /juneau-jobs/{jobId}/cancel] — cancel a job and return its terminal result.
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.

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

Method parameters in org.apache.juneau.microservice.examples with annotations of type Path

Modifier and Type	Method	Description
org.apache.juneau.microservice.examples.DirectoryResource.RedirectToRoot	DirectoryResource.deleteFile(String path)	Deletes a file on the file system.
org.apache.juneau.microservice.examples.LogsResource.RedirectToRoot	LogsResource.deleteFile(String path)	Deletes a log file on the file system.
org.apache.juneau.microservice.examples.DirectoryResource.FileContents	DirectoryResource.downloadFile(RestResponse res, String path)	Downloads the contents of a file.
org.apache.juneau.microservice.examples.LogsResource.FileContents	LogsResource.downloadFile(RestResponse res, String path)	Downloads the contents of a file.
String	ConfigResource.getConfigEntry(String section, String key)
String	ConfigResource.getConfigEntry(String section, String key)
JsonMap	ConfigResource.getConfigSection(String section)
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.
JsonMap	ConfigResource.setConfigSection(String section, Map<String,Object> contents)
String	ConfigResource.setConfigValue(String section, String key, String value)
String	ConfigResource.setConfigValue(String section, String key, String value)
org.apache.juneau.microservice.examples.DirectoryResource.RedirectToRoot	DirectoryResource.updateFile(InputStream is, String path)	Adds or overwrites a file on the file system.
org.apache.juneau.microservice.examples.DirectoryResource.FileContents	DirectoryResource.viewFile(RestResponse res, String path)	Views the contents of a file.
void	LogsResource.viewFile(RestResponse res, String path, boolean highlight, String start, String end, String thread, String[] loggers, String[] severity)	Views the contents of a log file with optional filtering.
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 Path in org.apache.juneau.petstore.client

Method parameters in org.apache.juneau.petstore.client with annotations of type Path

Modifier and Type	Method	Description
Pet	PetStoreClient.getPet(long id)	Retrieves a pet by ID.

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

Method parameters in org.apache.juneau.petstore.console.dev with annotations of type Path

Modifier and Type	Method	Description
Pet	SecureApiRest.pet(long id)
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 Path in org.apache.juneau.petstore.console.ops

Method parameters in org.apache.juneau.petstore.console.ops with annotations of type Path

Modifier and Type	Method	Description
JsonMap	JobsRest.groomRunDetail(String id)	A groom run's detail panel.
Map<String,Object>	JobsRest.groomRunKey(RestRequest req, String id)	Issues a regroom key bound to one groom run and the caller.
JsonMap	JobsRest.job(String id)
ActionResult	JobsRest.regroom(RestRequest req, RestResponse res, String id, JsonMap json)	Grooms a run's pet again.
Object	JobsRest.restockSpecies(RestRequest req, RestResponse res, String id, JsonMap json)	Restocks one species from its row's detail panel.
JsonMap	JobsRest.speciesDetail(String id)	A species row's detail panel.
Map<String,Object>	JobsRest.speciesKey(RestRequest req, String id)	Issues a restock key bound to one species and the caller.

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

Method parameters in org.apache.juneau.petstore.console.orders with annotations of type Path

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.
ModalDef	OrdersRest.cancelForm(long id)	The cancel dialog form: a reason and whether to notify the customer.
ActionResult	OrdersRest.deliver(RestRequest req, long id)	Delivers an approved order.

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

Method parameters in org.apache.juneau.petstore.console.pets with annotations of type Path

Modifier and Type	Method	Description
ActionResult	ChangesRest.apply(RestRequest req, long id)	Applies one change (the bulk perRow action).
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.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.
View	PetsRest.detailTab(RestRequest req, RestResponse res, long id, String tab)	P4, one tab.
List<AuditEntry>	PetsRest.historyRows(long id)
JsonMap	PetsRest.orderDetail(long id, long orderId)	The Orders tab's row-detail GET.
JsonMap	PetsRest.orderDetail(long id, long orderId)	The Orders tab's row-detail GET.
List<Order>	PetsRest.orderRows(long id)
ActionResult	ChangesRest.retry(RestRequest req, long id)	Retries a failed change.
List<Pet>	PetsRest.row(long id)
ActionResult	PetsRest.sell(RestRequest req, long id)	Marks a pet sold.
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 Path in org.apache.juneau.petstore.console.users

Method parameters in org.apache.juneau.petstore.console.users with annotations of type Path

Modifier and Type	Method	Description
ActionResult	UsersRest.delete(RestRequest req, String username)	Deletes a user.
UsersRest.UserView	UsersRest.get(String username)
ActionResult	UsersRest.update(RestRequest req, String username, JsonMap body)	Updates a user.

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

Method parameters in org.apache.juneau.petstore.rest with annotations of type Path

Modifier and Type	Method	Description
void	PetStoreResource.deleteOrder(long id)	Deletes an order by ID.
void	PetStoreResource.deletePet(long id)	Deletes a pet by ID.
void	PetStoreResource.deleteUser(String username)	Deletes a user by username.
Order	PetStoreResource.getOrder(long id)	Retrieves an order by ID.
Pet	PetStoreResource.getPet(long id)	Retrieves a pet by ID.
BufferedImage	PetStoreResource.getPetPhoto(long id)	Retrieves the uploaded photo for a pet.
User	PetStoreResource.getUser(String username)	Retrieves a user by username.
Ok	PetStoreResource.putPetPhoto(long id, BufferedImage image)	Uploads a photo for a pet.
Order	PetStoreResource.updateOrder(long id, Order order)	Updates an existing order.
Pet	PetStoreResource.updatePet(long id, Pet pet)	Updates an existing pet.
User	PetStoreResource.updateUser(String username, User user)	Updates an existing user.

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

Method parameters in org.apache.juneau.rest.server.management with annotations of type Path

Modifier and Type	Method	Description
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.
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 Path in org.apache.juneau.rest.server.ops

Method parameters in org.apache.juneau.rest.server.ops with annotations of type Path

Modifier and Type	Method	Description
void	EchoMixin.echo(RestRequest req, RestResponse res, String remainder)	[* /echo/*] — emit an introspection echo of the inbound request.
HttpResource	HtdocMixin.getHtdoc(RestRequest req, String path, Locale locale)	[GET /htdocs/*] - Retrieve static file.

Uses of Path in org.apache.juneau.rest.server.remote

Method parameters in org.apache.juneau.rest.server.remote with annotations of type Path

Modifier and Type	Method	Description
Object	RrpcServlet.invoke(Reader r, ReaderParser p, ContentType contentType, String javaInterface, String javaMethod)
Object	RrpcServlet.invoke(Reader r, ReaderParser p, ContentType contentType, String javaInterface, String javaMethod)
Collection<LinkString>	RrpcServlet.listMethods(String javaInterface)
Div	RrpcServlet.showEntryForm(String javaInterface, String javaMethod)
Div	RrpcServlet.showEntryForm(String javaInterface, String javaMethod)

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

Method parameters in org.apache.juneau.rest.server.staticfile with annotations of type Path

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	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.

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

Method parameters in org.apache.juneau.rest.server.view with annotations of type Path

Modifier and Type	Method	Description
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 Path in org.apache.juneau.rest.server.view.freemarker

Method parameters in org.apache.juneau.rest.server.view.freemarker with annotations of type Path

Modifier and Type	Method	Description
void	FreemarkerMixin.render(String path, RestRequest req, RestResponse res)	[GET /freemarker/*] — render a raw template through the FreeMarker engine.

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

Method parameters in org.apache.juneau.rest.server.view.jsp with annotations of type Path

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

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

Method parameters in org.apache.juneau.rest.server.view.mustache with annotations of type Path

Modifier and Type	Method	Description
void	MustacheMixin.render(String path, RestRequest req, RestResponse res)	[GET /mustache/*] — render a raw template through the Mustache engine.

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

Method parameters in org.apache.juneau.rest.server.view.thymeleaf with annotations of type Path

Modifier and Type	Method	Description
void	ThymeleafMixin.render(String path, RestRequest req, RestResponse res)	[GET /thymeleaf/*] — render a raw template through the Thymeleaf engine.

Uses of Path in org.apache.juneau.server.config.rest

Method parameters in org.apache.juneau.server.config.rest with annotations of type Path

Modifier and Type	Method	Description
String	LoadConfigResource.gets(String project, String branch)	Returns configuration for the specified project and branch as JSON.
String	LoadConfigResource.gets(String project, String branch)	Returns configuration for the specified project and branch as JSON.

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

Method parameters in org.apache.juneau.terminal.region with annotations of type Path

Modifier and Type	Method	Description
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.