CrudAuthor3Resource.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 java.util.Map;

import org.ctan.site.domain.catalogue.Author;
import org.ctan.site.stores.AuthorStore;
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.DefaultValue;
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>CrudAuthor3Resource</code> contains the CRUD controller for
 * the author resource.
 *
 * @author <a href="mailto:gene@ctan.org">Gerd Neugebauer</a>
 */
@Path("/3.0/admin")
@Produces(MediaType.APPLICATION_JSON)
@RolesAllowed("ADMIN")
public class CrudAuthor3Resource {

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

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

        this.store = store;
    }

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

        return store.save(author);
    }

    /**
     * The method <code>get</code> provides means to retrieve a author.
     *
     * @param key the account
     * @return {@code true} iff the author exists
     */
    @GET
    @Path("/author/{key}")
    @UnitOfWork(value = "siteDb")
    public Author get(@NonNull @PathParam("key") String key) {

        return store.getByKey(key);
    }

    /**
     * The method <code>list</code> provides means to retrieve a page of
     * authors.
     *
     * @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 author or {@code null}
     */
    @GET
    @Path("/authors")
    @UnitOfWork(value = "siteDb")
    public GeneralPage list(@QueryParam("q") String q,
        @QueryParam("page") @DefaultValue("1") int page,
        @QueryParam("size") @DefaultValue("256") 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 author.
     *
     * @param key the account
     * @return {@code true} iff the author has existed
     */
    @DELETE
    @Path("/author/{key}")
    @UnitOfWork(value = "siteDb")
    public boolean remove(@NonNull @PathParam("key") String key) {

        var author = store.getByKey(key);
        return author == null ? false : store.remove(author);
    }

    /**
     * The method <code>set</code> provides means to set a single attribute of
     * an author.
     *
     * @param author the author
     * @param map the mapping containing key and value
     * @return {@code true} iff the setting has succeeded
     */
    @PUT
    @Path("/author/{author}")
    @UnitOfWork(value = "siteDb")
    public boolean set(@NonNull @PathParam("author") String author,
        @NonNull Map<String, String> map) {

        return store.set(author,
            map.get("key"),
            map.get("value")) != null;
    }
}