• Home
• Globus Online
• Globus Toolkit
• dev.globus
• About Globus

Home -> Cog -> Release -> Cog-1.0a -> Doc -> Api -> Org -> Globus -> Gara

org.globus.gara
Class GaraReservation

java.lang.Object
  |
  +--org.globus.gara.GaraReservation

public class GaraReservation

extends java.lang.Object

This class is the primary class used in affecting gara reservations. Use this class to create, modify, cancel, bind and unbind reservations. NOTE: All Globus Gara related code is currently highly experimental and is offered only as a possible convenience to the user. Proper functionality is not, at this time, guaranteed or supported. It has been demonstrated to work under limited test conditions, so it is advised that one make every possible effort to obtain functional status before submitting bug reports or comments.

Constructor Summary

GaraReservation()
Default constructor (no automatic creation of reservation)

GaraReservation(GlobusProxy proxy)
Default constructor (no automatic creation of reservation) with specified credentials

GaraReservation(java.lang.String reservationHandle)
Default constructor used to affect a previously created reservation

GaraReservation(java.lang.String managerContact, GaraReservationSpecification reservationSpecification)
Default constructor with automatic creation of reservation

Method Summary

void	addListener(GaraReservationListener listener) Add a listener to the GaraReservation.
void	bind(GaraBindParameters bindParameters) Bind the newly created reservation.
void	cancel() Cancel the reservation
java.lang.String	create(java.lang.String managerContact, GaraReservationSpecification reservationSpecification) Create the reservation
GlobusURL	getCallbackURL()
GlobusProxy	getCredentials() Returns reservation's credentials.
GaraResourceManagerContact	getHandle()
java.lang.String	getReservationHandle() Return the current reservation handle
int	getReservationStatusAsInt()
java.lang.String	getReservationStatusAsString()
long	getTime(int year, int month, int day, int hour, int min, int sec)
java.lang.String	modify(GaraReservationSpecification reservationSpecification) Modify the reservation
void	removeListener(GaraReservationListener listener) Remove a listener from the GaraReservation.
void	setCallbackUrl(java.lang.String url)
void	setCredentials(GlobusProxy newProxy)
void	setReservationHandle(java.lang.String newReservationHandle) This is used by a native function to pass back the reservation handle String.
protected void	setStatus(int newStatus)
void	unbind() Unbind the reservation.
void	unregister_callback()
void	updateStatus() Forces an update of the status.

Methods inherited from class java.lang.Object

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

Constructor Detail

GaraReservation

public GaraReservation()

Default constructor (no automatic creation of reservation)

GaraReservation

public GaraReservation(GlobusProxy proxy)

Default constructor (no automatic creation of reservation) with specified credentials

GaraReservation

public GaraReservation(java.lang.String managerContact,
                       GaraReservationSpecification reservationSpecification)
                throws GlobusProxyException,
                       GaraException

Default constructor with automatic creation of reservation

Throws:

GaraException

GlobusProxyException

GaraReservation

public GaraReservation(java.lang.String reservationHandle)
                throws GlobusProxyException,
                       GaraException

Default constructor used to affect a previously created reservation

Method Detail

create

public java.lang.String create(java.lang.String managerContact,
                               GaraReservationSpecification reservationSpecification)
                        throws GlobusProxyException,
                               GaraException

Create the reservation

Parameters:

managerContact - The Gara resource manager contact String

reservationSpecification - A GaraReservationSpecification data structure holding information used to build an RSL which is submitted to the Gara resource manager

Returns:

String This is the reservation handle

Throws:

GaraException

GlobusProxyException

getCredentials

public GlobusProxy getCredentials()

Returns reservation's credentials. returns reservation's credentials. if null none were set.

setCredentials

public void setCredentials(GlobusProxy newProxy)

unregister_callback

public void unregister_callback()
                         throws GlobusProxyException,
                                GaraException

GlobusProxyException

GaraException

modify

public java.lang.String modify(GaraReservationSpecification reservationSpecification)
                        throws GlobusProxyException,
                               GaraException

Modify the reservation

Parameters:

reservationSpecification - A GaraReservationSpecification data structure holding information used to build an RSL which is submitted to the Gara resource manager

Throws:

GaraException

GlobusProxyException

cancel

public void cancel()
            throws GlobusProxyException,
                   GaraException

Cancel the reservation

Throws:

GaraException

GlobusProxyException

setStatus

protected void setStatus(int newStatus)
                  throws GaraException

Parameters:

newStatus - The new status of the reservation #see org.globus.gara.GaraReservationListener

GaraException

addListener

public void addListener(GaraReservationListener listener)

Add a listener to the GaraReservation. The listener will be notified whenever the state of the GaraReservation changes.

Parameters:

listener - The object that wishes to receive status updates.

See Also:

GaraReservationListener

removeListener

public void removeListener(GaraReservationListener listener)

Remove a listener from the GaraReservation. The listener will no longer be notified of state changes for the GaraReservation.

Parameters:

listener - The object that wishes to stop receiving state updates.

See Also:

GaraReservationListener

bind

public void bind(GaraBindParameters bindParameters)
          throws GlobusProxyException,
                 GaraException

Bind the newly created reservation. This submits the reservation to the Gara resource manager which allows the reservation to be honored.

Parameters:

bindParameters - This is a GaraBindParameters data structure that holds information used to build an RSL that tells the Gara resource manager how to bind the reservation.

Throws:

GaraException

GlobusProxyException

unbind

public void unbind()
            throws GlobusProxyException,
                   GaraException

Unbind the reservation. This signals the Gara resource manager that this reservation should not be honored.

Throws:

GaraException

GlobusProxyException

updateStatus

public void updateStatus()
                  throws GlobusProxyException,
                         GaraException

Forces an update of the status.

Throws:

GaraException

GlobusProxyException

setCallbackUrl

public void setCallbackUrl(java.lang.String url)

setReservationHandle

public void setReservationHandle(java.lang.String newReservationHandle)

This is used by a native function to pass back the reservation handle String.

Parameters:

newReservationHandle - This is the new value to set the reservationHandle to.

getReservationHandle

public java.lang.String getReservationHandle()

Return the current reservation handle

Returns:

String This is the current reservation handle or null if no reservation has yet been created

getHandle

public GaraResourceManagerContact getHandle()

getCallbackURL

public GlobusURL getCallbackURL()

getReservationStatusAsString

public java.lang.String getReservationStatusAsString()

getReservationStatusAsInt

public int getReservationStatusAsInt()

getTime

public long getTime(int year,
                    int month,
                    int day,
                    int hour,
                    int min,
                    int sec)