Package org.apache.juneau.microservice.examples

Class DebugResource

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

org.apache.juneau.rest.server.servlet.RestServlet

org.apache.juneau.rest.server.servlet.BasicRestServlet

org.apache.juneau.microservice.examples.DebugResource

All Implemented Interfaces:

jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable, BasicUniversalConfig, DefaultConfig, DefaultHtmlConfig

public class DebugResource
extends BasicRestServlet

Microservice debug utilities.

The jetty-thread-dump navlink is a plain GET /jetty/dump, which shows the dump. Writing the dump to jetty-thread-dump.log needs a real POST /jetty/dump; a link can't reach it, because the router refuses any override of a GET to POST. Put the resource behind a CSRF boundary before mounting it anywhere a browser can reach.

See Also:

• juneau-microservice-jetty

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.juneau.rest.server.servlet.RestServlet

RestServlet.Builder<R extends RestServlet,SELF extends RestServlet.Builder<R,SELF>>, RestServlet.DefaultBuilder<R extends RestServlet>

Field Summary

Fields inherited from class jakarta.servlet.http.HttpServlet

LEGACY_DO_HEAD

Constructor Summary

Constructors

Constructor	Description
DebugResource()

Method Summary

Modifier and Type	Method	Description
Ok	createJettyDump(RestRequest req, RestResponse res)	[POST /jetty/dump] - Generates and saves the jetty thread dump file to jetty-thread-dump.log.
ResourceDescriptions	getChildren()	[GET /] - Shows child utilities.
Reader	getJettyDump(RestRequest req, RestResponse res)	[GET /jetty/dump] - Generates and retrieves the jetty thread dump.

Methods inherited from class org.apache.juneau.rest.server.servlet.RestServlet

builder, createAuthenticator, destroy, doLog, getContext, getPath, getPaths, getRequest, getResponse, getRestBuilder, init, log, log, service, setContext

Methods inherited from class jakarta.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPatch, doPost, doPut, doTrace, getLastModified, isSensitiveHeader, service

Methods inherited from class jakarta.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DebugResource

public DebugResource()

Method Details

createJettyDump

public Ok createJettyDump(RestRequest req,
 RestResponse res)
                   throws Exception

[POST /jetty/dump] - Generates and saves the jetty thread dump file to jetty-thread-dump.log.

Parameters:

req - The request.

res - The response.

Returns:

The thread dump contents.

Throws:

Exception - Gets converted to 500 response.

getChildren

public ResourceDescriptions getChildren()

[GET /] - Shows child utilities.

Returns:

Child utility links.

getJettyDump

public Reader getJettyDump(RestRequest req,
 RestResponse res)

[GET /jetty/dump] - Generates and retrieves the jetty thread dump.

Parameters:

req - The request.

res - The response.

Returns:

The thread dump contents.