Package com.adobe.granite.maintenance

Class MaintenanceConstants

java.lang.Object
com.adobe.granite.maintenance.MaintenanceConstants
public abstract class MaintenanceConstants extends Object
This class defines some constants for registering maintenance tasks.

  • Field Details

    • PROPERTY_TASK_NAME

      public static final String PROPERTY_TASK_NAME
      The unique name of a maintenance task. This property is required.
      See Also:

    • PROPERTY_TASK_TITLE

      public static final String PROPERTY_TASK_TITLE
      The title for a maintenance task. This property is required.
      See Also:

    • PROPERTY_TASK_SCHEDULE

      public static final String PROPERTY_TASK_SCHEDULE
      The schedule of a maintenance task. This property is optional, allowed values are SCHEDULE_DAILY, SCHEDULE_WEEKLY, SCHEDULE_MONTHLY
      See Also:

    • PROPERTY_TASK_STOPPABLE

      public static final String PROPERTY_TASK_STOPPABLE
      Boolean property to define whether a task is stoppable. Optional default value false.
      See Also:

    • PROPERTY_TASK_CONSERVATIVE

      public static final String PROPERTY_TASK_CONSERVATIVE
      Boolean property to define whether a task is conservative. Optional default value true.
      See Also:

    • PROPERTY_TASK_THROTTLING

      public static final String PROPERTY_TASK_THROTTLING
      Boolean property to define whether a task supports throttling. Optional default value false.
      See Also:

    • PROPERTY_TASK_MANDATORY

      public static final String PROPERTY_TASK_MANDATORY
      Boolean property to define whether a task is mandatory. Optional default value false.
      Since:
      1.1
      See Also:

    • SCHEDULE_DAILY

      public static final String SCHEDULE_DAILY
      See Also:

    • SCHEDULE_WEEKLY

      public static final String SCHEDULE_WEEKLY
      See Also:

    • SCHEDULE_BIWEEKLY

      @Deprecated public static final String SCHEDULE_BIWEEKLY
      Deprecated.
      See Also:

    • SCHEDULE_MONTHLY

      public static final String SCHEDULE_MONTHLY
      See Also:

    • TASK_TOPIC_PREFIX

      public static final String TASK_TOPIC_PREFIX
      See Also:

    • PROPERTY_WINDOW_TITLE

      public static final String PROPERTY_WINDOW_TITLE
      See Also:

    • PROPERTY_WINDOW_START_TIME

      public static final String PROPERTY_WINDOW_START_TIME
      Human readable form of the start time in 24h format, like 2:30 or 14:15.
      See Also:

    • PROPERTY_WINDOW_END_TIME

      public static final String PROPERTY_WINDOW_END_TIME
      Human readable form of the end time in 24h format, like 2:35 or 14:30.
      See Also:

    • PROPERTY_WINDOW_SCHEDULE

      public static final String PROPERTY_WINDOW_SCHEDULE
      Schedule of the window, this is either SCHEDULE_DAILY, SCHEDULE_WEEKLY or SCHEDULE_MONTHLY
      See Also:

    • PROPERTY_WINDOW_SCHEDULE_WEEKDAYS

      public static final String PROPERTY_WINDOW_SCHEDULE_WEEKDAYS
      Schedule of the window, this is an array of integer values ranging from 1 = Sunday to 7 = Saturday.
      See Also:

    • PROPERTY_WINDOW_SCHEDULE_FIRST_LAST_DAY

      public static final String PROPERTY_WINDOW_SCHEDULE_FIRST_LAST_DAY
      Schedule of the window, this is integer with value 0 for the first day of the month of the given type and 1 for the last one. This is used for monthly scheduling, in conjunction with PROPERTY_WINDOW_SCHEDULE_WEEKDAYS, to allow period selection in the form of: "The first Monday of the month / the last Friday of the month"
      See Also:

    • PROPERTY_TASK_RANKING

      public static final String PROPERTY_TASK_RANKING
      Relative ranking for task inside a window. Tasks with higher values will be executed before lower value tasks inside the window.
      See Also:

  • Constructor Details

    • MaintenanceConstants

      public MaintenanceConstants()