Run.java

/*
 *  Copyright 2013-2014 Eric F. Savage, code@efsavage.com
 *
 *   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 com.ajah.job.run;

import java.math.BigDecimal;
import java.util.Date;

import javax.persistence.GeneratedValue;
import javax.persistence.Transient;

import lombok.Data;
import lombok.extern.slf4j.Slf4j;

import com.ajah.job.Job;
import com.ajah.job.JobId;
import com.ajah.job.run.data.RunMessageManager;
import com.ajah.job.run.data.RunMetricManager;
import com.ajah.spring.jdbc.err.DataOperationException;
import com.ajah.util.Identifiable;

/**
 * A Run is a unique execution of a {@link Job}.
 * 
 * @author <a href="http://efsavage.com">Eric F. Savage</a>, <a
 *         href="mailto:code@efsavage.com">code@efsavage.com</a>.
 * 
 */
@Data
@Slf4j
public class Run implements Identifiable<RunId> {

	@GeneratedValue
	private RunId id;
	private JobId jobId;
	private RunStatus status;
	private RunType type;
	private Date created;
	private Date start;
	private Date end;
	private Date lastActivity;
	private long maxDuration;

	@Transient
	RunMessageManager runMessageManager;

	@Transient
	RunMetricManager runMetricManager;

	@Transient
	Job job;

	/**
	 * Create a {@link RunMessageType#DEBUG} {@link RunMessage}.
	 * 
	 * @param message
	 *            The message to create.
	 */
	public void debug(final String message) {
		try {
			this.runMessageManager.create(this.job, getId(), message, null, RunMessageType.DEBUG, false);
		} catch (final DataOperationException e) {
			log.error(e.getMessage(), e);
		}
	}

	/**
	 * Create a {@link RunMessageType#ERROR} {@link RunMessage}.
	 * 
	 * @param throwable
	 *            The throwable to create the message from.
	 */
	public void error(final Throwable throwable) {
		try {
			this.runMessageManager.create(this.job, getId(), throwable.getMessage(), throwable, RunMessageType.ERROR, true);
		} catch (final DataOperationException e) {
			log.error(e.getMessage(), e);
		}
	}

	/**
	 * Create a {@link RunMetric}.
	 * 
	 * @param name
	 *            The name of the metric.
	 * @param value
	 *            The new value of the metric.
	 * @param external
	 *            Should this metric be published externally?
	 * 
	 */
	public void metric(final String name, final BigDecimal value, final boolean external) {
		try {
			this.runMetricManager.create(name, value, getId(), this.job, external);
		} catch (final DataOperationException e) {
			log.error(e.getMessage(), e);
		}
	}

}