com.ace.moab.api.reservation
Class Reservation

java.lang.Object
  com.ace.moab.api.reservation.Reservation

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

StandingReservation

public class Reservation
extends java.lang.Object
implements java.io.Serializable

Class that represents a Reservation in Moab. This object can be used by MCM in either to create a reservation, or read in reservation details from moab.

There is no specific list of which properties can be set to null and which attributes must be specified; therefore the programmer must assume that all attributes may be null. The programmer should refer from the situation which variables should and should not be null. For example, when parsing XML from Moab about a reservation, the reservation will always have a name; but when a reservation is being created, the user does not have to specify a name.

Author:

Scott Brown (Old class written by Trent Weber, and refactored by Nate Seeley)

See Also:

Serialized Form

Constructor Summary

Reservation()

Method Summary

void	addAclObject(ACLRule aclObject) Add an acl object to the appropriate ACL list
void	addVariable(Variable var) Adds the variable to the set of variables defined in this reservation.
java.lang.String	allocatedNodesToString() Creates a human-readable form of the allocatedNodes variable
boolean	containsAllocatedNode(MoabNode node) Searches for the given node.
java.lang.String	getAccountingAccount() Get the accountable account for the reservation.
java.lang.String	getAccountingClass() Get the accountable class for the reservation.
java.lang.String	getAccountingGroup() Get the accountable group for the reservation.
java.lang.String	getAccountingQOS() Get the accountable QOS for the reservation.
java.lang.String	getAccountingUser() Get the accountable user for the reservation.
ACL	getACL() Get the complete list of ACL Objects including users, groups, accounts, classes, and qoses.
java.lang.String	getACLString() Generates a String representation of the ACL for the reservation.
java.util.Set<MoabNode>	getAllocatedNodes() Get a Set of type MoabNode that contains all nodes that are currently allocated to the reservation
int	getAllocNodeCount() Get the total number of allocated nodes for the reservation
int	getAllocProcCount() Get the total number of allocated processors for the reservation
int	getAllocTaskCount() Get the total number of allocated tasks for the reservation
java.lang.String	getComments() Get the comments that users might have added to the reservation.
java.util.Date	getCreationDate() Get the creation date from Moab.
java.lang.String	getCredentials() Get credential access defined by Moab.
long	getDuration() Get the duration of this reservation in seconds.
java.util.Date	getEndDate() Get the end date of the reservation.
long	getEndTimeInSeconds() Returns the end time of the reservation in epoch time seconds.
java.util.Date	getExpireDate() Get the reservation's expiration date
ReservationFlags	getFlags() Get the reservation flags associated to this reservation
java.lang.String	getFormattedEndTime() Returns a formatted String representing the end time of the reservation.
java.lang.String	getFormattedStartTime() Returns a formatted String representing the start time of the reservation.
java.lang.String	getGlobalID() Get the globalID as defined in Moab
java.lang.String	getHostListExpression() Get the user-specified host list expression.
JobReservation	getJobInformation() Get the job information for this reservation.
int	getMaxTasks() Get the max number of tasks that can be assigned for the reservation.
java.lang.String	getMessages() Get messages added to the reservation
java.lang.String	getName() Get the reservation name
NodeSetPolicy	getNodeSetPolicy() Get the node set policy for the reservation.
java.lang.String	getOwner() Get the reservation's owner's name
com.moab.api.partitions.Partition	getPartition() Get the partition that the reservation is running on or assigned to
java.lang.String	getProfile() Get the profile that this reservation is (or will be) using.
ReservationRequirements	getRequirements() Get the requirements that this reservation needs in order to be fulfilled.
java.lang.String	getResources() Get the resources assigned or required for the reservation to be fulfilled
java.lang.String	getSpecName() Get The specifed name for this reservation.
java.util.Date	getStartDate() Get the start date of the reservation.
long	getStartTimeInSeconds() Returns the start time of the reservation in epoch time seconds.
ReservationStatistics	getStatistics() Get reservation's statistical information that Moab reports to MCM
java.lang.String	getSubType() Get the reservation sub-type.
int	getTaskCount() Get the number of tasks currently allocated for the reservation
java.util.Set<Trigger>	getTriggerList() Get the list of triggers attached to the reservation.
ReservationType	getType() Get the type of reservation.
java.lang.String	getUIndex() Get the globally unique reservation index
java.util.Set<Variable>	getVariables() Get the list of variables associated to the reservation.
boolean	isActive() Returns true if the reservation is currently active
boolean	isTracked() Returns true if reservation is being tracked by Moab
void	setAccountingAccount(java.lang.String accountingAccount) Set the accountable account for the reservation.
void	setAccountingClass(java.lang.String accountingClass) Set the accountable class for the reservation.
void	setAccountingGroup(java.lang.String accountingGroup) Set the accountable group for the reservation.
void	setAccountingQOS(java.lang.String accountingQOS) Set the accountable QOS for the reservation.
void	setAccountingUser(java.lang.String accountingUser) Set the accountable user for the reservation.
void	setACL(ACL acl) Set the complete list of ACL Objects including users, groups, accounts, classes, and qoses.
void	setActive(boolean isActive) State if reservation is currently active
void	setAllocatedNodeList(java.lang.String nodeStr) Set allocated node list from a comma delimited string
void	setAllocatedNodes(java.util.Set<MoabNode> allocatedNodes) Set the list of MoabNodes that contains all nodes that are currently allocated to the reservation
void	setAllocNodeCount(int allocNodeCount) Set the number of allocated nodes for the reservation
void	setAllocProcCount(int allocProcCount) Set the number of allocated processors for the reservation
void	setAllocTaskCount(int allocTaskCount) Set the number of allocated tasks for the reservation
void	setComments(java.lang.String comments) Set the reservation's comments
void	setCreationDate(java.util.Date creationDate) Set the reservation's creation date
void	setCredentials(java.lang.String credentials) Set the credentials for the reservation
void	setDuration(long duration) Set the duration of this reservation in seconds.
void	setEndDate(java.util.Date endDate) Set the end date of the reservation.
void	setExpireDate(java.util.Date expireDate) Set the reservation's expiration date
void	setFlags(ReservationFlags flags) Set the reservation flags associated to this reservation
void	setGlobalID(java.lang.String globalID) Set the globalID as defined in Moab
void	setHostListExpression(java.util.List<java.lang.String> nodeNames) Set the user-specified host list expression.
void	setHostListExpression(java.lang.String hostListExpression) Set the user-specified host list expression.
void	setJobInformation(JobReservation jobInformation) Set the job information for this reservation.
void	setMaxTasks(int maxTasks) Set the max number of tasks that can be assigned for the reservation.
void	setMessages(java.lang.String messages) Set messages added to the reservation
void	setName(java.lang.String name) Set the reservation name
void	setNodeSetPolicy(NodeSetPolicy nodeSetPolicy) Sets the node set policy for this reservation
void	setOwner(java.lang.String owner) Set the reservation's owner's name
void	setPartition(com.moab.api.partitions.Partition partition) Set the partition that the reservation is running on or assigned to
void	setProfile(java.lang.String profile) Set the profile that this reservation is (or will be) using.
void	setRequirements(ReservationRequirements requirements) Set the requirements that this reservation needs in order to be fulfilled
void	setResources(java.lang.String resources) Set the resources assigned or required for the reservation to be fulfilled
void	setSpecName(java.lang.String specName) Set the specifed name for this reservation.
void	setStartDate(java.util.Date startDate) Set the start date of the reservation.
void	setStatistics(ReservationStatistics statistics) Set reservation's statistical information that Moab reports to MCM
void	setSubType(java.lang.String subType) Set the reservation sub-type.
void	setTaskCount(int taskCount) Set the number of tasks currently allocated for the reservation
void	setTracked(boolean isTracked) Returns true if the reservation is being tacked by Moab
void	setTriggerList(java.util.Set<Trigger> triggerList)
void	setType(ReservationType type) Set the list of triggers attached to the reservation.
void	setUIndex(java.lang.String index) Set the globally unique reservation index
void	setVariables(java.util.Set<Variable> variables) Set the variables attached to this reservation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Reservation

public Reservation()

Method Detail

addAclObject

public void addAclObject(ACLRule aclObject)
                  throws InvalidMoabArgumentException

Add an acl object to the appropriate ACL list

Parameters:

aclObject -

Throws:

InvalidMoabArgumentException - If acl object is null

addVariable

public void addVariable(Variable var)

Adds the variable to the set of variables defined in this reservation. If the set was null, a new set is created with the variable located inside it.

Parameters:

var - The variable to add.

allocatedNodesToString

public java.lang.String allocatedNodesToString()

Creates a human-readable form of the allocatedNodes variable

Returns:

human-readable list of currently allocated nodes

containsAllocatedNode

public boolean containsAllocatedNode(MoabNode node)

Searches for the given node.

Parameters:

node - MoabNode to search for

Returns:

true if and only if the node is allocated to this reservation

getAccountingAccount

public java.lang.String getAccountingAccount()

Get the accountable account for the reservation. This account would be charged if other accounting features are set within Moab

Returns:

the reservation's accountable account

getAccountingClass

public java.lang.String getAccountingClass()

Get the accountable class for the reservation. This class would be charged if other accounting features are set within Moab

Returns:

the reservation's accountable class

getAccountingGroup

public java.lang.String getAccountingGroup()

Get the accountable group for the reservation. This group would be charged if other accounting features are set within Moab

Returns:

the reservation's accountable group

getAccountingQOS

public java.lang.String getAccountingQOS()

Get the accountable QOS for the reservation. This QOS would be charged if other accounting features are set within Moab

Returns:

the reservation's accountable QOS

getAccountingUser

public java.lang.String getAccountingUser()

Get the accountable user for the reservation. This user would be charged if other accounting features are set within Moab

Returns:

the reservation's accountable user

getACL

public ACL getACL()

Get the complete list of ACL Objects including users, groups, accounts, classes, and qoses.

Returns:

the the complete list of ACL Objects including users, groups, accounts, classes, and qoses as a Set of ACLRules

getACLString

public java.lang.String getACLString()

Generates a String representation of the ACL for the reservation. If the reservation does not have an ACL or the ACL is empty, the empty String is returned.

Returns:

a String representation of the ACL for the reservation.

getAllocatedNodes

public java.util.Set<MoabNode> getAllocatedNodes()

Get a Set of type MoabNode that contains all nodes that are currently allocated to the reservation

Returns:

a Set of type MoabNode that contains all nodes that are currently allocated to the reservation

getAllocNodeCount

public int getAllocNodeCount()

Get the total number of allocated nodes for the reservation

Returns:

the the total number of allocated nodes for the reservation

getAllocProcCount

public int getAllocProcCount()

Get the total number of allocated processors for the reservation

Returns:

the the total number of allocated processors for the reservation

getAllocTaskCount

public int getAllocTaskCount()

Get the total number of allocated tasks for the reservation

Returns:

the the total number of allocated tasks for the reservation

getComments

public java.lang.String getComments()

Get the comments that users might have added to the reservation.

Returns:

the comments that users might have added to the reservation.

getCreationDate

public java.util.Date getCreationDate()

Get the creation date from Moab. This method should be called when parsing XML from Moab, as only Moab should assign the creation date to a reservation.

Returns:

the the creation date from Moab

getCredentials

public java.lang.String getCredentials()

Get credential access defined by Moab.

Returns:

the credential access defined by Moab.

getDuration

public long getDuration()

Get the duration of this reservation in seconds.

Returns:

the duration of this reservation in seconds.

getEndDate

public java.util.Date getEndDate()

Get the end date of the reservation. This is especially useful for one time reservations, which have an exact time for when a reservation ends.

Returns:

the end date of the reservation

getEndTimeInSeconds

public long getEndTimeInSeconds()

Returns the end time of the reservation in epoch time seconds. If the end time does not exist, 0 is returned.

Returns:

the end time of the reservation in epoch time seconds.

getExpireDate

public java.util.Date getExpireDate()

Get the reservation's expiration date

Returns:

the reservation's expiration date

getFlags

public ReservationFlags getFlags()

Get the reservation flags associated to this reservation

Returns:

the reservation flags associated to this reservation

getFormattedEndTime

public java.lang.String getFormattedEndTime()

Returns a formatted String representing the end time of the reservation. If the end time is null, "NEVER" is returned.

Returns:

a formatted String representing the end time of the reservation.

getFormattedStartTime

public java.lang.String getFormattedStartTime()

Returns a formatted String representing the start time of the reservation. If the start time is null, "UNKNOWN" is returned.

Returns:

a formatted String representing the start time of the reservation.

getGlobalID

public java.lang.String getGlobalID()

Get the globalID as defined in Moab

Returns:

the globalID as defined in Moab

getHostListExpression

public java.lang.String getHostListExpression()

Get the user-specified host list expression. This may or may not be the nodes that are currently allocated to this reservation.

Returns:

the user-specified host list expression

getJobInformation

public JobReservation getJobInformation()

Get the job information for this reservation. Only useful if the reservation is of type 'job'

Returns:

the job information for this reservation.

getMaxTasks

public int getMaxTasks()

Get the max number of tasks that can be assigned for the reservation.

Returns:

the max number of tasks that can be assigned for the reservation.

getMessages

public java.lang.String getMessages()

Get messages added to the reservation

Returns:

the reservation's messages

getName

public java.lang.String getName()

Get the reservation name

Returns:

the reservation name

getNodeSetPolicy

public NodeSetPolicy getNodeSetPolicy()

Get the node set policy for the reservation.

Returns:

the node set policy for the reservation.

getOwner

public java.lang.String getOwner()

Get the reservation's owner's name

Returns:

the reservation's owner's name

getPartition

public com.moab.api.partitions.Partition getPartition()

Get the partition that the reservation is running on or assigned to

Returns:

the partition that the reservation is running on or assigned to

getProfile

public java.lang.String getProfile()

Get the profile that this reservation is (or will be) using.

Returns:

the profile that this reservation is (or will be) using.

getRequirements

public ReservationRequirements getRequirements()

Get the requirements that this reservation needs in order to be fulfilled.

Cannot be null.

Returns:

the requirements that this reservation needs in order to be fulfilled.

getResources

public java.lang.String getResources()

Get the resources assigned or required for the reservation to be fulfilled

Returns:

the resources assigned or required for the reservation to be fulfilled

getSpecName

public java.lang.String getSpecName()

Get The specifed name for this reservation. This is either a user-specified name or a moab-specified name such as 'system' but it is NOT a unique identifier for this reserveration.

Returns:

The specifed name for this reservation. This is either a user-specified name or a moab-specified name such as 'system' but it is NOT a unique identifier for this reserveration.

getStartDate

public java.util.Date getStartDate()

Get the start date of the reservation. This is especially useful for one time reservations, which have an exact time for when a reservation starts.

Returns:

the start date of the reservation

getStartTimeInSeconds

public long getStartTimeInSeconds()

Returns the start time of the reservation in epoch time seconds. If the start time does not exist, 0 is returned.

Returns:

the start time of the reservation in epoch time seconds.

getStatistics

public ReservationStatistics getStatistics()

Get reservation's statistical information that Moab reports to MCM

Returns:

the statistical information that Moab reports to MCM

getSubType

public java.lang.String getSubType()

Get the reservation sub-type. Can be null.

Returns:

the subType the reservation sub-type. Can be null.

getTaskCount

public int getTaskCount()

Get the number of tasks currently allocated for the reservation

Returns:

the number of tasks currently allocated for the reservation

getTriggerList

public java.util.Set<Trigger> getTriggerList()

Get the list of triggers attached to the reservation.

Returns:

the list of triggers attached to the reservation.

getType

public ReservationType getType()

Get the type of reservation. Ex: 'Job', 'User', etc.

Returns:

the type of reservation

getUIndex

public java.lang.String getUIndex()

Get the globally unique reservation index

Returns:

the globally unique reservation index

getVariables

public java.util.Set<Variable> getVariables()

Get the list of variables associated to the reservation.

Returns:

the list of variables associated to the reservation.

isActive

public boolean isActive()

Returns true if the reservation is currently active

Returns:

if reservation is currently active

isTracked

public boolean isTracked()

Returns true if reservation is being tracked by Moab

Returns:

if reservation is being tracked by Moab

setAccountingAccount

public void setAccountingAccount(java.lang.String accountingAccount)

Set the accountable account for the reservation. This account would be charged if other accounting features are set within Moab

Parameters:

accountingAccount - the accountable account for the reservation

setAccountingClass

public void setAccountingClass(java.lang.String accountingClass)

Set the accountable class for the reservation. This class would be charged if other accounting features are set within Moab

Parameters:

accountingClass - the accountable class for the reservation

setAccountingGroup

public void setAccountingGroup(java.lang.String accountingGroup)

Set the accountable group for the reservation. This group would be charged if other accounting features are set within Moab

Parameters:

accountingGroup - the accountable group for the reservation

setAccountingQOS

public void setAccountingQOS(java.lang.String accountingQOS)

Set the accountable QOS for the reservation. This QOS would be charged if other accounting features are set within Moab

Parameters:

accountingQOS - the accountable QOS for the reservation

setAccountingUser

public void setAccountingUser(java.lang.String accountingUser)

Set the accountable user for the reservation. This user would be charged if other accounting features are set within Moab

Parameters:

accountingUser - the accountable user for the reservation

setACL

public void setACL(ACL acl)

Set the complete list of ACL Objects including users, groups, accounts, classes, and qoses.

Parameters:

acl - a ACL collection with a set the list of users, groups, accounts, classes and qoses that can access the reservation.

setActive

public void setActive(boolean isActive)

State if reservation is currently active

Parameters:

isActive - Set if reservation is currently active

setAllocatedNodeList

public void setAllocatedNodeList(java.lang.String nodeStr)

Set allocated node list from a comma delimited string

Parameters:

nodeStr - Comma delimited string representing nodes

setAllocatedNodes

public void setAllocatedNodes(java.util.Set<MoabNode> allocatedNodes)

Set the list of MoabNodes that contains all nodes that are currently allocated to the reservation

Parameters:

allocatedNodes - the list of MoabNodes that contains all nodes that are currently allocated to the reservation

setAllocNodeCount

public void setAllocNodeCount(int allocNodeCount)

Set the number of allocated nodes for the reservation

Parameters:

allocNodeCount - the number of allocated nodes for the reservation

setAllocProcCount

public void setAllocProcCount(int allocProcCount)

Set the number of allocated processors for the reservation

Parameters:

allocProcCount - the number of allocated processors for the reservation

setAllocTaskCount

public void setAllocTaskCount(int allocTaskCount)

Set the number of allocated tasks for the reservation

Parameters:

allocTaskCount - the number of allocated tasks for the reservation

setComments

public void setComments(java.lang.String comments)

Set the reservation's comments

Parameters:

comments - String object containing reservation's comments

setCreationDate

public void setCreationDate(java.util.Date creationDate)

Set the reservation's creation date

Parameters:

creationDate - the reservation's creation date

setCredentials

public void setCredentials(java.lang.String credentials)

Set the credentials for the reservation

Parameters:

credentials - the credentials for the reservation

setDuration

public void setDuration(long duration)

Set the duration of this reservation in seconds.

Parameters:

duration - the duration of this reservation in seconds.

setEndDate

public void setEndDate(java.util.Date endDate)

Set the end date of the reservation. This is especially useful for one time reservations, which have an exact time for when a reservation ends.

Parameters:

endDate - the end date of the reservation.

setExpireDate

public void setExpireDate(java.util.Date expireDate)

Set the reservation's expiration date

Parameters:

expireDate - the reservation's expiration date

setFlags

public void setFlags(ReservationFlags flags)

Set the reservation flags associated to this reservation

Parameters:

flags - the reservation flags associated to this reservation

setGlobalID

public void setGlobalID(java.lang.String globalID)

Set the globalID as defined in Moab

Parameters:

globalID - the globalID as defined in Moab

setHostListExpression

public void setHostListExpression(java.lang.String hostListExpression)

Set the user-specified host list expression. This may or may not be the nodes that are currently allocated to this reservation. Note that host list expression is treated as a regular expression by Moab. So passing in a String like "node0,node1" would match not just node0 and node1, but also knode0, kpnode0, node10, node100, etc. To request just node0 and node1 you would need to pass in a String like "^node0$,^node1$".

Parameters:

hostListExpression - the user-specified host list expression

setHostListExpression

public void setHostListExpression(java.util.List<java.lang.String> nodeNames)

Set the user-specified host list expression. This may or may not be the nodes that are currently allocated to this reservation. Note that host list expression is treated as a regular expression by Moab. Therefore, the host list expression is formed by taking each node name and surrounding it with a ^ and a $. For example, if you pass in a list containing "node0" and "node1" the host list expression for this object would become "^node0$,^node1$". This prevents "node0" from matching "knode0" and "kpnode0".

Parameters:

nodeNames - a list of node names

setJobInformation

public void setJobInformation(JobReservation jobInformation)

Set the job information for this reservation. Only useful if the reservation is of type 'job'

Parameters:

jobInformation - the job information for this reservation.

setMaxTasks

public void setMaxTasks(int maxTasks)

Set the max number of tasks that can be assigned for the reservation.

Parameters:

maxTasks - the max number of tasks that can be assigned for the reservation.

setMessages

public void setMessages(java.lang.String messages)

Set messages added to the reservation

Parameters:

messages - the messages added to the reservation

setName

public void setName(java.lang.String name)

Set the reservation name

Parameters:

name - the reservation name

setNodeSetPolicy

public void setNodeSetPolicy(NodeSetPolicy nodeSetPolicy)

Sets the node set policy for this reservation

Parameters:

nodeSetPolicy - the nodeSetPolicy to set for this reservation

setOwner

public void setOwner(java.lang.String owner)

Set the reservation's owner's name

Parameters:

owner - the reservation's owner's name

setPartition

public void setPartition(com.moab.api.partitions.Partition partition)

Set the partition that the reservation is running on or assigned to

Parameters:

partition - the partition that the reservation is running on or assigned to

setProfile

public void setProfile(java.lang.String profile)

Set the profile that this reservation is (or will be) using.

Parameters:

profile - the profile that this reservation is (or will be) using.

setRequirements

public void setRequirements(ReservationRequirements requirements)
                     throws InvalidMoabArgumentException

Set the requirements that this reservation needs in order to be fulfilled

Parameters:

requirements - the requirements that this reservation needs in order to be fulfilled

Throws:

InvalidMoabArgumentException - thrown if requirements is null.

setResources

public void setResources(java.lang.String resources)

Set the resources assigned or required for the reservation to be fulfilled

Parameters:

resources - the resources assigned or required for the reservation to be fulfilled

setSpecName

public void setSpecName(java.lang.String specName)

Set the specifed name for this reservation. This is either a user-specified name or a moab-specified name such as 'system' but it is NOT a unique identifier for this reserveration.

Parameters:

specName - The specifed name for this reservation. This is either a user-specified name or a moab-specified name such as 'system' but it is NOT a unique identifier for this reserveration.

setStartDate

public void setStartDate(java.util.Date startDate)

Set the start date of the reservation. This is especially useful for one time reservations, which have an exact time for when a reservation starts.

Parameters:

startDate - the start date of the reservation

setStatistics

public void setStatistics(ReservationStatistics statistics)

Set reservation's statistical information that Moab reports to MCM

Parameters:

statistics - reservation's statistical information that Moab reports to MCM

setSubType

public void setSubType(java.lang.String subType)

Set the reservation sub-type. Can be null.

Parameters:

subType - the reservation sub-type.

setTaskCount

public void setTaskCount(int taskCount)

Set the number of tasks currently allocated for the reservation

Parameters:

taskCount - the number of tasks currently allocated for the reservation

setTracked

public void setTracked(boolean isTracked)

Returns true if the reservation is being tacked by Moab

Parameters:

isTracked - set true if the reservation is being tacked by Moab

setTriggerList

public void setTriggerList(java.util.Set<Trigger> triggerList)

Parameters:

triggerList - the triggerList to set

setType

public void setType(ReservationType type)

Set the list of triggers attached to the reservation.

Parameters:

type - he list of triggers attached to the reservation.

setUIndex

public void setUIndex(java.lang.String index)

Set the globally unique reservation index

Parameters:

index - the globally unique reservation index

setVariables

public void setVariables(java.util.Set<Variable> variables)

Set the variables attached to this reservation

Parameters:

variables - the variables attached to this reservation