ScheduledJobs.java

/*******************************************************************************
 * Copyright 2013 Michael Marconi
 * 
 * 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 oncue.scheduler;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import com.google.common.base.Predicate;
import com.google.common.collect.Iterables;

import oncue.backingstore.BackingStore;
import oncue.common.messages.Job;
import oncue.scheduler.exceptions.RemoveScheduleJobException;

/**
 * An encapsulated map of {@linkplain Job}s to the agents they have been scheduled against.
 */
public class ScheduledJobs {

	// A persistent backing store
	private BackingStore backingStore;

	// Map a list of scheduled jobs to logical agent address
	private Map<String, List<Job>> scheduledJobs = new HashMap<String, List<Job>>();

	/**
	 * @param backingStore is an instance of {@linkplain BackingStore}
	 */
	public ScheduledJobs(BackingStore backingStore) {
		this.backingStore = backingStore;
	}

	/**
	 * Assign a list of jobs to an agent
	 * 
	 * @param agent is the agent to which the jobs are being assigned
	 * @param jobs is the list of {@linkplain Job}s to assign to the agent
	 */
	public void addJobs(String agent, List<Job> jobs) {
		List<Job> assignedJobs = scheduledJobs.get(agent);
		if (assignedJobs == null) {
			assignedJobs = new ArrayList<Job>();
			scheduledJobs.put(agent, assignedJobs);
		}
		for (Job job : jobs) {
			assignedJobs.add((Job) job.clone());
		}
		backingStore.addScheduledJobs(jobs);
	}

	/**
	 * @return a list of scheduled jobs
	 */
	public List<Job> getJobs() {
		List<Job> jobs = new ArrayList<>();
		for (String agent : scheduledJobs.keySet()) {
			jobs.addAll(scheduledJobs.get(agent));
		}
		return jobs;

	}

	/**
	 * Get the list of jobs associated with this agent
	 * 
	 * @param agent is the agent the jobs are associated with
	 * @return a list of {@linkplain Job}s associated with the agent
	 */
	public List<Job> getJobs(String agent) {
		List<Job> jobs = scheduledJobs.get(agent);
		if (jobs == null)
			return new ArrayList<>();
		else
			return jobs;
	}

	/**
	 * Update the state and progress of a scheduled job, usually in response to work done on the
	 * job.
	 * 
	 * @param job contains the updates
	 * @param agent is where the work is being done
	 */
	public void updateJob(Job job, String agent) {
		List<Job> jobs = getJobs(agent);
		for (Job scheduledJob : jobs) {
			if (scheduledJob.getId() == job.getId()) {
				scheduledJob.setProgress(job.getProgress());
				scheduledJob.setState(job.getState());
			}
		}
	}

	/**
	 * Remove a job associated with an agent
	 * 
	 * @param jobId is the {@linkplain Job} ID to remove
	 * 
	 * @throws RemoveScheduleJobException
	 */
	public void removeJobById(final long jobId, String agent) throws RemoveScheduleJobException {

		if (!scheduledJobs.containsKey(agent))
			throw new RemoveScheduleJobException("There is no registered agent " + agent
					+ ".  It is possible the scheduler was restarted and this agent has not re-registered yet.");

		Iterables.removeIf(scheduledJobs.get(agent), new Predicate<Job>(){

			@Override
			public boolean apply(Job input) {
				return input.getId() == jobId;
			}
		});

		backingStore.removeScheduledJobById(jobId);
	}

	/**
	 * Get a list of all scheduled jobs for all agents.
	 */
	public List<Job> getScheduledJobs() {
		List<Job> response = new ArrayList<>();
		for(List<Job> jobs : scheduledJobs.values()) {
			response.addAll(jobs);
		}
		return response;
	}
}