uk.gov.gchq.gaffer.jobtracker.JobDetail Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of operation Show documentation
There is a newer version: 2.3.1
/*
 * Copyright 2016-2020 Crown Copyright
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package uk.gov.gchq.gaffer.jobtracker;

import com.fasterxml.jackson.annotation.JsonIgnore;
import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;

import uk.gov.gchq.gaffer.commonutil.CommonConstants;
import uk.gov.gchq.gaffer.commonutil.ToStringBuilder;
import uk.gov.gchq.gaffer.jsonserialisation.JSONSerialiser;
import uk.gov.gchq.gaffer.operation.OperationChain;
import uk.gov.gchq.gaffer.user.User;

import java.io.Serializable;
import java.nio.charset.Charset;

/**
 * POJO containing details of a Gaffer job.
 */
public class JobDetail implements Serializable {
    private static final long serialVersionUID = -1677432285205724269L;
    private static final String CHARSET_NAME = CommonConstants.UTF_8;
    private String parentJobId;
    private Repeat repeat;
    private String jobId;
    private User user;
    private JobStatus status;
    private Long startTime;
    private Long endTime;
    private String opChain;
    private String serialisedOperationChain;
    private String description;

    public JobDetail() {
    }

    public JobDetail(final JobDetail oldJobDetail, final JobDetail newJobDetail) {
        this.jobId = getNewOrOld(oldJobDetail.jobId, newJobDetail.jobId);
        this.user = getNewOrOld(oldJobDetail.user, newJobDetail.user);
        this.opChain = getNewOrOld(oldJobDetail.opChain, newJobDetail.opChain);
        this.serialisedOperationChain = getNewOrOld(oldJobDetail.serialisedOperationChain, newJobDetail.serialisedOperationChain);
        this.description = getNewOrOld(oldJobDetail.description, newJobDetail.description);
        this.status = getNewOrOld(oldJobDetail.status, newJobDetail.status);
        this.parentJobId = getNewOrOld(oldJobDetail.parentJobId, newJobDetail.parentJobId);
        this.repeat = getNewOrOld(oldJobDetail.repeat, newJobDetail.repeat);

        if (null == oldJobDetail.startTime) {
            this.startTime = System.currentTimeMillis();
        } else {
            this.startTime = oldJobDetail.startTime;
            this.endTime = System.currentTimeMillis();
        }
    }

    public JobDetail(final String jobId, final User user, final OperationChain opChain, final JobStatus jobStatus, final String description) {
        this(jobId, null, user, opChain, jobStatus, description);
    }

    public JobDetail(final String jobId, final String parentJobId, final User user, final OperationChain opChain, final JobStatus jobStatus, final String description) {
        this.jobId = jobId;
        this.parentJobId = parentJobId;
        this.user = user;
        this.startTime = System.currentTimeMillis();
        this.status = jobStatus;
        this.opChain = null != opChain ? opChain.toOverviewString() : "";
        this.description = description;
    }

    public JobDetail(final String jobId, final String parentJobId, final User user, final String opChain, final JobStatus jobStatus, final String description) {
        setOpChain(opChain);
        this.jobId = jobId;
        this.user = user;
        this.startTime = System.currentTimeMillis();
        this.status = jobStatus;
        this.description = description;
        this.parentJobId = parentJobId;
    }

    public JobDetail(final String jobId, final String parentJobId, final User user, final String opChain, final String serialisedOperationChain, final JobStatus jobStatus, final String description, final Repeat repeat) {
        this(jobId, parentJobId, user, opChain, jobStatus, description);
        this.serialisedOperationChain = serialisedOperationChain;
        this.repeat = repeat;
    }

    public String getJobId() {
        return jobId;
    }

    public void setJobId(final String jobId) {
        this.jobId = jobId;
    }

    public User getUser() {
        return user;
    }

    public void setUser(final User user) {
        this.user = user;
    }

    public JobStatus getStatus() {
        return status;
    }

    public void setStatus(final JobStatus status) {
        this.status = status;
    }

    public Long getStartTime() {
        return startTime;
    }

    public void setStartTime(final Long startTime) {
        this.startTime = startTime;
    }

    public Long getEndTime() {
        return endTime;
    }

    public void setEndTime(final Long endTime) {
        this.endTime = endTime;
    }

    public void setParentJobId(final String parentJobId) {
        this.parentJobId = parentJobId;
    }

    public String getParentJobId() {
        return parentJobId;
    }

    public String getOpChain() {
        return opChain;
    }

    public void setOpChain(final String opChain) {
        this.opChain = opChain;
    }

    public String getSerialisedOperationChain() {
        return serialisedOperationChain;
    }

    public void setSerialisedOperationChain(final String serialisedOperationChain) {
        this.serialisedOperationChain = serialisedOperationChain;
    }

    @JsonIgnore
    public void setSerialisedOperationChain(final OperationChain operationChain) {
        this.serialisedOperationChain = serialiseOperationChain(operationChain);
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(final String description) {
        this.description = description;
    }

    public Repeat getRepeat() {
        return repeat;
    }

    public void setRepeat(final Repeat repeat) {
        this.repeat = repeat;
    }

    @Override
    public boolean equals(final Object obj) {
        if (this == obj) {
            return true;
        }
        if (null == obj || getClass() != obj.getClass()) {
            return false;
        }
        final JobDetail jobDetail = (JobDetail) obj;
        return new EqualsBuilder()
                .append(jobId, jobDetail.jobId)
                .append(user, jobDetail.user)
                .append(opChain, jobDetail.opChain)
                .append(serialisedOperationChain, jobDetail.serialisedOperationChain)
                .append(startTime, jobDetail.startTime)
                .append(endTime, jobDetail.endTime)
                .append(status, jobDetail.status)
                .append(description, jobDetail.description)
                .append(parentJobId, jobDetail.parentJobId)
                .append(repeat, jobDetail.repeat)
                .isEquals();
    }

    @Override
    public int hashCode() {
        return new HashCodeBuilder(23, 53)
                .append(jobId)
                .append(user)
                .append(opChain)
                .append(serialisedOperationChain)
                .append(startTime)
                .append(endTime)
                .append(status)
                .append(description)
                .append(parentJobId)
                .append(repeat)
                .toHashCode();
    }

    @Override
    public String toString() {
        return new ToStringBuilder(this)
                .append("jobId", jobId)
                .append("user", user)
                .append("status", status)
                .append("startTime", startTime)
                .append("endTime", endTime)
                .append("opChain", opChain)
                .append("serialisedOperationChain", serialisedOperationChain)
                .append("description", description)
                .append("parentJobId", parentJobId)
                .append("repeat", repeat)
                .toString();
    }

    private  T getNewOrOld(final T oldValue, final T newValue) {
        return null == newValue ? oldValue : newValue;
    }

    public static final class Builder {
        private String parentJobId;
        private Repeat repeat;
        private String jobId;
        private User user;
        private JobStatus status;
        private String opChain;
        private String serialisedOperationChain;
        private String description;

        public Builder parentJobId(final String parentJobId) {
            this.parentJobId = parentJobId;
            return this;
        }

        public Builder repeat(final Repeat repeat) {
            this.repeat = repeat;
            return this;
        }

        public Builder jobId(final String jobId) {
            this.jobId = jobId;
            return this;
        }

        public Builder user(final User user) {
            this.user = user;
            return this;
        }

        public Builder status(final JobStatus status) {
            this.status = status;
            return this;
        }

        public Builder opChain(final String opChain) {
            this.opChain = opChain;
            return this;
        }

        public Builder opChain(final OperationChain opChain) {

            this.opChain = null != opChain ? opChain.toOverviewString() : "";
            return this;
        }

        public Builder serialisedOperationChain(final String serialisedOperationChain) {
            this.serialisedOperationChain = serialisedOperationChain;
            return this;
        }

        public Builder serialisedOperationChain(final OperationChain opChain) {

            this.serialisedOperationChain = serialiseOperationChain(opChain);
            return this;
        }

        public Builder description(final String description) {
            this.description = description;
            return this;
        }

        public JobDetail build() {
            return new JobDetail(jobId, parentJobId, user, opChain, serialisedOperationChain, status, description, repeat);
        }
    }

    private static String serialiseOperationChain(final OperationChain operationChain) {

        if (operationChain == null) {
            return "";
        }

        try {

            return new String(JSONSerialiser.serialise(operationChain), Charset.forName(CHARSET_NAME));

        } catch (final Exception exception) {

            throw new IllegalArgumentException(exception.getMessage());
        }
    }
}