Package com.sun.grid.jsv
Class CheckpointSpecifier
- java.lang.Object
-
- com.sun.grid.jsv.CheckpointSpecifier
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
public final class CheckpointSpecifier extends java.lang.Object implements java.lang.Cloneable, java.io.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.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
NEVER_STR
String indicating that checkpoints should never be taken.static byte
ON_MIN_CPU_INTERVAL
Code indicating that checkpoints should be taken periodically at the minimum CPU interval as specified by the queue.static java.lang.String
ON_MIN_CPU_INTERVAL_STR
String indicating that checkpoints should be taken periodically at the minimum CPU interval as specified by the queue.static byte
ON_SHUTDOWN
Code indicating that checkpoints should be taken when the execd shuts downstatic java.lang.String
ON_SHUTDOWN_STR
Value indicating that checkpoints should be taken when the execd shuts downstatic byte
ON_SUSPEND
Code indicating that checkpoints should be taken the job is suspended.static java.lang.String
ON_SUSPEND_STR
String indicating that checkpoints should be taken the job is suspended.
-
Constructor Summary
Constructors Constructor Description CheckpointSpecifier()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CheckpointSpecifier
clone()
boolean
equals(java.lang.Object obj)
long
getInterval()
Get the number of seconds between checkpoints.java.lang.String
getName()
Get the name of the checkpointing environment.byte
getOccasion()
Get a byte value that represents the occasions when the job should be checkpointed.java.lang.String
getOccasionString()
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
setName(java.lang.String name)
Set the name of the checkpointing environment.void
setOccasion(java.lang.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.java.lang.String
toString()
-
-
-
Field Detail
-
NEVER_STR
public static final java.lang.String NEVER_STR
String indicating that checkpoints should never be taken.- See Also:
- Constant Field Values
-
ON_SHUTDOWN
public static final byte ON_SHUTDOWN
Code indicating that checkpoints should be taken when the execd shuts down- See Also:
- Constant Field Values
-
ON_SHUTDOWN_STR
public static final java.lang.String ON_SHUTDOWN_STR
Value indicating that checkpoints should be taken when the execd shuts down- See Also:
- Constant Field Values
-
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:
- Constant Field Values
-
ON_MIN_CPU_INTERVAL_STR
public static final java.lang.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:
- Constant Field Values
-
ON_SUSPEND
public static final byte ON_SUSPEND
Code indicating that checkpoints should be taken the job is suspended.- See Also:
- Constant Field Values
-
ON_SUSPEND_STR
public static final java.lang.String ON_SUSPEND_STR
String indicating that checkpoints should be taken the job is suspended.- See Also:
- Constant Field Values
-
-
Method Detail
-
getName
public java.lang.String getName()
Get the name of the checkpointing environment.- Returns:
- the name
-
setName
public void setName(java.lang.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:
getInterval()
-
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:
getInterval()
-
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:
getInterval()
-
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:
getOccasion()
-
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:
getOccasion()
-
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:
getOccasion()
-
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:
ON_MIN_CPU_INTERVAL
,ON_SHUTDOWN
,ON_SUSPEND
,getInterval()
-
setOccasion
public void setOccasion(java.lang.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:
ON_MIN_CPU_INTERVAL_STR
,ON_SHUTDOWN_STR
,ON_SUSPEND_STR
,getInterval()
-
getOccasionString
public java.lang.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:
ON_MIN_CPU_INTERVAL_STR
,ON_SHUTDOWN_STR
,ON_SUSPEND_STR
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
clone
public CheckpointSpecifier clone()
- Overrides:
clone
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-