UserStopword3Resource.java

/*
 * Copyright © 2024-2025 The CTAN Team and individual authors
 *
 * This file is distributed under the 3-clause BSD license.
 * See file LICENSE for details.
 */
package org.ctan.site.resources.admin;

import org.ctan.site.domain.account.UserStopword;
import org.ctan.site.stores.UserStopwordStore;
import org.ctan.site.stores.base.GeneralPage;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import io.dropwizard.hibernate.UnitOfWork;
import jakarta.annotation.security.RolesAllowed;
import jakarta.ws.rs.DELETE;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.PUT;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.PathParam;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.QueryParam;
import jakarta.ws.rs.core.MediaType;
import lombok.NonNull;

/**
 * The class <code>CrudUserBlacklist3Resource</code> contains the CRUD
 * controller for the user black list resource.
 *
 * @author <a href="mailto:gene@ctan.org">Gerd Neugebauer</a>
 */
@Path("/3.0/admin")
@Produces(MediaType.APPLICATION_JSON)
@RolesAllowed("ADMIN")
public class UserStopword3Resource {

    /**
     * The field <code>store</code> contains the underlying store.
     */
    private UserStopwordStore store;

    /**
     * This is the constructor for the class <code>CrudUser3Resource</code>.
     *
     * @param store the underlying store
     */
    @SuppressFBWarnings(value = {"CT_CONSTRUCTOR_THROW", "EI_EXPOSE_REP2"})
    public UserStopword3Resource(@NonNull UserStopwordStore store) {

        this.store = store;
    }

    /**
     * The method <code>create</code> provides an end-point to create a user.
     *
     * @param stopword the user object to store
     * @return the updated entity
     */
    @POST
    @Path("/user-stopword")
    @UnitOfWork(value = "siteDb")
    public UserStopword create(@NonNull UserStopword stopword) {

        return store.save(stopword);
    }

    /**
     * The method <code>retrieve</code> provides means to retrieve a stop word.
     *
     * @param id the id
     * @return {@code true} iff the user exists
     */
    @GET
    @Path("/user-stopword/{id}")
    @UnitOfWork(value = "siteDb")
    public UserStopword get(@NonNull @PathParam("id") Long id) {

        return store.get(id);
    }

    /**
     * The method <code>list</code> provides means to retrieve a page of stop
     * words.
     *
     * @param q the name pattern
     * @param page the page
     * @param size the page size
     * @param orderBy the order
     * @param asc the indicator for ascending
     * @return the page for the user or {@code null}
     */
    @GET
    @Path("/user-stopwords")
    @UnitOfWork(value = "siteDb")
    public GeneralPage list(@QueryParam("q") String q,
        @QueryParam("page") int page,
        @QueryParam("size") int size,
        @QueryParam("order") String orderBy,
        @QueryParam("asc") boolean asc) {

        return store.list(q, page - 1, size, orderBy, asc);
    }

    /**
     * The method <code>remove</code> provides an end-point to remove a user.
     *
     * @param id the id
     * @return {@code true} iff the user has existed
     */
    @DELETE
    @Path("/user-stopword/{id}")
    @UnitOfWork(value = "siteDb")
    public boolean remove(@NonNull @PathParam("id") Long id) {

        return store.remove(id);
    }

    /**
     * The method <code>retrieve</code> provides means to retrieve a user.
     *
     * @param stopword the stop word
     * @return {@code true} iff the user exists
     */
    @GET
    @Path("/user-stopword/by-word/{stopword}")
    @UnitOfWork(value = "siteDb")
    public UserStopword retrieve(
        @NonNull @PathParam("stopword") String stopword) {

        return store.getByStopword(stopword);
    }

    /**
     * The method <code>set</code> provides means to reset a single stop word.
     *
     * @param id the id of the stopword
     * @param value the new value
     * @return {@code true} iff the setting has succeeded
     */
    @PUT
    @Path("/user-stopword/{id}")
    @UnitOfWork(value = "siteDb")
    public boolean set(@NonNull @PathParam("id") Long id,
        @NonNull String value) {

        return store.set(id, value);
    }
}