Spring/spring-batch
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Files
dd679050ee467b7f9fdd347893e23dcaff070335
spring-batch/build/api/org/springframework/batch/test/JobLauncherTestUtils.html
Michael Minella 75ab909314 update
2017-03-23 10:18:33 -05:00

635 lines
31 KiB
HTML
Raw Blame History

<!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_31) on Thu Mar 23 09:54:32 CDT 2017 -->
<title>JobLauncherTestUtils (null 4.0.0.BUILD-SNAPSHOT API)</title>
<meta name="date" content="2017-03-23">
<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="JobLauncherTestUtils (null 4.0.0.BUILD-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10};
var tabs = {65535:["t0","All 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="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="../../../../org/springframework/batch/test/ExecutionContextTestUtils.html" title="class in org.springframework.batch.test"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/springframework/batch/test/JobRepositoryTestUtils.html" title="class in org.springframework.batch.test"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/springframework/batch/test/JobLauncherTestUtils.html" target="_top">Frames</a></li>
<li><a href="JobLauncherTestUtils.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">org.springframework.batch.test</div>
<h2 title="Class JobLauncherTestUtils" class="title">Class JobLauncherTestUtils</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.springframework.batch.test.JobLauncherTestUtils</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">JobLauncherTestUtils</span>
extends java.lang.Object</pre>
<div class="block"><p>
Utility class for testing batch jobs. It provides methods for launching an
entire <a href="../../../../org/springframework/batch/core/job/AbstractJob.html" title="class in org.springframework.batch.core.job"><code>AbstractJob</code></a>, allowing for end to end testing of individual
steps, without having to run every step in the job. Any test classes using
this utility can set up an instance in the <code>ApplicationContext</code> as part
of the Spring test framework.
</p>
<p>
This class also provides the ability to run <a href="../../../../org/springframework/batch/core/Step.html" title="interface in org.springframework.batch.core"><code>Step</code></a>s from a
<a href="../../../../org/springframework/batch/core/job/flow/FlowJob.html" title="class in org.springframework.batch.core.job.flow"><code>FlowJob</code></a> or <a href="../../../../org/springframework/batch/core/job/SimpleJob.html" title="class in org.springframework.batch.core.job"><code>SimpleJob</code></a> individually. By launching <a href="../../../../org/springframework/batch/core/Step.html" title="interface in org.springframework.batch.core"><code>Step</code></a>s
within a <a href="../../../../org/springframework/batch/core/Job.html" title="interface in org.springframework.batch.core"><code>Job</code></a> on their own, end to end testing of individual steps can
be performed without having to run every step in the job.
</p>
<p>
It should be noted that using any of the methods that don't contain
<a href="../../../../org/springframework/batch/core/JobParameters.html" title="class in org.springframework.batch.core"><code>JobParameters</code></a> in their signature, will result in one being created
with the current system time as a parameter. This will ensure restartability
when no parameters are provided.
</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.1</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Lucas Ward, Dan Garrette, Dave Syer</dd>
</dl>
</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>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected org.apache.commons.logging.Log</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/springframework/batch/test/JobLauncherTestUtils.html#logger">logger</a></span></code>
<div class="block">Logger</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/springframework/batch/test/JobLauncherTestUtils.html#JobLauncherTestUtils--">JobLauncherTestUtils</a></span>()</code>&nbsp;</td>
</tr>
</table>
</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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><a href="../../../../org/springframework/batch/core/Job.html" title="interface in org.springframework.batch.core">Job</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/springframework/batch/test/JobLauncherTestUtils.html#getJob--">getJob</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/springframework/batch/core/launch/JobLauncher.html" title="interface in org.springframework.batch.core.launch">JobLauncher</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/springframework/batch/test/JobLauncherTestUtils.html#getJobLauncher--">getJobLauncher</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../org/springframework/batch/core/repository/JobRepository.html" title="interface in org.springframework.batch.core.repository">JobRepository</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/springframework/batch/test/JobLauncherTestUtils.html#getJobRepository--">getJobRepository</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/springframework/batch/test/StepRunner.html" title="class in org.springframework.batch.test">StepRunner</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/springframework/batch/test/JobLauncherTestUtils.html#getStepRunner--">getStepRunner</a></span>()</code>
<div class="block">Convenient method for subclasses to grab a <a href="../../../../org/springframework/batch/test/StepRunner.html" title="class in org.springframework.batch.test"><code>StepRunner</code></a> for running
steps by name.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../org/springframework/batch/core/JobParameters.html" title="class in org.springframework.batch.core">JobParameters</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/springframework/batch/test/JobLauncherTestUtils.html#getUniqueJobParameters--">getUniqueJobParameters</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/springframework/batch/core/JobExecution.html" title="class in org.springframework.batch.core">JobExecution</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/springframework/batch/test/JobLauncherTestUtils.html#launchJob--">launchJob</a></span>()</code>
<div class="block">Launch the entire job, including all steps.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../org/springframework/batch/core/JobExecution.html" title="class in org.springframework.batch.core">JobExecution</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/springframework/batch/test/JobLauncherTestUtils.html#launchJob-org.springframework.batch.core.JobParameters-">launchJob</a></span>(<a href="../../../../org/springframework/batch/core/JobParameters.html" title="class in org.springframework.batch.core">JobParameters</a>&nbsp;jobParameters)</code>
<div class="block">Launch the entire job, including all steps</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/springframework/batch/core/JobExecution.html" title="class in org.springframework.batch.core">JobExecution</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/springframework/batch/test/JobLauncherTestUtils.html#launchStep-java.lang.String-">launchStep</a></span>(java.lang.String&nbsp;stepName)</code>
<div class="block">Launch just the specified step in the job.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../org/springframework/batch/core/JobExecution.html" title="class in org.springframework.batch.core">JobExecution</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/springframework/batch/test/JobLauncherTestUtils.html#launchStep-java.lang.String-org.springframework.batch.item.ExecutionContext-">launchStep</a></span>(java.lang.String&nbsp;stepName,
<a href="../../../../org/springframework/batch/item/ExecutionContext.html" title="class in org.springframework.batch.item">ExecutionContext</a>&nbsp;jobExecutionContext)</code>
<div class="block">Launch just the specified step in the job.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/springframework/batch/core/JobExecution.html" title="class in org.springframework.batch.core">JobExecution</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/springframework/batch/test/JobLauncherTestUtils.html#launchStep-java.lang.String-org.springframework.batch.core.JobParameters-">launchStep</a></span>(java.lang.String&nbsp;stepName,
<a href="../../../../org/springframework/batch/core/JobParameters.html" title="class in org.springframework.batch.core">JobParameters</a>&nbsp;jobParameters)</code>
<div class="block">Launch just the specified step in the job.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../org/springframework/batch/core/JobExecution.html" title="class in org.springframework.batch.core">JobExecution</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/springframework/batch/test/JobLauncherTestUtils.html#launchStep-java.lang.String-org.springframework.batch.core.JobParameters-org.springframework.batch.item.ExecutionContext-">launchStep</a></span>(java.lang.String&nbsp;stepName,
<a href="../../../../org/springframework/batch/core/JobParameters.html" title="class in org.springframework.batch.core">JobParameters</a>&nbsp;jobParameters,
<a href="../../../../org/springframework/batch/item/ExecutionContext.html" title="class in org.springframework.batch.item">ExecutionContext</a>&nbsp;jobExecutionContext)</code>
<div class="block">Launch just the specified step in the job.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/springframework/batch/test/JobLauncherTestUtils.html#setJob-org.springframework.batch.core.Job-">setJob</a></span>(<a href="../../../../org/springframework/batch/core/Job.html" title="interface in org.springframework.batch.core">Job</a>&nbsp;job)</code>
<div class="block">The Job instance that can be manipulated (e.g.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/springframework/batch/test/JobLauncherTestUtils.html#setJobLauncher-org.springframework.batch.core.launch.JobLauncher-">setJobLauncher</a></span>(<a href="../../../../org/springframework/batch/core/launch/JobLauncher.html" title="interface in org.springframework.batch.core.launch">JobLauncher</a>&nbsp;jobLauncher)</code>
<div class="block">A <a href="../../../../org/springframework/batch/core/launch/JobLauncher.html" title="interface in org.springframework.batch.core.launch"><code>JobLauncher</code></a> instance that can be used to launch jobs.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/springframework/batch/test/JobLauncherTestUtils.html#setJobRepository-org.springframework.batch.core.repository.JobRepository-">setJobRepository</a></span>(<a href="../../../../org/springframework/batch/core/repository/JobRepository.html" title="interface in org.springframework.batch.core.repository">JobRepository</a>&nbsp;jobRepository)</code>
<div class="block">The <a href="../../../../org/springframework/batch/core/repository/JobRepository.html" title="interface in org.springframework.batch.core.repository"><code>JobRepository</code></a> to use for creating new <a href="../../../../org/springframework/batch/core/JobExecution.html" title="class in org.springframework.batch.core"><code>JobExecution</code></a>
instances.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="logger">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>logger</h4>
<pre>protected final&nbsp;org.apache.commons.logging.Log logger</pre>
<div class="block">Logger</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="JobLauncherTestUtils--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JobLauncherTestUtils</h4>
<pre>public&nbsp;JobLauncherTestUtils()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setJob-org.springframework.batch.core.Job-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setJob</h4>
<pre>@Autowired
public&nbsp;void&nbsp;setJob(<a href="../../../../org/springframework/batch/core/Job.html" title="interface in org.springframework.batch.core">Job</a>&nbsp;job)</pre>
<div class="block">The Job instance that can be manipulated (e.g. launched) in this utility.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>job</code> - the <a href="../../../../org/springframework/batch/core/job/AbstractJob.html" title="class in org.springframework.batch.core.job"><code>AbstractJob</code></a> to use</dd>
</dl>
</li>
</ul>
<a name="setJobRepository-org.springframework.batch.core.repository.JobRepository-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setJobRepository</h4>
<pre>@Autowired
public&nbsp;void&nbsp;setJobRepository(<a href="../../../../org/springframework/batch/core/repository/JobRepository.html" title="interface in org.springframework.batch.core.repository">JobRepository</a>&nbsp;jobRepository)</pre>
<div class="block">The <a href="../../../../org/springframework/batch/core/repository/JobRepository.html" title="interface in org.springframework.batch.core.repository"><code>JobRepository</code></a> to use for creating new <a href="../../../../org/springframework/batch/core/JobExecution.html" title="class in org.springframework.batch.core"><code>JobExecution</code></a>
instances.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jobRepository</code> - a <a href="../../../../org/springframework/batch/core/repository/JobRepository.html" title="interface in org.springframework.batch.core.repository"><code>JobRepository</code></a></dd>
</dl>
</li>
</ul>
<a name="getJobRepository--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJobRepository</h4>
<pre>public&nbsp;<a href="../../../../org/springframework/batch/core/repository/JobRepository.html" title="interface in org.springframework.batch.core.repository">JobRepository</a>&nbsp;getJobRepository()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the job repository</dd>
</dl>
</li>
</ul>
<a name="getJob--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJob</h4>
<pre>public&nbsp;<a href="../../../../org/springframework/batch/core/Job.html" title="interface in org.springframework.batch.core">Job</a>&nbsp;getJob()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the job</dd>
</dl>
</li>
</ul>
<a name="setJobLauncher-org.springframework.batch.core.launch.JobLauncher-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setJobLauncher</h4>
<pre>@Autowired
public&nbsp;void&nbsp;setJobLauncher(<a href="../../../../org/springframework/batch/core/launch/JobLauncher.html" title="interface in org.springframework.batch.core.launch">JobLauncher</a>&nbsp;jobLauncher)</pre>
<div class="block">A <a href="../../../../org/springframework/batch/core/launch/JobLauncher.html" title="interface in org.springframework.batch.core.launch"><code>JobLauncher</code></a> instance that can be used to launch jobs.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jobLauncher</code> - a job launcher</dd>
</dl>
</li>
</ul>
<a name="getJobLauncher--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJobLauncher</h4>
<pre>public&nbsp;<a href="../../../../org/springframework/batch/core/launch/JobLauncher.html" title="interface in org.springframework.batch.core.launch">JobLauncher</a>&nbsp;getJobLauncher()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the job launcher</dd>
</dl>
</li>
</ul>
<a name="launchJob--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>launchJob</h4>
<pre>public&nbsp;<a href="../../../../org/springframework/batch/core/JobExecution.html" title="class in org.springframework.batch.core">JobExecution</a>&nbsp;launchJob()
throws java.lang.Exception</pre>
<div class="block">Launch the entire job, including all steps.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>JobExecution, so that the test can validate the exit status</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="launchJob-org.springframework.batch.core.JobParameters-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>launchJob</h4>
<pre>public&nbsp;<a href="../../../../org/springframework/batch/core/JobExecution.html" title="class in org.springframework.batch.core">JobExecution</a>&nbsp;launchJob(<a href="../../../../org/springframework/batch/core/JobParameters.html" title="class in org.springframework.batch.core">JobParameters</a>&nbsp;jobParameters)
throws java.lang.Exception</pre>
<div class="block">Launch the entire job, including all steps</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jobParameters</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>JobExecution, so that the test can validate the exit status</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="getUniqueJobParameters--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUniqueJobParameters</h4>
<pre>public&nbsp;<a href="../../../../org/springframework/batch/core/JobParameters.html" title="class in org.springframework.batch.core">JobParameters</a>&nbsp;getUniqueJobParameters()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new JobParameters object containing only a parameter for the
current timestamp, to ensure that the job instance will be unique.</dd>
</dl>
</li>
</ul>
<a name="getStepRunner--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStepRunner</h4>
<pre>protected&nbsp;<a href="../../../../org/springframework/batch/test/StepRunner.html" title="class in org.springframework.batch.test">StepRunner</a>&nbsp;getStepRunner()</pre>
<div class="block">Convenient method for subclasses to grab a <a href="../../../../org/springframework/batch/test/StepRunner.html" title="class in org.springframework.batch.test"><code>StepRunner</code></a> for running
steps by name.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../../../org/springframework/batch/test/StepRunner.html" title="class in org.springframework.batch.test"><code>StepRunner</code></a></dd>
</dl>
</li>
</ul>
<a name="launchStep-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>launchStep</h4>
<pre>public&nbsp;<a href="../../../../org/springframework/batch/core/JobExecution.html" title="class in org.springframework.batch.core">JobExecution</a>&nbsp;launchStep(java.lang.String&nbsp;stepName)</pre>
<div class="block">Launch just the specified step in the job. A unique set of JobParameters
will automatically be generated. An IllegalStateException is thrown if
there is no Step with the given name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stepName</code> - The name of the step to launch</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>JobExecution</dd>
</dl>
</li>
</ul>
<a name="launchStep-java.lang.String-org.springframework.batch.item.ExecutionContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>launchStep</h4>
<pre>public&nbsp;<a href="../../../../org/springframework/batch/core/JobExecution.html" title="class in org.springframework.batch.core">JobExecution</a>&nbsp;launchStep(java.lang.String&nbsp;stepName,
<a href="../../../../org/springframework/batch/item/ExecutionContext.html" title="class in org.springframework.batch.item">ExecutionContext</a>&nbsp;jobExecutionContext)</pre>
<div class="block">Launch just the specified step in the job. A unique set of JobParameters
will automatically be generated. An IllegalStateException is thrown if
there is no Step with the given name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stepName</code> - The name of the step to launch</dd>
<dd><code>jobExecutionContext</code> - An ExecutionContext whose values will be
loaded into the Job ExecutionContext prior to launching the step.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>JobExecution</dd>
</dl>
</li>
</ul>
<a name="launchStep-java.lang.String-org.springframework.batch.core.JobParameters-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>launchStep</h4>
<pre>public&nbsp;<a href="../../../../org/springframework/batch/core/JobExecution.html" title="class in org.springframework.batch.core">JobExecution</a>&nbsp;launchStep(java.lang.String&nbsp;stepName,
<a href="../../../../org/springframework/batch/core/JobParameters.html" title="class in org.springframework.batch.core">JobParameters</a>&nbsp;jobParameters)</pre>
<div class="block">Launch just the specified step in the job. An IllegalStateException is
thrown if there is no Step with the given name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stepName</code> - The name of the step to launch</dd>
<dd><code>jobParameters</code> - The JobParameters to use during the launch</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>JobExecution</dd>
</dl>
</li>
</ul>
<a name="launchStep-java.lang.String-org.springframework.batch.core.JobParameters-org.springframework.batch.item.ExecutionContext-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>launchStep</h4>
<pre>public&nbsp;<a href="../../../../org/springframework/batch/core/JobExecution.html" title="class in org.springframework.batch.core">JobExecution</a>&nbsp;launchStep(java.lang.String&nbsp;stepName,
<a href="../../../../org/springframework/batch/core/JobParameters.html" title="class in org.springframework.batch.core">JobParameters</a>&nbsp;jobParameters,
<a href="../../../../org/springframework/batch/item/ExecutionContext.html" title="class in org.springframework.batch.item">ExecutionContext</a>&nbsp;jobExecutionContext)</pre>
<div class="block">Launch just the specified step in the job. An IllegalStateException is
thrown if there is no Step with the given name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stepName</code> - The name of the step to launch</dd>
<dd><code>jobParameters</code> - The JobParameters to use during the launch</dd>
<dd><code>jobExecutionContext</code> - An ExecutionContext whose values will be
loaded into the Job ExecutionContext prior to launching the step.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>JobExecution</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="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="../../../../org/springframework/batch/test/ExecutionContextTestUtils.html" title="class in org.springframework.batch.test"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/springframework/batch/test/JobRepositoryTestUtils.html" title="class in org.springframework.batch.test"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/springframework/batch/test/JobLauncherTestUtils.html" target="_top">Frames</a></li>
<li><a href="JobLauncherTestUtils.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink