DirectoryServlet.java

package server.restful.servlets;

import com.beust.jcommander.Parameters;
import jakarta.servlet.AsyncContext;
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.async.DefaultThreadFactory;
import server.restful.common.async.HttpAsyncContextRunnable;
import server.restful.common.parameter.ServletParameterParser;
import server.restful.common.parameter.requestpath.DirectoryRequestPathServletParameters;

import java.util.List;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;

import static server.restful.JSIDPlay2Server.*;
import static server.restful.common.ContentTypeAndFileExtensions.MIME_TYPE_JSON;
import static server.restful.common.IServletSystemProperties.DirectoryServlet.DIRECTORY_ASYNC_TIMEOUT;
import static server.restful.common.IServletSystemProperties.DirectoryServlet.MAX_DIRECTORY_IN_PARALLEL;
import static server.restful.common.ServletUtil.error;

@WebServlet(name = "DirectoryServlet", displayName = "DirectoryServlet", asyncSupported = true, urlPatterns = CONTEXT_ROOT_SERVLET
        + "/directory/*", description = "Get directory contents containing music collections")
@ServletSecurity(value = @HttpConstraint(rolesAllowed = {ROLE_USER, ROLE_ADMIN}))
public class DirectoryServlet extends JSIDPlay2Servlet {

    @Parameters(resourceBundle = "server.restful.servlets.DirectoryServletParameters")
    public static class DirectoryServletParameters extends DirectoryRequestPathServletParameters {

    }

    private ExecutorService executorService;

    @Override
    public void init() {
        executorService = Executors.newFixedThreadPool(MAX_DIRECTORY_IN_PARALLEL,
                new DefaultThreadFactory("/directory"));
    }

    @Override
    public void destroy() {
        executorService.shutdown();
    }

    /**
     * Get directory contents containing music collections.
     * <p>
     * E.g.
     * {@code
     * http://haendel.ddns.net:8080/jsidplay2service/JSIDPlay2REST/directory/C64Music/MUSICIANS?filter=.*%5C.(sid%7Cdat%7Cmus%7Cstr%7Cmp3%7Cmp4%7Cjpg%7Cprg%7Cd64)$
     * }
     */
    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response) {

        AsyncContext asyncContext = request.startAsync(request, response);
        asyncContext.setTimeout(DIRECTORY_ASYNC_TIMEOUT);

        executorService.execute(new HttpAsyncContextRunnable(asyncContext, getServletContext()) {

            public void run(HttpServletRequest request, HttpServletResponse response) {
                try {
                    final DirectoryServletParameters servletParameters = new DirectoryServletParameters();

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

                    final List<String> files = servletParameters.fetchDirectory(configuration, directoryProperties,
                            parser, hasAdminAccess(request));
                    if (files == null || servletParameters.getHelp() || parser.hasException()) {
                        parser.usage();
                        return;
                    }
                    if (!isComplete()) {
                        setOutput(MIME_TYPE_JSON, response, files);
                    }
                } catch (Throwable t) {
                    error(getServletContext(), t, parentThread);
                    if (!isComplete()) {
                        response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
                        setOutput(response, t);
                    }
                }
            }
        });
    }

}