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

Packages that use RestRequest

Package	Description
org.apache.juneau.examples.rest	REST Server Examples
org.apache.juneau.microservice.jetty.resources	Predefined Jetty Microservice Resources
org.apache.juneau.microservice.resources	Predefined Microservice Resources
org.apache.juneau.rest	REST Server API
org.apache.juneau.rest.arg	REST Method Argument Beans
org.apache.juneau.rest.beans	REST Interface Helper Classes
org.apache.juneau.rest.converter	REST Response Converters
org.apache.juneau.rest.guard	REST Guards
org.apache.juneau.rest.httppart	REST HTTP Parts
org.apache.juneau.rest.servlet	REST Servlets
org.apache.juneau.rest.springboot	Spring Boot Integration
org.apache.juneau.rest.widget	HTML Widget API

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

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

Modifier and Type	Method	Description
jakarta.servlet.http.HttpServletRequest	RequestEchoResource.doGet(RestRequest req)	[HTTP GET /echo/*] GET request handler.
boolean	AdminGuard.isRequestAllowed(RestRequest req)

Uses of RestRequest in org.apache.juneau.microservice.jetty.resources

Methods in org.apache.juneau.microservice.jetty.resources 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.
Reader	DebugResource.getJettyDump(RestRequest req, RestResponse res)	[GET /jetty/dump] - Generates and retrieves the jetty thread dump.

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

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

Modifier and Type	Method	Description
DirectoryResource.FileResource	DirectoryResource.getFile(RestRequest req, String path)
LogsResource.FileResource	LogsResource.getFile(RestRequest req, String path)
LogParser	LogsResource.viewParsedEntries(RestRequest req, String path, String start, String end, String thread, String[] loggers, String[] severity)

Uses of RestRequest in org.apache.juneau.rest

Methods in org.apache.juneau.rest 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.setDebug()	Shortcut for calling setDebug(true).
RestRequest	RestRequest.setDebug(Boolean b)	Sets the "Debug" attribute to the specified boolean.
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.

Methods in org.apache.juneau.rest 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 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.arg

Constructor parameters in org.apache.juneau.rest.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.beans

Methods in org.apache.juneau.rest.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.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.converter

Methods in org.apache.juneau.rest.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.guard

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

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

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

Methods in org.apache.juneau.rest.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.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.
	RequestFormParams(RestRequest req, boolean caseSensitive)	Constructor.
	RequestHeader(RestRequest request, String name, String value)	Constructor.
	RequestHeaders(RestRequest req, RequestQueryParams query, boolean caseSensitive)	Constructor.
	RequestHttpPart(HttpPartType partType, RestRequest request, String name, String value)	Constructor.
	RequestPathParam(RestRequest request, String name, String value)	Constructor.
	RequestPathParams(RestSession session, RestRequest req, boolean caseSensitive)	Constructor.
	RequestQueryParam(RestRequest request, String name, String value)	Constructor.
	RequestQueryParams(RestRequest req, Map<String,String[]> query, boolean caseSensitive)	Constructor.

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

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

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

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

Modifier and Type	Method	Description
ChildResourceDescriptions	BasicGroupOperations.getChildren(RestRequest req)	[GET /] - Get child resources.
ChildResourceDescriptions	BasicRestObjectGroup.getChildren(RestRequest req)
ChildResourceDescriptions	BasicRestServletGroup.getChildren(RestRequest req)
RestContextStats	BasicRestObject.getStats(RestRequest req)
RestContextStats	BasicRestOperations.getStats(RestRequest req)	[GET /stats] - Timing statistics.
RestContextStats	BasicRestServlet.getStats(RestRequest req)
Swagger	BasicRestObject.getSwagger(RestRequest req)
Swagger	BasicRestOperations.getSwagger(RestRequest req)	[GET /api] - Show resource options.
Swagger	BasicRestServlet.getSwagger(RestRequest req)

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

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

Modifier and Type	Method	Description
ChildResourceDescriptions	BasicSpringRestServletGroup.getChildren(RestRequest req)
RestContextStats	BasicSpringRestServlet.getStats(RestRequest req)
Swagger	BasicSpringRestServlet.getSwagger(RestRequest req)

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

Methods in org.apache.juneau.rest.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)
Div	ThemeMenuItem.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	ThemeMenuItem.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.