Class CheckpointSpecifier

java.lang.Object
com.sun.grid.jsv.CheckpointSpecifier
All Implemented Interfaces:
Serializable, Cloneable

public final class CheckpointSpecifier extends Object implements Cloneable, Serializable
The CheckpointSpecifier class represents the checkpointing environment settings for a job, including the name of the checkpoint environment to use and the frequency with which checkpoints should be taken.
Since:
6.2u5
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    String indicating that checkpoints should never be taken.
    static final byte
    Code indicating that checkpoints should be taken periodically at the minimum CPU interval as specified by the queue.
    static final String
    String indicating that checkpoints should be taken periodically at the minimum CPU interval as specified by the queue.
    static final byte
    Code indicating that checkpoints should be taken when the execd shuts down
    static final String
    Value indicating that checkpoints should be taken when the execd shuts down
    static final byte
    Code indicating that checkpoints should be taken the job is suspended.
    static final String
    String indicating that checkpoints should be taken the job is suspended.
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
     
    boolean
     
    long
    Get the number of seconds between checkpoints.
    Get the name of the checkpointing environment.
    byte
    Get a byte value that represents the occasions when the job should be checkpointed.
    Get an occasion string that represents the occasions when the job should be checkpointed.
    int
     
    byte
    Indicate that a checkpoint should never be taken.
    boolean
    onMinCpuInterval(boolean set)
    Set whether a checkpoint should be taken periodically at the minimum CPU interval as specified by the queue.
    boolean
    onShutdown(boolean set)
    Set whether a checkpoint should be taken when the execution daemon shuts down.
    boolean
    onSuspend(boolean set)
    Set whether a checkpoint should be taken when the job is suspended.
    long
    setInterval(int hours, int minutes, int seconds)
    Set the interval at which checkpoints should be taken.
    long
    setInterval(long sec)
    Set the interval at which checkpoints should be taken.
    void
    Set the name of the checkpointing environment.
    void
    Set the occasions when the job should be checkpointed according to a a String composed by combining the string values for the occasions when the job should be checkpointed.
     

    Methods inherited from class java.lang.Object

    finalize, getClass, notify, notifyAll, wait, wait, wait
  • Field Details

    • NEVER_STR

      public static final String NEVER_STR
      String indicating that checkpoints should never be taken.
      See Also:
    • ON_SHUTDOWN

      public static final byte ON_SHUTDOWN
      Code indicating that checkpoints should be taken when the execd shuts down
      See Also:
    • ON_SHUTDOWN_STR

      public static final String ON_SHUTDOWN_STR
      Value indicating that checkpoints should be taken when the execd shuts down
      See Also:
    • ON_MIN_CPU_INTERVAL

      public static final byte ON_MIN_CPU_INTERVAL
      Code indicating that checkpoints should be taken periodically at the minimum CPU interval as specified by the queue.
      See Also:
    • ON_MIN_CPU_INTERVAL_STR

      public static final String ON_MIN_CPU_INTERVAL_STR
      String indicating that checkpoints should be taken periodically at the minimum CPU interval as specified by the queue.
      See Also:
    • ON_SUSPEND

      public static final byte ON_SUSPEND
      Code indicating that checkpoints should be taken the job is suspended.
      See Also:
    • ON_SUSPEND_STR

      public static final String ON_SUSPEND_STR
      String indicating that checkpoints should be taken the job is suspended.
      See Also:
  • Constructor Details

    • CheckpointSpecifier

      public CheckpointSpecifier()
  • Method Details

    • getName

      public String getName()
      Get the name of the checkpointing environment.
      Returns:
      the name
    • setName

      public void setName(String name)
      Set the name of the checkpointing environment.
      Parameters:
      name - the name
    • onShutdown

      public boolean onShutdown(boolean set)
      Set whether a checkpoint should be taken when the execution daemon shuts down. Setting this value to true will also set the checkpointing interval to 0.
      Parameters:
      set - whether to take a checkpoint
      Returns:
      the previous value
      See Also:
    • onMinCpuInterval

      public boolean onMinCpuInterval(boolean set)
      Set whether a checkpoint should be taken periodically at the minimum CPU interval as specified by the queue. Setting this value to true will also set the checkpointing interval to 0.
      Parameters:
      set - whether to take a checkpoint
      Returns:
      the previous value
      See Also:
    • onSuspend

      public boolean onSuspend(boolean set)
      Set whether a checkpoint should be taken when the job is suspended. Setting this value to true will also set the checkpointing interval to 0.
      Parameters:
      set - whether to take a checkpoint
      Returns:
      the previous value
      See Also:
    • never

      public byte never()
      Indicate that a checkpoint should never be taken.
      Returns:
      the previous occasion value, as would be returned by getOccasion()
      See Also:
    • setInterval

      public long setInterval(long sec)
      Set the interval at which checkpoints should be taken. If the value is 0, periodic checkpoints will not be taken. If the value is non-zero, the checkpoint occasion will be set to "never".
      Parameters:
      sec - the number of seconds between checkpoints
      Returns:
      the previous value
      See Also:
    • setInterval

      public long setInterval(int hours, int minutes, int seconds)
      Set the interval at which checkpoints should be taken. If the value is 0, periodic checkpoints will not be taken. If the value is non-zero, the checkpoint occasion will be set to "never".
      Parameters:
      hours - the number of hours between checkpoints -- this value is combined to the number of minutes and seconds
      minutes - the number of minutes between checkpoints -- this value is combined to the number of hours and seconds
      seconds - the number of seconds between checkpoints -- this value is combined to the number of minutes and hours
      Returns:
      the previous value
      See Also:
    • getInterval

      public long getInterval()
      Get the number of seconds between checkpoints.
      Returns:
      the number of seconds
    • getOccasion

      public byte getOccasion()
      Get a byte value that represents the occasions when the job should be checkpointed. This value is composed by ORing together the code for the occasions when the job should be checkpointed. If the occasion value is non-zero, the checkpointing interval will be set to 0.
      Returns:
      the occasion value
      See Also:
    • setOccasion

      public void setOccasion(String value)
      Set the occasions when the job should be checkpointed according to a a String composed by combining the string values for the occasions when the job should be checkpointed. If the occasion value is not NEVER, the checkpointing interval will be set to 0.
      Parameters:
      value - the occasion string
      See Also:
    • getOccasionString

      public String getOccasionString()
      Get an occasion string that represents the occasions when the job should be checkpointed. This value is composed by combining the string values for the occasions when the job should be checkpointed.
      Returns:
      the occasion string
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public CheckpointSpecifier clone()
      Overrides:
      clone in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object