<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_265) on Tue Aug 25 19:30:52 UTC 2020 -->
<title>SchedulerService (MetaCat API)</title>
<meta name="date" content="2020-08-25">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SchedulerService (MetaCat API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SchedulerService.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../edu/ucsb/nceas/metacat/scheduler/ScheduledJobParamDAO.html" title="class in edu.ucsb.nceas.metacat.scheduler"><span class="typeNameLink">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?edu/ucsb/nceas/metacat/scheduler/SchedulerService.html" target="_top">Frames</a></li>
<li><a href="SchedulerService.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#fields.inherited.from.class.edu.ucsb.nceas.metacat.shared.BaseService">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">edu.ucsb.nceas.metacat.scheduler</div>
<h2 title="Class SchedulerService" class="title">Class SchedulerService</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../edu/ucsb/nceas/metacat/shared/BaseService.html" title="class in edu.ucsb.nceas.metacat.shared">edu.ucsb.nceas.metacat.shared.BaseService</a></li>
<li>
<ul class="inheritance">
<li>edu.ucsb.nceas.metacat.scheduler.SchedulerService</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">SchedulerService</span>
extends <a href="../../../../../edu/ucsb/nceas/metacat/shared/BaseService.html" title="class in edu.ucsb.nceas.metacat.shared">BaseService</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.edu.ucsb.nceas.metacat.shared.BaseService">
<!-- -->
</a>
<h3>Fields inherited from class edu.ucsb.nceas.metacat.shared.<a href="../../../../../edu/ucsb/nceas/metacat/shared/BaseService.html" title="class in edu.ucsb.nceas.metacat.shared">BaseService</a></h3>
<code><a href="../../../../../edu/ucsb/nceas/metacat/shared/BaseService.html#Z:Z_serviceName">_serviceName</a></code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/scheduler/SchedulerService.html#deleteJob-edu.ucsb.nceas.metacat.scheduler.ScheduledJobDAO-">deleteJob</a></span>(<a href="../../../../../edu/ucsb/nceas/metacat/scheduler/ScheduledJobDAO.html" title="class in edu.ucsb.nceas.metacat.scheduler">ScheduledJobDAO</a> jobDAO)</code>
<div class="block">Remove the job from the scheduler and set the job status to deleted in the database</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/scheduler/SchedulerService.html#deleteJob-java.lang.String-">deleteJob</a></span>(java.lang.String jobName)</code>
<div class="block">Remove the job from the scheduler and set the job status to deleted in the database</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/scheduler/SchedulerService.html#doRefresh--">doRefresh</a></span>()</code> </td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../edu/ucsb/nceas/metacat/scheduler/SchedulerService.html" title="class in edu.ucsb.nceas.metacat.scheduler">SchedulerService</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/scheduler/SchedulerService.html#getInstance--">getInstance</a></span>()</code>
<div class="block">Get the single instance of SchedulerService.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/scheduler/SchedulerService.html#getJobInfoXML-java.lang.Long-">getJobInfoXML</a></span>(java.lang.Long jobId)</code>
<div class="block">Get information about the job in XML format</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/scheduler/SchedulerService.html#getJobsInfoXML-java.lang.String-java.lang.String-java.lang.String-">getJobsInfoXML</a></span>(java.lang.String groupName,
java.lang.String paramName,
java.lang.String paramValue)</code>
<div class="block">Get the information for jobs in a group in an xml format.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/scheduler/SchedulerService.html#getJobsInfoXML-java.lang.String-java.lang.String-java.lang.String-java.io.PrintWriter-">getJobsInfoXML</a></span>(java.lang.String groupName,
java.lang.String paramName,
java.lang.String paramValue,
java.io.PrintWriter pw)</code>
<div class="block">Get the information for jobs in a group in an xml format.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.util.Calendar</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/scheduler/SchedulerService.html#getStartDateFromDelay-java.lang.String-">getStartDateFromDelay</a></span>(java.lang.String delay)</code>
<div class="block">Extract the start date from the delay value</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>protected java.util.Vector<java.lang.String></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/scheduler/SchedulerService.html#getStatus--">getStatus</a></span>()</code> </td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/scheduler/SchedulerService.html#jobToXML-edu.ucsb.nceas.metacat.scheduler.ScheduledJobDAO-">jobToXML</a></span>(<a href="../../../../../edu/ucsb/nceas/metacat/scheduler/ScheduledJobDAO.html" title="class in edu.ucsb.nceas.metacat.scheduler">ScheduledJobDAO</a> scheduledJobDAO)</code>
<div class="block">Convert a single job to XML</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/scheduler/SchedulerService.html#refreshable--">refreshable</a></span>()</code> </td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/scheduler/SchedulerService.html#rescheduleJob-edu.ucsb.nceas.metacat.scheduler.ScheduledJobDAO-java.lang.String-java.lang.String:A-">rescheduleJob</a></span>(<a href="../../../../../edu/ucsb/nceas/metacat/scheduler/ScheduledJobDAO.html" title="class in edu.ucsb.nceas.metacat.scheduler">ScheduledJobDAO</a> jobDAO,
java.lang.String username,
java.lang.String[] groups)</code>
<div class="block">Reschedule a job.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/scheduler/SchedulerService.html#rescheduleJob-edu.ucsb.nceas.metacat.scheduler.ScheduledJobDAO-java.lang.String-java.lang.String:A-boolean-">rescheduleJob</a></span>(<a href="../../../../../edu/ucsb/nceas/metacat/scheduler/ScheduledJobDAO.html" title="class in edu.ucsb.nceas.metacat.scheduler">ScheduledJobDAO</a> jobDAO,
java.lang.String username,
java.lang.String[] groups,
boolean checkStatus)</code>
<div class="block">Reschedule a job.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/scheduler/SchedulerService.html#scheduleDelayedJob-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.util.HashMap-java.lang.String-java.lang.String:A-">scheduleDelayedJob</a></span>(java.lang.String jobName,
java.lang.String delay,
java.lang.String jobClassName,
java.lang.String jobGroup,
java.util.HashMap<java.lang.String,java.lang.String> jobParams,
java.lang.String username,
java.lang.String[] groups)</code>
<div class="block">schedule a job one time with a given delay.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/scheduler/SchedulerService.html#scheduleJob-edu.ucsb.nceas.metacat.scheduler.ScheduledJobDAO-java.lang.String-java.lang.String:A-">scheduleJob</a></span>(<a href="../../../../../edu/ucsb/nceas/metacat/scheduler/ScheduledJobDAO.html" title="class in edu.ucsb.nceas.metacat.scheduler">ScheduledJobDAO</a> jobDAO,
java.lang.String username,
java.lang.String[] groups)</code>
<div class="block">Schedule a job</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/scheduler/SchedulerService.html#scheduleJob-java.lang.String-java.util.Calendar-java.util.Calendar-int-java.lang.String-java.lang.String-java.lang.String-java.util.HashMap-">scheduleJob</a></span>(java.lang.String jobName,
java.util.Calendar startCal,
java.util.Calendar endCal,
int intervalValue,
java.lang.String intervalUnit,
java.lang.String jobClassName,
java.lang.String jobGroup,
java.util.HashMap<java.lang.String,java.lang.String> jobParams)</code>
<div class="block">schedule a job</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/scheduler/SchedulerService.html#start--">start</a></span>()</code> </td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/scheduler/SchedulerService.html#stop--">stop</a></span>()</code> </td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/scheduler/SchedulerService.html#unscheduleJob-java.lang.String-java.lang.String-java.lang.String:A-">unscheduleJob</a></span>(java.lang.String jobName,
java.lang.String username,
java.lang.String[] groups)</code>
<div class="block">Unschedule a job.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.edu.ucsb.nceas.metacat.shared.BaseService">
<!-- -->
</a>
<h3>Methods inherited from class edu.ucsb.nceas.metacat.shared.<a href="../../../../../edu/ucsb/nceas/metacat/shared/BaseService.html" title="class in edu.ucsb.nceas.metacat.shared">BaseService</a></h3>
<code><a href="../../../../../edu/ucsb/nceas/metacat/shared/BaseService.html#refresh--">refresh</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getInstance--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstance</h4>
<pre>public static <a href="../../../../../edu/ucsb/nceas/metacat/scheduler/SchedulerService.html" title="class in edu.ucsb.nceas.metacat.scheduler">SchedulerService</a> getInstance()
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></pre>
<div class="block">Get the single instance of SchedulerService.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the single instance of SchedulerService</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></code></dd>
</dl>
</li>
</ul>
<a name="refreshable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>refreshable</h4>
<pre>public boolean refreshable()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/BaseService.html#refreshable--">refreshable</a></code> in class <code><a href="../../../../../edu/ucsb/nceas/metacat/shared/BaseService.html" title="class in edu.ucsb.nceas.metacat.shared">BaseService</a></code></dd>
</dl>
</li>
</ul>
<a name="doRefresh--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doRefresh</h4>
<pre>public void doRefresh()
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/BaseService.html#doRefresh--">doRefresh</a></code> in class <code><a href="../../../../../edu/ucsb/nceas/metacat/shared/BaseService.html" title="class in edu.ucsb.nceas.metacat.shared">BaseService</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></code></dd>
</dl>
</li>
</ul>
<a name="start--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>public void start()
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></code></dd>
</dl>
</li>
</ul>
<a name="stop--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre>public void stop()
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/BaseService.html#stop--">stop</a></code> in class <code><a href="../../../../../edu/ucsb/nceas/metacat/shared/BaseService.html" title="class in edu.ucsb.nceas.metacat.shared">BaseService</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></code></dd>
</dl>
</li>
</ul>
<a name="getStatus--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStatus</h4>
<pre>protected java.util.Vector<java.lang.String> getStatus()
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></code></dd>
</dl>
</li>
</ul>
<a name="scheduleJob-edu.ucsb.nceas.metacat.scheduler.ScheduledJobDAO-java.lang.String-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scheduleJob</h4>
<pre>public java.lang.String scheduleJob(<a href="../../../../../edu/ucsb/nceas/metacat/scheduler/ScheduledJobDAO.html" title="class in edu.ucsb.nceas.metacat.scheduler">ScheduledJobDAO</a> jobDAO,
java.lang.String username,
java.lang.String[] groups)
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></pre>
<div class="block">Schedule a job</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jobDAO</code> - the job data object to schedule</dd>
<dd><code>username</code> - the user that we will use to schedule</dd>
<dd><code>groups</code> - the user group that we will use to schedule</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a message saying that the job was scheduled</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></code></dd>
</dl>
</li>
</ul>
<a name="scheduleJob-java.lang.String-java.util.Calendar-java.util.Calendar-int-java.lang.String-java.lang.String-java.lang.String-java.util.HashMap-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scheduleJob</h4>
<pre>public java.lang.String scheduleJob(java.lang.String jobName,
java.util.Calendar startCal,
java.util.Calendar endCal,
int intervalValue,
java.lang.String intervalUnit,
java.lang.String jobClassName,
java.lang.String jobGroup,
java.util.HashMap<java.lang.String,java.lang.String> jobParams)
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></pre>
<div class="block">schedule a job</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jobName</code> - the name of the job</dd>
<dd><code>startCal</code> - a calendar holding the start date of the job</dd>
<dd><code>endCal</code> - a calendar holding the end date of the job</dd>
<dd><code>intervalValue</code> - the run interval for the job</dd>
<dd><code>intervalUnit</code> - the unit of the run interval for the job</dd>
<dd><code>jobClassName</code> - the job class name</dd>
<dd><code>jobGroup</code> - the job group name</dd>
<dd><code>jobParams</code> - a map of additional job parameters</dd>
<dd><code>username</code> - the user name</dd>
<dd><code>groups</code> - the user's group name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a message saying that the job was scheduled</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></code></dd>
</dl>
</li>
</ul>
<a name="scheduleDelayedJob-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.util.HashMap-java.lang.String-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scheduleDelayedJob</h4>
<pre>public java.lang.String scheduleDelayedJob(java.lang.String jobName,
java.lang.String delay,
java.lang.String jobClassName,
java.lang.String jobGroup,
java.util.HashMap<java.lang.String,java.lang.String> jobParams,
java.lang.String username,
java.lang.String[] groups)
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></pre>
<div class="block">schedule a job one time with a given delay. The job is registered in the
scheduler, but not persisted to the database. The delay is calculated
from the time that this method is called.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jobName</code> - the name of the job</dd>
<dd><code>delay</code> - the delay in seconds, minutes, hours or days from the time
this method is called (i.e. 30s, 5m, 2h, 1d)</dd>
<dd><code>jobClassName</code> - the job class name</dd>
<dd><code>jobGroup</code> - the job group name</dd>
<dd><code>jobParams</code> - a map of additional job parameters</dd>
<dd><code>username</code> - the user name</dd>
<dd><code>groups</code> - the user's group name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a message saying that the job was scheduled</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></code></dd>
</dl>
</li>
</ul>
<a name="unscheduleJob-java.lang.String-java.lang.String-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unscheduleJob</h4>
<pre>public java.lang.String unscheduleJob(java.lang.String jobName,
java.lang.String username,
java.lang.String[] groups)
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></pre>
<div class="block">Unschedule a job. This removed it from the scheduler in memory and
changed it's status to unscheduled in the database.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jobName</code> - the name of the job to unschedule</dd>
<dd><code>username</code> - the user name</dd>
<dd><code>groups</code> - the user's group name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a message saying the job was unscheduled</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></code></dd>
</dl>
</li>
</ul>
<a name="rescheduleJob-edu.ucsb.nceas.metacat.scheduler.ScheduledJobDAO-java.lang.String-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rescheduleJob</h4>
<pre>public java.lang.String rescheduleJob(<a href="../../../../../edu/ucsb/nceas/metacat/scheduler/ScheduledJobDAO.html" title="class in edu.ucsb.nceas.metacat.scheduler">ScheduledJobDAO</a> jobDAO,
java.lang.String username,
java.lang.String[] groups)
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></pre>
<div class="block">Reschedule a job. This call will always check to make sure the status is not SCHEDULED</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jobDAO</code> - the job data object holding the information about the job to reschedule</dd>
<dd><code>username</code> - the user name</dd>
<dd><code>groups</code> - the user's group name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a message saying that the job was rescheduled</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></code></dd>
</dl>
</li>
</ul>
<a name="rescheduleJob-edu.ucsb.nceas.metacat.scheduler.ScheduledJobDAO-java.lang.String-java.lang.String:A-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rescheduleJob</h4>
<pre>public java.lang.String rescheduleJob(<a href="../../../../../edu/ucsb/nceas/metacat/scheduler/ScheduledJobDAO.html" title="class in edu.ucsb.nceas.metacat.scheduler">ScheduledJobDAO</a> jobDAO,
java.lang.String username,
java.lang.String[] groups,
boolean checkStatus)
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></pre>
<div class="block">Reschedule a job.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jobDAO</code> - the job data object holding the information about the job to
reschedule</dd>
<dd><code>username</code> - the user name</dd>
<dd><code>groups</code> - the user's group name</dd>
<dd><code>checkStatus</code> - if set to true, the method will check to make sure the status
is UNSCHEDULED before restarting. Otherwise, the method will
not check. This is so that we can restart a service at startup
that was running when metacat was shut down.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a message saying that the job was rescheduled</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></code></dd>
</dl>
</li>
</ul>
<a name="deleteJob-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteJob</h4>
<pre>public java.lang.String deleteJob(java.lang.String jobName)
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></pre>
<div class="block">Remove the job from the scheduler and set the job status to deleted in the database</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jobName</code> - the string holding the name of the job to delete</dd>
<dd><code>username</code> - the user name</dd>
<dd><code>groups</code> - the user's group name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a message saying that the job was deleted</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></code></dd>
</dl>
</li>
</ul>
<a name="deleteJob-edu.ucsb.nceas.metacat.scheduler.ScheduledJobDAO-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteJob</h4>
<pre>public java.lang.String deleteJob(<a href="../../../../../edu/ucsb/nceas/metacat/scheduler/ScheduledJobDAO.html" title="class in edu.ucsb.nceas.metacat.scheduler">ScheduledJobDAO</a> jobDAO)
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></pre>
<div class="block">Remove the job from the scheduler and set the job status to deleted in the database</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jobDAO</code> - the job data object holding the information about the job to delete</dd>
<dd><code>username</code> - the user name</dd>
<dd><code>groups</code> - the user's group name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a message saying that the job was deleted</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></code></dd>
</dl>
</li>
</ul>
<a name="getJobInfoXML-java.lang.Long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJobInfoXML</h4>
<pre>public java.lang.String getJobInfoXML(java.lang.Long jobId)
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></pre>
<div class="block">Get information about the job in XML format</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jobId</code> - the job for which we want the information</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an XML representation of the job</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></code></dd>
</dl>
</li>
</ul>
<a name="getJobsInfoXML-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJobsInfoXML</h4>
<pre>public java.lang.String getJobsInfoXML(java.lang.String groupName,
java.lang.String paramName,
java.lang.String paramValue)
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></pre>
<div class="block">Get the information for jobs in a group in an xml format. A parameter
key/value pair can be provided as well to limit the jobs returned.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>groupName</code> - the job group that we are searching for</dd>
<dd><code>paramName</code> - the parameter name that we are looking for. this is ignored if
null</dd>
<dd><code>paramValue</code> - the parameter value that we are looking for. this is ignored
if null</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an XML representation of the jobs.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></code></dd>
</dl>
</li>
</ul>
<a name="getJobsInfoXML-java.lang.String-java.lang.String-java.lang.String-java.io.PrintWriter-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJobsInfoXML</h4>
<pre>public void getJobsInfoXML(java.lang.String groupName,
java.lang.String paramName,
java.lang.String paramValue,
java.io.PrintWriter pw)
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></pre>
<div class="block">Get the information for jobs in a group in an xml format. A parameter
key/value pair can be provided as well to limit the jobs returned.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>groupName</code> - the job group that we are searching for</dd>
<dd><code>paramName</code> - the parameter name that we are looking for. this is ignored if
null</dd>
<dd><code>paramValue</code> - the parameter value that we are looking for. this is ignored
if null</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></code></dd>
</dl>
</li>
</ul>
<a name="jobToXML-edu.ucsb.nceas.metacat.scheduler.ScheduledJobDAO-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>jobToXML</h4>
<pre>public java.lang.String jobToXML(<a href="../../../../../edu/ucsb/nceas/metacat/scheduler/ScheduledJobDAO.html" title="class in edu.ucsb.nceas.metacat.scheduler">ScheduledJobDAO</a> scheduledJobDAO)
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></pre>
<div class="block">Convert a single job to XML</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>scheduledJobDAO</code> - the job we want to convert</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an XML representation of the job</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></code></dd>
</dl>
</li>
</ul>
<a name="getStartDateFromDelay-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getStartDateFromDelay</h4>
<pre>public java.util.Calendar getStartDateFromDelay(java.lang.String delay)
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></pre>
<div class="block">Extract the start date from the delay value</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>delay</code> - a string representing the start delay in <value><unit>
notation where value is an integer and unit is one of s,m,h or
d</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the calendar object holding the start date</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SchedulerService.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../edu/ucsb/nceas/metacat/scheduler/ScheduledJobParamDAO.html" title="class in edu.ucsb.nceas.metacat.scheduler"><span class="typeNameLink">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?edu/ucsb/nceas/metacat/scheduler/SchedulerService.html" target="_top">Frames</a></li>
<li><a href="SchedulerService.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#fields.inherited.from.class.edu.ucsb.nceas.metacat.shared.BaseService">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><i>Copyright © 2020 Regents of the University of California. All Rights Reserved.</i></small></p>
</body>
</html>