org.springframework.xd.integration.util

Class JobUtils

java.lang.Object

org.springframework.xd.integration.util.JobUtils

public class JobUtils
extends java.lang.Object

Utilities for managing jobs.

Author:

Glenn Renfro, David Turanski

Constructor Summary

Constructors

Constructor and Description
JobUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static void	destroyAllJobs(java.net.URL adminServer) Removes all the jobs from the cluster.
static boolean	isJobDeployed(java.lang.String jobName, java.net.URL adminServer) Checks to see if the specified job is deployed on the XD cluster.
static void	job(java.lang.String jobName, java.lang.String jobDefinition, java.net.URL adminServer) Creates the job definition and deploys it to the cluster being tested.
static void	launch(java.net.URL adminServer, java.lang.String jobName) Launches the specified job
static void	launch(java.net.URL adminServer, java.lang.String jobName, java.lang.String jobParameters) Launches the specified job
static void	undeployJob(java.net.URL adminServer, java.lang.String jobName) Undeploys the specified job
static boolean	waitForJobDeployment(java.lang.String jobName, java.net.URL adminServer, int waitTime) Waits up to the wait time for a job to be deployed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JobUtils

public JobUtils()

Method Detail

job

public static void job(java.lang.String jobName,
       java.lang.String jobDefinition,
       java.net.URL adminServer)

Creates the job definition and deploys it to the cluster being tested.

Parameters:

jobName - The name of the job

jobDefinition - The definition that needs to be deployed for this job.

adminServer - The admin server that this job will be deployed against.

destroyAllJobs

public static void destroyAllJobs(java.net.URL adminServer)

Removes all the jobs from the cluster. Used to guarantee a clean acceptance test.

Parameters:

adminServer - The admin server that the command will be executed against.

undeployJob

public static void undeployJob(java.net.URL adminServer,
               java.lang.String jobName)

Undeploys the specified job

Parameters:

adminServer - The admin server that the command will be executed against.

jobName - The name of the job to undeploy

launch

public static void launch(java.net.URL adminServer,
          java.lang.String jobName)

Launches the specified job

Parameters:

adminServer - The admin server that the command will be executed against.

jobName - The name of the job to launch

launch

public static void launch(java.net.URL adminServer,
          java.lang.String jobName,
          java.lang.String jobParameters)

Launches the specified job

Parameters:

adminServer - The admin server that the command will be executed against.

jobName - The name of the job to launch

jobParameters - the jobParameters

waitForJobDeployment

public static boolean waitForJobDeployment(java.lang.String jobName,
                           java.net.URL adminServer,
                           int waitTime)

Waits up to the wait time for a job to be deployed.

Parameters:

jobName - The name of the job to be evaluated.

adminServer - The admin server URL that will be queried.

waitTime - the amount of time in millis to wait.

Returns:

true if the job is deployed else false.

isJobDeployed

public static boolean isJobDeployed(java.lang.String jobName,
                    java.net.URL adminServer)

Checks to see if the specified job is deployed on the XD cluster.

Parameters:

jobName - The name of the job to be evaluated.

adminServer - The admin server URL that will be queried.

Returns:

true if the job is deployed else false