de.fzj.unicore.uas.client
Class ReservationClient

java.lang.Object
  de.fzj.unicore.wsrflite.xmlbeans.client.BaseWSRFClient
      de.fzj.unicore.uas.client.BaseUASClient
          de.fzj.unicore.uas.client.ReservationClient

public class ReservationClient
extends BaseUASClient

Client for managing a resource reservation.
It can be used to

• query the reservation properties
• claim the booking by submitting a job including the reservation reference
• cancel the booking using the WSRF destroy() operation

Author:

schuller

Field Summary

Fields inherited from class de.fzj.unicore.wsrflite.xmlbeans.client.BaseWSRFClient

epr, proxyMaker, retryDecider, securityProperties, url

Constructor Summary

ReservationClient(org.w3.x2005.x08.addressing.EndpointReferenceType epr)

ReservationClient(org.w3.x2005.x08.addressing.EndpointReferenceType epr, IUASSecurityProperties sec)

ReservationClient(java.lang.String url, org.w3.x2005.x08.addressing.EndpointReferenceType epr)

ReservationClient(java.lang.String url, org.w3.x2005.x08.addressing.EndpointReferenceType epr, IUASSecurityProperties sec)

Method Summary

org.ggf.schemas.jsdl.x2005.x11.jsdl.ResourcesType	addReservationReference(org.ggf.schemas.jsdl.x2005.x11.jsdl.ResourcesType resources) add the reservation reference to the resources The reference is added as an XML element as follows: <ReservationReference xmlns="http://www.unicore.eu/unicore/xnjs">reference</ReservationReference>
java.lang.String	getReservationReference() get the reservation reference
org.unigrids.x2006.x04.services.reservation.ReservationStatusType.Enum	getReservationStatus() get the status of the reservation
org.unigrids.x2006.x04.services.reservation.ReservationPropertiesDocument	getResourcePropertiesDocument() get the resource properties document of the Reservation WS-Resource
org.ggf.schemas.jsdl.x2005.x11.jsdl.ResourcesDocument	getResources() get the resources that have been reserved
java.util.Calendar	getStartTime() get the StartTime property
org.w3.x2005.x08.addressing.EndpointReferenceType	getTSSEpr() get the EPR of the TargetSystem where the reservation has been made
JobClient	submit(org.unigrids.x2006.x04.services.tss.SubmitDocument in) Submit a job to the TSS used in this reservation If not present, the booking reference is inserted automatically into the resource description.

Methods inherited from class de.fzj.unicore.uas.client.BaseUASClient

extractReceiver, getSecurityProperties, getServerVersion, setRetryDefaults

Methods inherited from class de.fzj.unicore.wsrflite.xmlbeans.client.BaseWSRFClient

checkConnection, checkConnection, destroy, getConnectionStatus, getCurrentTime, getEPR, getLT, getMultipleResourceProperties, getResourceProperty, getResourcePropertyDocument, GetResourcePropertyDocument, getRP, getTerminationTime, getUpdateInterval, getUrl, makeProxy, queryResourceProperties, setConnectionTimeout, setConnectionTimeout, setRetryHandler, setTerminationTime, setUpdateInterval

Methods inherited from class java.lang.Object

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

Constructor Detail

ReservationClient

public ReservationClient(java.lang.String url,
                         org.w3.x2005.x08.addressing.EndpointReferenceType epr,
                         IUASSecurityProperties sec)
                  throws java.lang.Exception

Throws:

java.lang.Exception

ReservationClient

public ReservationClient(org.w3.x2005.x08.addressing.EndpointReferenceType epr,
                         IUASSecurityProperties sec)
                  throws java.lang.Exception

Throws:

java.lang.Exception

ReservationClient

public ReservationClient(java.lang.String url,
                         org.w3.x2005.x08.addressing.EndpointReferenceType epr)
                  throws java.lang.Exception

Throws:

java.lang.Exception

ReservationClient

public ReservationClient(org.w3.x2005.x08.addressing.EndpointReferenceType epr)
                  throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

submit

public JobClient submit(org.unigrids.x2006.x04.services.tss.SubmitDocument in)
                 throws java.lang.Exception

Submit a job to the TSS used in this reservation
If not present, the booking reference is inserted automatically into the resource description.

Parameters:

in - the submission document

Returns:

Throws:

java.lang.Exception

addReservationReference

public org.ggf.schemas.jsdl.x2005.x11.jsdl.ResourcesType addReservationReference(org.ggf.schemas.jsdl.x2005.x11.jsdl.ResourcesType resources)
                                                                          throws java.lang.Exception

add the reservation reference to the resources The reference is added as an XML element as follows: <ReservationReference xmlns="http://www.unicore.eu/unicore/xnjs">reference</ReservationReference>

Parameters:

resources -

Throws:

java.lang.Exception

getStartTime

public java.util.Calendar getStartTime()
                                throws java.lang.Exception

get the StartTime property

Returns:

start time for the reservation

Throws:

java.lang.Exception

getReservationReference

public java.lang.String getReservationReference()
                                         throws java.lang.Exception

get the reservation reference

Returns:

reservation reference String

Throws:

java.lang.Exception

getResources

public org.ggf.schemas.jsdl.x2005.x11.jsdl.ResourcesDocument getResources()
                                                                   throws java.lang.Exception

get the resources that have been reserved

Returns:

a ResourcesDocument

Throws:

java.lang.Exception

getReservationStatus

public org.unigrids.x2006.x04.services.reservation.ReservationStatusType.Enum getReservationStatus()
                                                                                            throws java.lang.Exception

get the status of the reservation

Returns:

a ResourcesStatusType.Enum

Throws:

java.lang.Exception

getTSSEpr

public org.w3.x2005.x08.addressing.EndpointReferenceType getTSSEpr()
                                                            throws java.lang.Exception

get the EPR of the TargetSystem where the reservation has been made

Returns:

an EndpointReferenceType holding the EPR

Throws:

java.lang.Exception

getResourcePropertiesDocument

public org.unigrids.x2006.x04.services.reservation.ReservationPropertiesDocument getResourcePropertiesDocument()
                                                                                                        throws java.lang.Exception

get the resource properties document of the Reservation WS-Resource

Returns:

a ReservationPropertiesDocument

Throws:

java.lang.Exception