Class BackupJobFactory

java.lang.Object
com.inet.taskplanner.server.api.common.AbstractFactory<COMPONENT,DEFINITION,INFO,SUMMARY>
com.inet.taskplanner.server.api.common.SeriesDependentFactory<T,com.inet.taskplanner.server.api.job.JobDefinition,com.inet.taskplanner.server.api.job.JobInfo,com.inet.taskplanner.server.api.job.JobSummaryInfo>
com.inet.taskplanner.server.api.job.JobFactory<com.inet.maintenance.server.taskplanner.BackupJob>
com.inet.maintenance.server.taskplanner.BackupJobFactory
All Implemented Interfaces:
com.inet.plugin.NamedExtension

public class BackupJobFactory extends com.inet.taskplanner.server.api.job.JobFactory<com.inet.maintenance.server.taskplanner.BackupJob>
A task planner job that executes a backup.
Since:
taskplanner 3.0
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    The id of the backup job that should be executed

    Fields inherited from class com.inet.taskplanner.server.api.common.SeriesDependentFactory

    PLACEHOLDER_END_CHARACTER, PLACEHOLDER_START_CHARACTER
  • Constructor Summary

    Constructors
    Constructor
    Description
    Creates the factory that defines the task planner job.
  • Method Summary

    Modifier and Type
    Method
    Description
    protected com.inet.maintenance.server.taskplanner.BackupJob
    createInstanceFrom(@Nonnull com.inet.taskplanner.server.api.job.JobDefinition definition, @Nullable com.inet.id.GUID taskID)
    protected static com.inet.maintenance.api.backup.BackupDefinition[]
    Returns the current backup definitions, stored in the configuration
    com.inet.taskplanner.server.api.job.JobInfo
    getInformation(@Nullable com.inet.id.GUID taskID)
    List<com.inet.taskplanner.server.api.result.ResultFlavor>
    getResultFlavors(com.inet.taskplanner.server.api.job.JobDefinition definition)
    com.inet.taskplanner.server.api.job.JobSummaryInfo
    getSummary(@Nonnull com.inet.taskplanner.server.api.job.JobDefinition definition)
    boolean
    void
    validate(@Nonnull com.inet.taskplanner.server.api.job.JobDefinition jobDefinition, @Nullable com.inet.id.GUID taskID)
    void
    validateCondition(@Nonnull com.inet.taskplanner.server.api.job.JobDefinition definition)

    Methods inherited from class com.inet.taskplanner.server.api.job.JobFactory

    patchDefinitionProperties, validateCondition

    Methods inherited from class com.inet.taskplanner.server.api.common.SeriesDependentFactory

    createFrom, getFirstValueFromSeries, updateValues, updateValues, validate

    Methods inherited from class com.inet.taskplanner.server.api.common.AbstractFactory

    checkDefinitionArgument, createInstanceFrom, getExtensionName

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • PROPERTY_BACKUP_JOB_ID

      public static final String PROPERTY_BACKUP_JOB_ID
      The id of the backup job that should be executed
      See Also:
  • Constructor Details

    • BackupJobFactory

      public BackupJobFactory()
      Creates the factory that defines the task planner job.
      Since:
      taskplanner 3.0
  • Method Details

    • getInformation

      public com.inet.taskplanner.server.api.job.JobInfo getInformation(@Nullable @Nullable com.inet.id.GUID taskID)
      Specified by:
      getInformation in class com.inet.taskplanner.server.api.common.AbstractFactory<com.inet.maintenance.server.taskplanner.BackupJob,com.inet.taskplanner.server.api.job.JobDefinition,com.inet.taskplanner.server.api.job.JobInfo,com.inet.taskplanner.server.api.job.JobSummaryInfo>
    • getBackupDefinitions

      protected static com.inet.maintenance.api.backup.BackupDefinition[] getBackupDefinitions()
      Returns the current backup definitions, stored in the configuration
      Returns:
      the current backup definitions
      Since:
      taskplanner 3.0
    • validate

      public void validate(@Nonnull @Nonnull com.inet.taskplanner.server.api.job.JobDefinition jobDefinition, @Nullable @Nullable com.inet.id.GUID taskID) throws com.inet.taskplanner.server.api.error.ValidationException
      Specified by:
      validate in class com.inet.taskplanner.server.api.common.AbstractFactory<com.inet.maintenance.server.taskplanner.BackupJob,com.inet.taskplanner.server.api.job.JobDefinition,com.inet.taskplanner.server.api.job.JobInfo,com.inet.taskplanner.server.api.job.JobSummaryInfo>
      Throws:
      com.inet.taskplanner.server.api.error.ValidationException
    • validateCondition

      public void validateCondition(@Nonnull @Nonnull com.inet.taskplanner.server.api.job.JobDefinition definition) throws com.inet.taskplanner.server.api.error.ValidationException
      Specified by:
      validateCondition in class com.inet.taskplanner.server.api.job.JobFactory<com.inet.maintenance.server.taskplanner.BackupJob>
      Throws:
      com.inet.taskplanner.server.api.error.ValidationException
    • createInstanceFrom

      protected com.inet.maintenance.server.taskplanner.BackupJob createInstanceFrom(@Nonnull @Nonnull com.inet.taskplanner.server.api.job.JobDefinition definition, @Nullable @Nullable com.inet.id.GUID taskID)
      Overrides:
      createInstanceFrom in class com.inet.taskplanner.server.api.common.AbstractFactory<com.inet.maintenance.server.taskplanner.BackupJob,com.inet.taskplanner.server.api.job.JobDefinition,com.inet.taskplanner.server.api.job.JobInfo,com.inet.taskplanner.server.api.job.JobSummaryInfo>
    • getSummary

      public com.inet.taskplanner.server.api.job.JobSummaryInfo getSummary(@Nonnull @Nonnull com.inet.taskplanner.server.api.job.JobDefinition definition)
      Specified by:
      getSummary in class com.inet.taskplanner.server.api.common.AbstractFactory<com.inet.maintenance.server.taskplanner.BackupJob,com.inet.taskplanner.server.api.job.JobDefinition,com.inet.taskplanner.server.api.job.JobInfo,com.inet.taskplanner.server.api.job.JobSummaryInfo>
    • getResultFlavors

      public List<com.inet.taskplanner.server.api.result.ResultFlavor> getResultFlavors(com.inet.taskplanner.server.api.job.JobDefinition definition)
      Specified by:
      getResultFlavors in class com.inet.taskplanner.server.api.job.JobFactory<com.inet.maintenance.server.taskplanner.BackupJob>
    • isAvailable

      public boolean isAvailable()
      Overrides:
      isAvailable in class com.inet.taskplanner.server.api.common.AbstractFactory<com.inet.maintenance.server.taskplanner.BackupJob,com.inet.taskplanner.server.api.job.JobDefinition,com.inet.taskplanner.server.api.job.JobInfo,com.inet.taskplanner.server.api.job.JobSummaryInfo>