Scratch page for working on the VOSpace specification.

---

Web service operations (cont)

pullDataFromVoSpace

Request set of URLs that the client can read data from.

This will probably be the primary data access method for reading data from a VOSpace The client requests access to athe data in a Node, and the server responds with a set of URLs that the client can read the data from.

Parameters

• source : The URI of an existing DataNode
• transfer : A transfer element containing details ofA template for the data Transfer

The template for the Transfer should contain details of the View and a list of the Protocols that the client would like to use.

The list of Protocols should not contain endpoint addresses, the service will supply the endpoint addresses in the response.

The service will ignore any of the requested protocols that it does not understand or is unable to support.

Returns

• transfer : A transfer element containingUpdated details of the data Transfer

The service shall choose selects which of the requested Protocols it is willing to provide and fills in the operational details for each one.

It shall remove those requestedThe service response should not include any Protocols which it is unable to support.

Faults

• The service shall throw an InternalFault exception if anthe operation fails
• The service shall throw a PermissionDenied exception if the user does not have permissions to perform the operation
• The service shall throw an InvalidURI exception if the source URI is invalid
• The service shall throw a NodeNotFound exception if the source Node does not exist.
• The service shall throw an OperationNotSupported ProtocolNotSupported exception if it does not support anysupports none of the requested transfer Protocols
• The service shall throw a ViewNotSupported exception if it does not support the requested data View (format)
• The service shall throw an InvalidArgument exception if one of thea parameter values in a Protocol orthe requested View is invalid
• The service shall throw an InvalidArgument exception if a parameter in one of the requested Protocols is invalid

Notes

The any endpoint URLs or URI supplied in the response should be considered as a 'one shot' URLs. A VOSpace service connected to a standard web server may return the public URL for the data. However, a different implementation may create a unique URL specifically for this transfer, which can only be used once, and may have a limited lifetime.

pushDataFromVoSpace

Ask the server to send data to a remote location.

The client supplies a list of URLs or URI, and asks the server to send the data to the remote location.

The transfer is initiated by the server, and the data is transferred direct from the server to the remote location.

Parameters

• Destination source : The URI of an existing DataNode

• transfer : A transfer element containing dDetails of the data Transfer

The Transfer details should include the View and a list of one or more Protocols with valid endpoint and params for each one.

Returns

• void

Faults

• The service shall throw an InternalFault exception if anthe operation fails
• The service shall throw a PermissionDenied exception if the user does not have permissions to perform the operation
• The service shall throw an InvalidURI exception if the user-supplied source URI is invalid.
• The service shall throw a NodeNotFound exception if the source Node does not exist.
• The service shall throw an OperationNotSupported ProtocolNotSupported exception if it supports none of the requested transfer Protocols
• The service shall throw a ViewNotSupported exception if it does not support the requested data View (format)
• The service shall throw an InvalidArgument exception if one of thea parameter values in a Protocol orthe requested View is invalid
• The service shall throw an InvalidArgument exception if a parameter in one of the requested Protocols is invalid
• The service shall throw a TransferFailed exception if the data transfer does not complete.

Notes

In VOSpace version 1.0, the transfer is synchronous, and the SOAP call does not return until the transfer has been completed.

If the Transfer request contains more than one Protocol then tThe service may failover to use one or more Protocol of the options if the first one faileds. The service should try each method Protocol option in turn until one succeeds or all have been tried.

Fault arguments

InternalFault^?

This is thrown with a description of the cause of the fault.

PermissionDenied^?

This is thrown with no arguments.

InvalidURI^?

This is thrown with details of the invalid URI.

NodeNotFound^?

This is thrown with the URI of the missing Node that cannot be found.

DuplicateNode^?

This is thrown with the URI of the duplicate Node .

InvalidToken^?

This is thrown with the invalid token.

InvalidArgument^?

This is thrown with a description of the invalid argument. For View and Protocol values params, this can include, including the View or Protocol URI the param name and the param value.

TypeNotSupported^?

This is thrown with the QName of the unsupported type.

ViewNotSupported^?

This is thrown with the uri of the requested View that is not supported.

InvalidData^?

This is thrown with any error message that the data parser produced in attempting to import data into a StructuredDataNode^?.

References

[1] T. Berners-Lee, R. Fielding, U. Irvine, L. Masinter, Uniform Resource Identifiers (URI): Generic Syntax, http://www.faqs.org/rfcs/rfc2396.html

[2] R. Plante, T. Linde, R. Williams, & K. Noddle, IVOA Identifiers, http://www.ivoa.net/Documents/latest/IDs.html

-- DaveMorris - 02 Mar 2007