com.enioka.jqm.tools.JobManagerHandler Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jqm-engine Show documentation
Show all versions of jqm-engine Show documentation
A library containing the JQM engine. Cannot be used alone.
/**
* Copyright © 2013 enioka. All rights reserved
*
* 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.enioka.jqm.tools;
import java.io.File;
import java.io.IOException;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.util.Calendar;
import java.util.Map;
import java.util.UUID;
import javax.naming.NamingException;
import javax.naming.spi.NamingManager;
import javax.sql.DataSource;
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.FilenameUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.enioka.jqm.api.JobRequest;
import com.enioka.jqm.api.JqmClient;
import com.enioka.jqm.api.JqmClientFactory;
import com.enioka.jqm.api.Query;
import com.enioka.jqm.jdbc.DbConn;
import com.enioka.jqm.jdbc.NoResultException;
import com.enioka.jqm.model.GlobalParameter;
import com.enioka.jqm.model.Instruction;
import com.enioka.jqm.model.JobInstance;
import com.enioka.jqm.model.Message;
import com.enioka.jqm.model.State;
/**
* This is the implementation behind the proxy described in the JobManager interface inside the jqm-api artifact.
*/
class JobManagerHandler implements InvocationHandler
{
private static Logger jqmlogger = LoggerFactory.getLogger(JobManagerHandler.class);
private JobInstance ji;
private Map params = null;
private Calendar lastPeek = null;
JobManagerHandler(JobInstance ji, Map prms)
{
this.ji = ji;
params = prms;
}
private JqmClient getJqmClient()
{
return JqmClientFactory.getClient();
}
@SuppressWarnings("unchecked")
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable
{
String methodName = method.getName();
Class[] classes = method.getParameterTypes();
jqmlogger.trace("An engine API method was called: " + methodName + " with nb arguments: " + classes.length);
handleInstructions();
if (classes.length == 0)
{
if ("jobApplicationId".equals(methodName))
{
return this.ji.getJdId();
}
else if ("parentID".equals(methodName))
{
return ji.getParentId();
}
else if ("jobInstanceID".equals(methodName))
{
return ji.getId();
}
else if ("canBeRestarted".equals(methodName))
{
return this.ji.getJD().isCanBeRestarted();
}
else if ("applicationName".equals(methodName))
{
return ji.getJD().getApplicationName();
}
else if ("sessionID".equals(methodName))
{
return ji.getSessionID();
}
else if ("application".equals(methodName))
{
return ji.getJD().getApplication();
}
else if ("module".equals(methodName))
{
return this.ji.getJD().getModule();
}
else if ("keyword1".equals(methodName))
{
return ji.getKeyword1();
}
else if ("keyword2".equals(methodName))
{
return ji.getKeyword2();
}
else if ("keyword3".equals(methodName))
{
return ji.getKeyword3();
}
else if ("definitionKeyword1".equals(methodName))
{
return this.ji.getJD().getKeyword1();
}
else if ("definitionKeyword2".equals(methodName))
{
return this.ji.getJD().getKeyword2();
}
else if ("definitionKeyword3".equals(methodName))
{
return this.ji.getJD().getKeyword3();
}
else if ("userName".equals(methodName))
{
return ji.getUserName();
}
else if ("parameters".equals(methodName))
{
return params;
}
else if ("defaultConnect".equals(methodName))
{
return this.getDefaultConnectionName();
}
else if ("getDefaultConnection".equals(methodName))
{
return this.getDefaultConnection();
}
else if ("getWorkDir".equals(methodName))
{
return getWorkDir();
}
else if ("yield".equals(methodName))
{
return null;
}
else if ("waitChildren".equals(methodName))
{
waitChildren();
return null;
}
}
else if ("sendMsg".equals(methodName) && classes.length == 1 && classes[0] == String.class)
{
sendMsg((String) args[0]);
return null;
}
else if ("sendProgress".equals(methodName) && classes.length == 1 && classes[0] == Integer.class)
{
sendProgress((Integer) args[0]);
return null;
}
else if ("enqueue".equals(methodName) && classes.length == 10 && classes[0] == String.class)
{
return enqueue((String) args[0], (String) args[1], (String) args[2], (String) args[3], (String) args[4], (String) args[5],
(String) args[6], (String) args[7], (String) args[8], (Map) args[9]);
}
else if ("enqueueSync".equals(methodName) && classes.length == 10 && classes[0] == String.class)
{
return enqueueSync((String) args[0], (String) args[1], (String) args[2], (String) args[3], (String) args[4], (String) args[5],
(String) args[6], (String) args[7], (String) args[8], (Map) args[9]);
}
else if ("addDeliverable".equals(methodName) && classes.length == 2 && classes[0] == String.class && classes[1] == String.class)
{
return addDeliverable((String) args[0], (String) args[1]);
}
else if ("waitChild".equals(methodName) && classes.length == 1 && (args[0] instanceof Integer))
{
waitChild((Integer) args[0]);
return null;
}
else if ("hasEnded".equals(methodName) && classes.length == 1 && (args[0] instanceof Integer))
{
return hasEnded((Integer) args[0]);
}
else if ("hasSucceeded".equals(methodName) && classes.length == 1 && (args[0] instanceof Integer))
{
return hasSucceeded((Integer) args[0]);
}
else if ("hasFailed".equals(methodName) && classes.length == 1 && (args[0] instanceof Integer))
{
return hasFailed((Integer) args[0]);
}
throw new NoSuchMethodException(methodName);
}
private void handleInstructions()
{
// Throttle: only peek once every 1 second.
if (lastPeek != null && Calendar.getInstance().getTimeInMillis() - lastPeek.getTimeInMillis() < 1000L)
{
return;
}
DbConn cnx = Helpers.getNewDbSession();
try
{
Instruction s = Instruction.valueOf(cnx.runSelectSingle("ji_select_instruction_by_id", String.class, ji.getId()));
jqmlogger.trace("Analysis: should JI " + ji.getId() + " get killed or paused? Current instruction is " + s);
if (s.equals(Instruction.KILL))
{
jqmlogger.info("Job will be killed at the request of a user");
Helpers.closeQuietly(cnx); // Close at once. Some DB drivers (Oracle...) will use the interruption state and reset.
Thread.currentThread().interrupt();
throw new JqmKillException("This job" + "(ID: " + ji.getId() + ")" + " has been forcefully ended by a user");
}
if (s.equals(Instruction.PAUSE))
{
jqmlogger.info("Job will be paused at the request of a user");
sendMsg("Pause is beginning");
while (s.equals(Instruction.PAUSE))
{
try
{
Thread.sleep(1000);
}
catch (InterruptedException e)
{
throw new RuntimeException("job thread was interrupted");
}
s = Instruction.valueOf(cnx.runSelectSingle("ji_select_instruction_by_id", String.class, ji.getId()));
}
jqmlogger.info("Job instance is resuming");
sendMsg("Job instance is resuming");
}
// TEMP: #319 workaround. Full implementation should be in the engine, not here.
int priority = cnx.runSelectSingle("ji_select_priority_by_id", Integer.class, ji.getId());
if (priority != 0)
{
if (Thread.currentThread().getPriority() != priority)
{
Thread.currentThread().setPriority(priority);
}
}
}
finally
{
Helpers.closeQuietly(cnx);
lastPeek = Calendar.getInstance();
}
}
/**
* Create a {@link com.enioka.jqm.model.Message} with the given message. The {@link com.enioka.jqm.model.History} to link to is deduced
* from the context.
*
* @param msg
* @throws JqmKillException
*/
private void sendMsg(String msg)
{
DbConn cnx = Helpers.getNewDbSession();
try
{
Message.create(cnx, msg, ji.getId());
cnx.commit();
}
finally
{
Helpers.closeQuietly(cnx);
}
}
/**
* Update the {@link com.enioka.jqm.model.History} with the given progress data.
*
* @param msg
* @throws JqmKillException
*/
private void sendProgress(Integer msg)
{
DbConn cnx = Helpers.getNewDbSession();
try
{
this.ji.setProgress(msg); // Not persisted, but useful to the Loader.
cnx.runUpdate("jj_update_progress_by_id", msg, ji.getId());
cnx.commit();
}
finally
{
Helpers.closeQuietly(cnx);
}
}
private Integer enqueue(String applicationName, String user, String mail, String sessionId, String application, String module,
String keyword1, String keyword2, String keyword3, Map parameters)
{
JobRequest jr = new JobRequest(applicationName, user, mail);
jr.setApplicationName(applicationName);
jr.setUser(user == null ? ji.getUserName() : user);
jr.setEmail(mail);
jr.setSessionID(sessionId == null ? this.ji.getSessionID() : sessionId);
jr.setApplication(application == null ? this.ji.getJD().getApplication() : application);
jr.setModule(module == null ? this.ji.getJD().getModule() : module);
jr.setKeyword1(keyword1);
jr.setKeyword2(keyword2);
jr.setKeyword3(keyword3);
jr.setParentID(this.ji.getId());
if (parameters != null)
{
jr.setParameters(parameters);
}
return getJqmClient().enqueue(jr);
}
private int enqueueSync(String applicationName, String user, String mail, String sessionId, String application, String module,
String keyword1, String keyword2, String keyword3, Map parameters)
{
int i = enqueue(applicationName, user, mail, sessionId, application, module, keyword1, keyword2, keyword3, parameters);
waitChild(i);
return i;
}
private void waitChild(int id)
{
JqmClient c = getJqmClient();
Query q = Query.create().setQueryHistoryInstances(false).setQueryLiveInstances(true).setJobInstanceId(id);
while (!c.getJobs(q).isEmpty())
{
try
{
Thread.sleep(1000);
handleInstructions();
}
catch (InterruptedException e)
{
Thread.currentThread().interrupt();
break;
}
}
}
private void waitChildren()
{
JqmClient c = getJqmClient();
Query q = Query.create().setQueryHistoryInstances(false).setQueryLiveInstances(true).setParentId(ji.getId());
while (!c.getJobs(q).isEmpty())
{
try
{
Thread.sleep(1000);
handleInstructions();
}
catch (InterruptedException e)
{
Thread.currentThread().interrupt();
break;
}
}
}
private Integer addDeliverable(String path, String fileLabel) throws IOException
{
DbConn cnx = Helpers.getNewDbSession();
try
{
String outputRoot = this.ji.getNode().getDlRepo();
String ext = FilenameUtils.getExtension(path);
String relDestPath = ji.getJD().getApplicationName() + "/" + ji.getId() + "/" + UUID.randomUUID() + "." + ext;
String absDestPath = FilenameUtils.concat(outputRoot, relDestPath);
String fileName = FilenameUtils.getName(path);
jqmlogger.debug("A deliverable is added. Stored as " + absDestPath + ". Initial name: " + fileName);
FileUtils.moveFile(new File(path), new File(absDestPath));
cnx.commit();
int res = Helpers.createDeliverable(relDestPath, fileName, fileLabel, this.ji.getId(), cnx);
cnx.commit();
return res;
}
finally
{
Helpers.closeQuietly(cnx);
}
}
private File getWorkDir()
{
File f = new File(FilenameUtils.concat(ji.getNode().getTmpDirectory(), Integer.toString(this.ji.getId())));
if (!f.isDirectory())
{
try
{
FileUtils.forceMkdir(f);
}
catch (Exception e)
{
throw new JqmRuntimeException("Could not create work directory", e);
}
}
return f;
}
private String getDefaultConnectionName()
{
DbConn cnx = Helpers.getNewDbSession();
try
{
return GlobalParameter.getParameter(cnx, "defaultConnection", null);
}
finally
{
Helpers.closeQuietly(cnx);
}
}
private DataSource getDefaultConnection() throws NamingException
{
Object dso = NamingManager.getInitialContext(null).lookup(getDefaultConnectionName());
return (DataSource) dso;
}
private boolean hasEnded(int jobId)
{
DbConn cnx = Helpers.getNewDbSession();
try
{
cnx.runSelectSingle("ji_select_instruction_by_id", String.class, jobId);
return false;
}
catch (NoResultException e)
{
return true;
}
finally
{
Helpers.closeQuietly(cnx);
}
}
private Boolean hasSucceeded(int requestId)
{
DbConn cnx = Helpers.getNewDbSession();
try
{
State s = State.valueOf(cnx.runSelectSingle("history_select_state_by_id", String.class, requestId));
return s.equals(State.ENDED);
}
catch (NoResultException e)
{
return null;
}
finally
{
Helpers.closeQuietly(cnx);
}
}
private Boolean hasFailed(int requestId)
{
Boolean b = hasSucceeded(requestId);
if (b == null)
{
return b;
}
else
{
return !b;
}
}
}