Interface StepRegistry

All Known Implementing Classes:
MapStepRegistry
@Deprecated(since="6.0", forRemoval=true) public interface StepRegistry
Deprecated, for removal: This API element is subject to removal in a future version.
as of 6.0 with no replacement. Scheduled for removal in 6.2.
Registry keeping track of all the Step instances defined in a Job.
Author:
Sebastien Gerard, Stephane Nicoll

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable Step
    getStep(String jobName, String stepName)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the Step of the specified job based on its name.
    void
    register(String jobName, Collection<Step> steps)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Registers all the step instances of the given job.
    void
    unregisterStepsFromJob(String jobName)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Unregisters all the steps instances of the given job.

  • Method Details

    • register

      void register(String jobName, Collection<Step> steps) throws DuplicateJobException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Registers all the step instances of the given job. If the job is already registered, the method unregisterStepsFromJob(String) is called before registering the given steps.
      Parameters:
      jobName - the give job name
      steps - the job steps
      Throws:
      DuplicateJobException - if a job with the same job name has already been registered.

    • unregisterStepsFromJob

      void unregisterStepsFromJob(String jobName)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Unregisters all the steps instances of the given job. If the job is not registered, nothing happens.
      Parameters:
      jobName - the given job name

    • getStep

      @Nullable Step getStep(String jobName, String stepName)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the Step of the specified job based on its name.
      Parameters:
      jobName - the name of the job
      stepName - the name of the step to retrieve
      Returns:
      the step with the given name belonging to the mentioned job or null if the job or the step do not exist