org.mycore.services.queuedjob.MCRJob Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mycore-base Show documentation
There is a newer version: 2024.05
/*
 * This file is part of ***  M y C o R e  ***
 * See http://www.mycore.de/ for details.
 *
 * MyCoRe is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * MyCoRe is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with MyCoRe.  If not, see .
 */

package org.mycore.services.queuedjob;

import java.text.MessageFormat;
import java.util.Date;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;

import javax.persistence.CollectionTable;
import javax.persistence.Column;
import javax.persistence.Convert;
import javax.persistence.ElementCollection;
import javax.persistence.Entity;
import javax.persistence.EnumType;
import javax.persistence.Enumerated;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.MapKeyColumn;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;
import javax.persistence.Table;
import javax.persistence.Transient;

/**
 * Container class handled by hibernate to store and retrieve job information.
 * 
 * @author Ren\u00E9 Adler
 */
@Entity
@NamedQueries({
    @NamedQuery(name = "mcrjob.classes",
        query = "select DISTINCT(o.action) from MCRJob o") })
@Table(name = "MCRJob")
public class MCRJob implements Cloneable {
    private long id;

    private Class action;

    private MCRJobStatus status;

    private Date added;

    private Date start;

    private Date finished;

    private Map parameters;

    protected MCRJob() {
    }

    public MCRJob(Class actionClass) {
        action = actionClass;
    }

    /**
     * Returns the job Id.
     * 
     * @return the job Id
     */
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "id")
    public long getId() {
        return id;
    }

    /**
     * Set the job Id.
     * 
     * @param id - the job id
     */
    protected void setId(long id) {
        this.id = id;
    }

    /**
     * Returns the action class ({@link MCRJobAction}).
     * 
     * @return the action class
     */
    @Column(name = "action", nullable = false)
    @Convert(converter = MCRJobActionConverter.class)
    public Class getAction() {
        return action;
    }

    /**
     * Set the action class ({@link MCRJobAction}).
     * 
     * @param actionClass - the action class to set
     */
    public void setAction(Class actionClass) {
        this.action = actionClass;
    }

    /**
     * Returns the current state ({@link MCRJobStatus}) of the job.
     * 
     */
    @Column(name = "status", nullable = false)
    @Enumerated(EnumType.STRING)
    public MCRJobStatus getStatus() {
        return status;
    }

    /**
     * Set the state ({@link MCRJobStatus}) of the job.
     * 
     * @param status - the job status
     */
    public void setStatus(MCRJobStatus status) {
        this.status = status;
    }

    /**
     * Returns the adding date of job.
     * 
     * @return the add date of the job
     */
    @Column(name = "added", nullable = true)
    public Date getAdded() {
        return added;
    }

    /**
     * Set the adding date.
     * 
     */
    public void setAdded(Date added) {
        this.added = added;
    }

    /**
     * Returns the starting date of execution.
     *  
     * @return the job start date
     */
    @Column(name = "start", nullable = true)
    public Date getStart() {
        return start;
    }

    /**
     * Set the job starting date.
     * 
     * @param start - the starting date
     */
    public void setStart(Date start) {
        this.start = start;
    }

    /**
     * Returns the finishing date of execution.
     * 
     * @return the finishing date
     */
    @Column(name = "finished", nullable = true)
    public Date getFinished() {
        return finished;
    }

    /**
     * Set the finishing date of execution.
     * 
     * @param finished - the finishing date
     */
    public void setFinished(Date finished) {
        this.finished = finished;
    }

    /**
     * Returns all set parameters of the job.
     * 
     * @return the job parameters
     */
    @ElementCollection(fetch = FetchType.EAGER)
    @CollectionTable(name = "MCRJobParameter", joinColumns = @JoinColumn(name = "jobID"))
    @MapKeyColumn(name = "paramKey", length = 128)
    @Column(name = "paramValue", length = 255)
    public Map getParameters() {
        return parameters;
    }

    /**
     * Set all job parameters.
     * 
     * @param parameters - the job parameters
     */
    public void setParameters(Map parameters) {
        this.parameters = parameters;
    }

    /**
     * Returns an single parameter by it's name.
     * 
     * @param key - the parameter name.
     * @return the value of the parameter.
     */
    @Transient
    public String getParameter(String key) {
        if (parameters == null) {
            return null;
        }

        return parameters.get(key);
    }

    /**
     * Set an single parameter.
     * 
     * @param key - the parameter name
     * @param value - the parameter value
     */
    public void setParameter(String key, String value) {
        if (parameters == null) {
            parameters = new HashMap<>();
        }

        parameters.put(key, value);
    }

    /* (non-Javadoc)
     * @see java.lang.Object#clone()
     */
    @Override
    public MCRJob clone() {
        MCRJob clone = new MCRJob();
        clone.setAction(getAction());
        clone.setAdded(getAdded());
        clone.setFinished(getFinished());
        clone.setId(getId());
        clone.setStart(getStart());
        clone.setStatus(getStatus());

        Map map = new HashMap<>(getParameters());
        clone.setParameters(map);

        return clone;
    }

    /* (non-Javadoc)
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        return new MessageFormat("MCRJob [id:{0}, action:{1}, status:{2}, added:{3}, parameters:{4}]", Locale.ROOT)
            .format(
                new Object[] { getId(), getAction().getName(), getStatus(), getAdded(), getParameters() });
    }

}