Package com.sun.grid.jsv
Class CheckpointSpecifier
java.lang.Object
com.sun.grid.jsv.CheckpointSpecifier
- All Implemented Interfaces:
Serializable
,Cloneable
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
FieldsModifier and TypeFieldDescriptionstatic 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 downstatic final String
Value indicating that checkpoints should be taken when the execd shuts downstatic 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 -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
long
Get the number of seconds between checkpoints.getName()
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
hashCode()
byte
never()
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
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.toString()
-
Field Details
-
NEVER_STR
String indicating that checkpoints should never be taken.- See Also:
-
ON_SHUTDOWN
public static final byte ON_SHUTDOWNCode indicating that checkpoints should be taken when the execd shuts down- See Also:
-
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_INTERVALCode indicating that checkpoints should be taken periodically at the minimum CPU interval as specified by the queue.- See Also:
-
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_SUSPENDCode indicating that checkpoints should be taken the job is suspended.- See Also:
-
ON_SUSPEND_STR
String indicating that checkpoints should be taken the job is suspended.- See Also:
-
-
Constructor Details
-
CheckpointSpecifier
public CheckpointSpecifier()
-
-
Method Details
-
getName
Get the name of the checkpointing environment.- Returns:
- the name
-
setName
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 secondsminutes
- the number of minutes between checkpoints -- this value is combined to the number of hours and secondsseconds
- 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
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
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
-
hashCode
public int hashCode() -
clone
-
toString
-