de.terrestris.shoguncore.web.AbstractWebController Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of shogun-core-main Show documentation

There is a newer version: 5.3.13

package de.terrestris.shoguncore.web;

import org.apache.logging.log4j.Logger;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;

import de.terrestris.shoguncore.dao.GenericHibernateDao;
import de.terrestris.shoguncore.model.PersistentObject;
import de.terrestris.shoguncore.service.AbstractCrudService;

import static org.apache.logging.log4j.LogManager.getLogger;

/**
 * This abstract controller class provides basic web controller functionality:
 * A logger and a service.
 *
 * @author Daniel Koch
 */
public abstract class AbstractWebController, S extends AbstractCrudService> {

    /**
     * The LOGGER instance (that will be available in all subclasses)
     */
    protected final Logger LOG = getLogger(getClass());

    /**
     * Provides the concrete entity class of the controller.
     * Based on the pattern propsed here: http://stackoverflow.com/a/3403987
     */
    private final Class entityClass;

    /**
     * Constructor that sets the concrete entity class for the controller.
     * Subclasses MUST call this constructor.
     */
    protected AbstractWebController(Class entityClass) {
        this.entityClass = entityClass;
    }

    /**
     * The {@link AbstractCrudService} for this controller.
     */
    protected S service;

    /**
     * Subclasses must implement this class and annotate it with
     * {@link Autowired} and {@link Qualifier}!
     *
     * @param service the service to set
     */
    public abstract void setService(S service);

    /**
     * @return the service
     */
    public S getService() {
        return service;
    }

    /**
     * @return the entityClass
     */
    public Class getEntityClass() {
        return entityClass;
    }

}