FavoritesNamesServlet.java

package server.restful.servlets;

import com.beust.jcommander.ParameterException;
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.converter.WebResourceConverter;
import server.restful.common.parameter.ServletParameterParser;
import server.restful.common.parameter.UsageParameter;
import ui.entities.config.FavoritesSection;

import java.io.IOException;
import java.io.InputStream;
import java.util.List;
import java.util.stream.Collectors;

import static server.restful.JSIDPlay2Server.*;
import static server.restful.common.ContentTypeAndFileExtensions.MIME_TYPE_JSON;
import static server.restful.common.ServletUtil.error;
import static server.restful.servlets.FavoritesServlet.BUILT_IN_FAVORITES_PATH;

@WebServlet(name = "FavoritesNamesServlet", displayName = "FavoritesNamesServlet", urlPatterns = CONTEXT_ROOT_SERVLET
        + "/favorite_names", description = "Get names of all favorites tab")
@ServletSecurity(value = @HttpConstraint(rolesAllowed = {ROLE_USER, ROLE_ADMIN}))
public class FavoritesNamesServlet extends JSIDPlay2Servlet {

    @Parameters(resourceBundle = "server.restful.servlets.FavoritesNamesServletParameters")
    public static class FavoriteNamesServletParameters extends UsageParameter {

    }

    /**
     * Get the contents of the first SID favorites tab.
     * <p>
     * E.g. {@code http://haendel.ddns.net:8080/jsidplay2service/JSIDPlay2REST/favorites }
     */
    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response) {
        try {
            final FavoriteNamesServletParameters servletParameters = new FavoriteNamesServletParameters();

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

            if (servletParameters.getHelp() || parser.hasException()) {
                parser.usage();
                return;
            }
            List<String> favoritesNames = getFavoritesNames();

            setOutput(MIME_TYPE_JSON, response, favoritesNames);

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

    private List<String> getFavoritesNames() {
        List<String> filters = configuration.getFavorites().stream()
                .filter(favoritesSection -> !favoritesSection.getFavorites().isEmpty())
                .map(FavoritesSection::getName)
                .collect(Collectors.toList());
        int i = 0;
        do {
            String resource = String.format(BUILT_IN_FAVORITES_PATH, i);
            try (InputStream ignored = new WebResourceConverter(SERVLET_PATH).convert(resource)) {
                filters.add(String.format("Playlist-%d", ++i));
            } catch (IOException | ParameterException e) {
                break;
            }
        } while (true);
        return filters;
    }

}