org.springframework.xd.rest.client.impl

Class JobTemplate

java.lang.Object

org.springframework.xd.rest.client.impl.JobTemplate

All Implemented Interfaces:

JobOperations, ResourceOperations

public class JobTemplate
extends java.lang.Object
implements JobOperations

Implementation of the Job-related part of the API.

Author:

Glenn Renfro, Ilayaperumal Gopinathan, Gunnar Hillert, Eric Bottard, Paul Harris, Gary Russell

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,org.springframework.hateoas.UriTemplate>	resources Holds discovered URLs of the API.
protected org.springframework.web.client.RestTemplate	restTemplate A template used for http interaction.

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanBusResources(java.lang.String name) Remove any bus resources that cannot be automatically removed during undeploy.
JobDefinitionResource	createJob(java.lang.String name, java.lang.String definition, boolean deploy) Create a new Job, optionally deploying it.
void	deploy(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> properties) Deploy an already created resource.
void	destroy(java.lang.String name) Destroy an existing resource.
void	destroyAll() Undeploy all the resources known to the system.
JobExecutionInfoResource	displayJobExecution(long jobExecutionId) Retrieve a specific Job Execution for the provided jobExecutionId.
JobInstanceInfoResource	displayJobInstance(long instanceId) Retrieve a specific instance of a job, given its intanceId.
StepExecutionInfoResource	displayStepExecution(long jobExecutionId, long stepExecutionId) Retrieve a specific StepExecutionInfoResource for the provided jobExecutionId and stepExecutionId.
void	launchJob(java.lang.String name, java.lang.String jobParameters) Launch a job that is already deployed.
JobDefinitionResource.Page	list() List jobs known to the system.
JobExecutionInfoResource.Page	listJobExecutions() List all Job Executions.
java.util.List<StepExecutionInfoResource>	listStepExecutions(long jobExecutionId) Retrieve a List of StepExecutionInfoResources for the provided jobExecutionId.
void	restartJobExecution(long executionId) Restart a given job execution.
StepExecutionProgressInfoResource	stepExecutionProgress(long jobExecutionId, long stepExecutionId) Retrieve step execution progress with the given jobExecutionId and stepExecutionId.
void	stopAllJobExecutions() Stop all job executions.
void	stopJobExecution(long executionId) Stop job execution that is running.
java.lang.String	toString()
void	undeploy(java.lang.String name) Undeploy a deployed resource, retaining its definition.
void	undeployAll() Undeploy all the resources known to the system.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.xd.rest.client.ResourceOperations

cleanBusResources, deploy, destroy, destroyAll, undeploy, undeployAll

Field Detail

restTemplate

protected org.springframework.web.client.RestTemplate restTemplate

A template used for http interaction.

resources

protected java.util.Map<java.lang.String,org.springframework.hateoas.UriTemplate> resources

Holds discovered URLs of the API.

Method Detail

createJob

public JobDefinitionResource createJob(java.lang.String name,
                              java.lang.String definition,
                              boolean deploy)

Description copied from interface: JobOperations

Create a new Job, optionally deploying it.

Specified by:

createJob in interface JobOperations

launchJob

public void launchJob(java.lang.String name,
             java.lang.String jobParameters)

Description copied from interface: JobOperations

Launch a job that is already deployed.

Specified by:

launchJob in interface JobOperations

Parameters:

name - the name of the job to launch

jobParameters - the JSON string as jobParameters

stopAllJobExecutions

public void stopAllJobExecutions()

Description copied from interface: JobOperations

Stop all job executions.

Specified by:

stopAllJobExecutions in interface JobOperations

stopJobExecution

public void stopJobExecution(long executionId)

Description copied from interface: JobOperations

Stop job execution that is running.

Specified by:

stopJobExecution in interface JobOperations

restartJobExecution

public void restartJobExecution(long executionId)

Description copied from interface: JobOperations

Restart a given job execution.

Specified by:

restartJobExecution in interface JobOperations

list

public JobDefinitionResource.Page list()

Description copied from interface: JobOperations

List jobs known to the system.

Specified by:

list in interface JobOperations

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

listJobExecutions

public JobExecutionInfoResource.Page listJobExecutions()

Description copied from interface: JobOperations

List all Job Executions.

Specified by:

listJobExecutions in interface JobOperations

displayJobExecution

public JobExecutionInfoResource displayJobExecution(long jobExecutionId)

Description copied from interface: JobOperations

Retrieve a specific Job Execution for the provided jobExecutionId.

Specified by:

displayJobExecution in interface JobOperations

listStepExecutions

public java.util.List<StepExecutionInfoResource> listStepExecutions(long jobExecutionId)

Description copied from interface: JobOperations

Retrieve a List of StepExecutionInfoResources for the provided jobExecutionId.

Specified by:

listStepExecutions in interface JobOperations

stepExecutionProgress

public StepExecutionProgressInfoResource stepExecutionProgress(long jobExecutionId,
                                                      long stepExecutionId)

Description copied from interface: JobOperations

Retrieve step execution progress with the given jobExecutionId and stepExecutionId.

Specified by:

stepExecutionProgress in interface JobOperations

displayStepExecution

public StepExecutionInfoResource displayStepExecution(long jobExecutionId,
                                             long stepExecutionId)

Description copied from interface: JobOperations

Retrieve a specific StepExecutionInfoResource for the provided jobExecutionId and stepExecutionId.

Specified by:

displayStepExecution in interface JobOperations

displayJobInstance

public JobInstanceInfoResource displayJobInstance(long instanceId)

Description copied from interface: JobOperations

Retrieve a specific instance of a job, given its intanceId.

Specified by:

displayJobInstance in interface JobOperations

destroy

public void destroy(java.lang.String name)

Description copied from interface: ResourceOperations

Destroy an existing resource.

Specified by:

destroy in interface ResourceOperations

deploy

public void deploy(java.lang.String name,
          java.util.Map<java.lang.String,java.lang.String> properties)

Description copied from interface: ResourceOperations

Deploy an already created resource.

Specified by:

deploy in interface ResourceOperations

undeploy

public void undeploy(java.lang.String name)

Description copied from interface: ResourceOperations

Undeploy a deployed resource, retaining its definition.

Specified by:

undeploy in interface ResourceOperations

undeployAll

public void undeployAll()

Description copied from interface: ResourceOperations

Undeploy all the resources known to the system.

Specified by:

undeployAll in interface ResourceOperations

destroyAll

public void destroyAll()

Description copied from interface: ResourceOperations

Undeploy all the resources known to the system.

Specified by:

destroyAll in interface ResourceOperations

cleanBusResources

public void cleanBusResources(java.lang.String name)

Description copied from interface: ResourceOperations

Remove any bus resources that cannot be automatically removed during undeploy.

Specified by:

cleanBusResources in interface ResourceOperations