org.usefultoys.slf4j.report

Class ReportServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.usefultoys.slf4j.report.ReportServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class ReportServlet
extends javax.servlet.http.HttpServlet

A servlet that logs system reports based on the URL path provided in the HTTP request.

This servlet handles HTTP GET requests and triggers the appropriate Reporter module based on the path suffix. The corresponding system report is logged using the SLF4J logger.

The following path suffixes are supported:

• /VM — Logs Java Virtual Machine information.
• /FileSystem — Logs information about available and used disk space.
• /Memory — Logs memory usage details.
• /User — Logs information about the current user.
• /PhysicalSystem — Logs physical hardware information.
• /OperatingSystem — Logs operating system details.
• /Calendar — Logs date, time, and timezone information.
• /Locale — Logs current and available locale settings.
• /Charset — Logs current and available character sets.
• /NetworkInterface — Logs information for each available network interface.

If the path does not match any known suffix, no action is taken and the request is silently ignored.

Security considerations

This servlet accesses and logs potentially sensitive system information. Therefore, the following security measures are strongly recommended:

• Restrict access to the servlet endpoint using authentication or IP whitelisting.
• Avoid exposing this servlet in production environments or public networks without proper protection.
• Ensure that reporting environment variables or system properties is disabled unless explicitly needed, to avoid leaking secrets like passwords, API keys, or tokens.
• Use a read-only, non-sensitive logger configuration to avoid side effects.
• Use a secure logging strategy — logged reports may contain sensitive data and should not be publicly accessible or retained longer than necessary.
• Be aware of log injection and log disclosure risks: an attacker could trigger this servlet and indirectly cause logs to capture sensitive or excessive system information. Limit logging verbosity and protect log files appropriately.
• Protect against denial-of-service (DoS) attacks: repeated requests to expensive endpoints such as /NetworkInterface can overload the system or exhaust resources. Consider adding rate limiting or caching to mitigate abuse.

Author:

Daniel Felix Ferber

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ReportServlet()

Method Summary

Modifier and Type	Method and Description
protected void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportServlet

public ReportServlet()

Method Detail

doGet

protected void doGet(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)

Overrides:

doGet in class javax.servlet.http.HttpServlet