 |
|
|
 |
Software Documentation
- About Transport Service
- Installation
- Operation
Download
Project Documentation
Operation
This document describes how to operate the Transport Service software contained in the transport-registry package. The Transport Service software is a web application for retrieving product files from the the Product Servers that are located at the various Discipline Nodes. The following topics can be found in this section:
Interface
The Transport Service provides a REST-based interface accessible via HTTP for interacting with the service. Because the REST-based interface operates over HTTP, there are several options for interacting with the Transport Service:
- Web Browser
Any standard web browser (e.g., Firefox, Safari, Internet Explorer, etc.) will allow interaction with the service.
- cURL
The cURL utility offers the most flexible means for interacting with the application. The utility comes installed on most UNIX-based platforms and is available for download for the Windows platform. The examples in the sections that follow utilize cURL to interact with the application. If cURL is not installed on the local machine but Wget is, see the Using Wget section for converting cURL commands to Wget commands.
The examples below use http://localhost:8080 as the default base end point for the service.
Product Retrieval
The Transport Service web application provides functionality for querying the Registry Service for a product or products and retrieving the associated files. The following table details the parameter available:
| HTTP Parameter | Description |
|---|---|
| q | The DIS-Style query expression identifying the product (or set of files) to retrieve from the Transport Service. This is the preferred parameter for querying the Transport Service and is required if the xmlq parameter is not specified. Additional information regarding the DIS-Style query format can be found at the Apache OODT DIS-Style Query page. |
| xmlq | The XML query expression identifying the product (or set of files) to retrieve from the Transport Service. The details for the format of this query expression will not be covered here. Although supported, the q parameter is preferred and is utilized by all existing client interfaces. This parameter is required if the q parameter is not specified. |
The Transport Service accepts the following parameters in DIS-Style format for the parameter above:
| DIS Query Parameter | Description |
|---|---|
| identifier | The identifier for the product to be retrieved in the form of a PDS logical identifier (LID) or the LID and the version identifier (LIDVID). This parameter is required and may be specified more than once. Due to the 5000 character limit for HTTP POST commands, a safe maximum of specified identifiers is around 50. |
| package | The package type to be returned from the Transport Service. The valid values are ZIP and TGZ. The default value is ZIP. This parameter is optional. |
The following is an example query:
% curl -X GET -o package.zip -v \
http://localhost:8080/transport/prod?q=identifier+EQ+<LID|LIDVID>
Assuming the LID or LIDVID was specified correctly, the above query should return a ZIP package containing the products associated with the specified product. The following is an example query that will return a TAR/GZIP package:
% curl -X GET -o package.tar.gz -v \
http://localhost:8080/transport/prod?q=identifier+EQ+<LID|LIDVID>\
+AND+package+EQ+TGZ
 |
 |
|
 |
|