Low level interface for inspecting and controlling jobs with access only to primitive and collection types. Suitable for a command-line client (e.g. that launches a new process for each operation), or a remote launcher. More...
Public Member Functions | |
| IList< long?> | GetExecutions (long instanceId) |
| Lists the JobExecutions associated with a particular JobInstance, in reverse order of creation (and therefore usually of execution). More... | |
| IList< long?> | GetJobInstances (string jobName, int start, int count) |
| Lists the JobInstances for a given job name, in reverse order of creation (and therefore usually of first execution). More... | |
| ICollection< long?> | GetRunningExecutions (string jobName) |
| Gets the id values of all the running JobExecutions with the given job name. More... | |
| string | GetParameters (long executionId) |
| Gets the JobParameters as an easily readable String. More... | |
| long | Start (string jobName, string parameters) |
| Starts a new instance of a job with the parameters specified. More... | |
| long | Restart (long executionId) |
| Restarts a failed or stopped JobExecution; Fails with an exception if the id provided does not exist or corresponds to a JobInstance that in normal circumstances already completed successfully. More... | |
| long | StartNextInstance (string jobName) |
| Launches the next in a sequence of JobInstance determined by the IJobParametersIncrementer attached to the specified job. If the previous instance is still in a failed state, this method should still create a new instance and run it with different parameters (as long as the IJobParametersIncrementer is working) More... | |
| bool | Stop (long executionId) |
| Sends a stop signal to the JobExecution with the supplied id. The signal is successfully sent if this method returns true, but that doesn't mean that the job has stopped. The only way to be sure of that is to poll the job execution status. More... | |
| string | GetSummary (long executionId) |
| Summarises the JobExecution with the supplied id, giving details of status, start and end times etc. More... | |
| IDictionary< long?, string > | GetStepExecutionSummaries (long executionId) |
| Summarises the StepExecution instances belonging to the JobExecution with the supplied id, giving details of status, start and end times etc. More... | |
| ISet< string > | GetJobNames () |
| List the available job names that can be launched with Start. More... | |
| JobExecution | Abandon (long jobExecutionId) |
| Mark the JobExecution as ABANDONED. If a stop signal is ignored because the process died this is the best way to mark a job as finished with (as opposed to STOPPED). An abandoned job execution can be restarted, but a stopping one cannot. More... | |
Detailed Description
Low level interface for inspecting and controlling jobs with access only to primitive and collection types. Suitable for a command-line client (e.g. that launches a new process for each operation), or a remote launcher.
Member Function Documentation
| JobExecution Summer.Batch.Core.Launch.IJobOperator.Abandon | ( | long | jobExecutionId | ) |
Mark the JobExecution as ABANDONED. If a stop signal is ignored because the process died this is the best way to mark a job as finished with (as opposed to STOPPED). An abandoned job execution can be restarted, but a stopping one cannot.
- Parameters
-
jobExecutionId
- Returns
- Exceptions
-
Summer.Batch.Core.Launch.NoSuchJobExecutionException Summer.Batch.Core.Repository.JobExecutionAlreadyRunningException
Implemented in Summer.Batch.Core.Launch.Support.SimpleJobOperator.
| IList<long?> Summer.Batch.Core.Launch.IJobOperator.GetExecutions | ( | long | instanceId | ) |
Lists the JobExecutions associated with a particular JobInstance, in reverse order of creation (and therefore usually of execution).
- Parameters
-
instanceId the id of a JobInstance
- Returns
- the id values of all the JobExecutions associated with this instance
- Exceptions
-
NoSuchJobInstanceException
Implemented in Summer.Batch.Core.Launch.Support.SimpleJobOperator.
| IList<long?> Summer.Batch.Core.Launch.IJobOperator.GetJobInstances | ( | string | jobName, |
| int | start, | ||
| int | count | ||
| ) |
Lists the JobInstances for a given job name, in reverse order of creation (and therefore usually of first execution).
- Parameters
-
jobName start count
- Returns
- Exceptions
-
Summer.Batch.Core.Launch.NoSuchJobException
Implemented in Summer.Batch.Core.Launch.Support.SimpleJobOperator.
| ISet<string> Summer.Batch.Core.Launch.IJobOperator.GetJobNames | ( | ) |
List the available job names that can be launched with Start.
- Returns
Implemented in Summer.Batch.Core.Launch.Support.SimpleJobOperator.
| string Summer.Batch.Core.Launch.IJobOperator.GetParameters | ( | long | executionId | ) |
Gets the JobParameters as an easily readable String.
- Parameters
-
executionId
- Returns
Implemented in Summer.Batch.Core.Launch.Support.SimpleJobOperator.
| ICollection<long?> Summer.Batch.Core.Launch.IJobOperator.GetRunningExecutions | ( | string | jobName | ) |
Gets the id values of all the running JobExecutions with the given job name.
- Parameters
-
jobName
- Returns
- Exceptions
-
Summer.Batch.Core.Launch.NoSuchJobException
Implemented in Summer.Batch.Core.Launch.Support.SimpleJobOperator.
| IDictionary<long?, string> Summer.Batch.Core.Launch.IJobOperator.GetStepExecutionSummaries | ( | long | executionId | ) |
Summarises the StepExecution instances belonging to the JobExecution with the supplied id, giving details of status, start and end times etc.
- Parameters
-
executionId
- Returns
Implemented in Summer.Batch.Core.Launch.Support.SimpleJobOperator.
| string Summer.Batch.Core.Launch.IJobOperator.GetSummary | ( | long | executionId | ) |
Summarises the JobExecution with the supplied id, giving details of status, start and end times etc.
- Parameters
-
executionId
- Returns
Implemented in Summer.Batch.Core.Launch.Support.SimpleJobOperator.
| long Summer.Batch.Core.Launch.IJobOperator.Restart | ( | long | executionId | ) |
Restarts a failed or stopped JobExecution; Fails with an exception if the id provided does not exist or corresponds to a JobInstance that in normal circumstances already completed successfully.
- Parameters
-
executionId
- Returns
- Exceptions
Implemented in Summer.Batch.Core.Launch.Support.SimpleJobOperator.
| long Summer.Batch.Core.Launch.IJobOperator.Start | ( | string | jobName, |
| string | parameters | ||
| ) |
Starts a new instance of a job with the parameters specified.
- Parameters
-
jobName parameters
- Returns
- Exceptions
-
Summer.Batch.Core.Launch.NoSuchJobException if there is no Job with the specified name Summer.Batch.Core.Launch.JobInstanceAlreadyExistsException if a job instance with this name and parameters already exists Summer.Batch.Core.JobParametersInvalidException
Implemented in Summer.Batch.Core.Launch.Support.SimpleJobOperator.
| long Summer.Batch.Core.Launch.IJobOperator.StartNextInstance | ( | string | jobName | ) |
Launches the next in a sequence of JobInstance determined by the IJobParametersIncrementer attached to the specified job. If the previous instance is still in a failed state, this method should still create a new instance and run it with different parameters (as long as the IJobParametersIncrementer is working)
- Parameters
-
jobName
- Returns
- Exceptions
Implemented in Summer.Batch.Core.Launch.Support.SimpleJobOperator.
| bool Summer.Batch.Core.Launch.IJobOperator.Stop | ( | long | executionId | ) |
Sends a stop signal to the JobExecution with the supplied id. The signal is successfully sent if this method returns true, but that doesn't mean that the job has stopped. The only way to be sure of that is to poll the job execution status.
- Parameters
-
executionId
- Returns
- Exceptions
-
Summer.Batch.Core.Launch.NoSuchJobExecutionException Summer.Batch.Core.Launch.JobExecutionNotRunningException
Implemented in Summer.Batch.Core.Launch.Support.SimpleJobOperator.
The documentation for this interface was generated from the following file:
- Summer.Batch.Core/Core/Launch/IJobOperator.cs