LogsServlet.java

package server.restful.servlets;

import com.beust.jcommander.Parameter;
import com.beust.jcommander.Parameters;
import jakarta.servlet.annotation.HttpConstraint;
import jakarta.servlet.annotation.ServletSecurity;
import jakarta.servlet.annotation.WebServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import server.restful.common.JSIDPlay2Servlet;
import server.restful.common.Order;
import server.restful.common.parameter.ServletParameterParser;
import server.restful.common.parameter.requestparam.LogRequestParamServletParameters;
import server.restful.common.validator.MaxResultsValidator;
import ui.entities.debug.DebugEntry;
import ui.entities.debug.service.DebugService;

import java.util.List;

import static java.lang.Integer.MIN_VALUE;
import static server.restful.JSIDPlay2Server.*;
import static server.restful.common.ContentTypeAndFileExtensions.MIME_TYPE_JSON;
import static server.restful.common.ServletUtil.error;

@WebServlet(name = "LogsServlet", displayName = "LogsServlet", urlPatterns = CONTEXT_ROOT_SERVLET
        + "/logs", description = "Get log message list")
@ServletSecurity(value = @HttpConstraint(rolesAllowed = {ROLE_ADMIN}))
public class LogsServlet extends JSIDPlay2Servlet {

    @SuppressWarnings("unused")
    @Parameters(resourceBundle = "server.restful.servlets.LogsServletParameters")
    public static class LogsServletParameters extends LogRequestParamServletParameters {

        private Integer maxResults = 100;

        public Integer getMaxResults() {
            return maxResults;
        }

        @Parameter(names = {
                "--maxResults"}, descriptionKey = "MAX_RESULTS", required = true, validateWith = MaxResultsValidator.class, order = MIN_VALUE
                + 8)
        public void setMaxResults(Integer maxResults) {
            this.maxResults = maxResults;
        }

    }

    /**
     * Get a log message list.
     * <p>
     * E.g. {@code E.g. http://haendel.ddns.net:8080/jsidplay2service/JSIDPlay2REST/logs }
     */
    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response) {
        try {
            final LogsServletParameters servletParameters = new LogsServletParameters();

            ServletParameterParser parser = new ServletParameterParser(request, response, servletParameters);

            if (servletParameters.getHelp() || parser.hasException()) {
                parser.usage();
                return;
            }
            Long instant = servletParameters.getInstant();
            String sourceClassName = servletParameters.getSourceClassName();
            String sourceMethodName = servletParameters.getSourceMethodName();
            String level = servletParameters.getLevel();
            String message = servletParameters.getMessage();
            Integer maxResults = servletParameters.getMaxResults();
            Order order = servletParameters.getOrder();
            Boolean tooMuchLogging = servletParameters.getTooMuchLogging();

            final DebugService debugService = new DebugService(getDebugEntityManager());
            List<DebugEntry> result = debugService.findDebugEntries(instant, sourceClassName, sourceMethodName, level,
                    message, maxResults, order, tooMuchLogging);

            setOutput(MIME_TYPE_JSON, response, result);

        } catch (Throwable t) {
            response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
            error(getServletContext(), t);
            setOutput(response, t);
        } finally {
            freeDebugEntityManager();
        }
    }

}