Operation

This document describes how to operate the Transport Service software contained in the transport-ofsn package. The Transport Service software is a web application for transporting files from Discipline Node local data repositories. The following topics can be found in this section:

• Interface
• Product Query

Interface

The Transport Service provides a REST-based interface accessible via HTTP for interacting with the service. This interface accepts both HTTP GET and HTTP POST style requests. 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 service. 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 service. 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 Query

The Transport Service provides functionality for transporting files from Discipline Node local data repositories. The service can be queried using 3 possible methods for encoding the HTTP request parameters: DIS-Style syntax, XML query expressions, or Simple HTTP syntax (name, value) pairs. The following table summarizes the parameters available:

When using DIS-Style syntax, the OFSN and RT parameters must be encoded as part of the "q" value parameter. The following is an example query request via cURL using the q parameter:

% curl -X GET -o results.out -v \
http://localhost:8080/transport-ofsn/prod?q=<keyword-query>
      

% curl -X GET -o results.out -v \
http://localhost:8080/transport-ofsn/prod?OFSN=<ofsn value>&RT=<rt value>
      

The keyword query expression must be properly encoded by the rules of Uniform Resource Identifiers whether they're part of the URL in an HTTP GET request or transmitted separately in an HTTP POST request. In general, this means that characters spaces and equal signs in query expressions need to be properly escaped. Most browsers and HTTP libraries will happily relax these rules, though, especially in cases where there is no ambiguity. For Transport Service queries, this basically means changing your spaces to +'s. The following example of a keyword query expression details the difference between an unencoded and encoded query:

OFSN EQ <online-file-specification-name> AND RT EQ <return-type>

  properly encoded request:

OFSN+EQ+<online-file-specification-name>+AND+RT+EQ+<return-type>
      

For example, the following query requests a directory listing from the test-data1 sub-directory found under the Transport Service's root directory (specified by the productRoot property during configuration):

% curl -X GET -o results.out -v \
http://localhost:8080/transport-ofsn/prod?q=OFSN+EQ+/test-data1+AND+RT+EQ+DIRLIST1
      

The following tables list all the valid values for the return type keyword. The examples provided assume the existence of a transport-ofsn application deployed within a local Tomcat container running on port 8080. For each possible value of RT, the same example request is shown as encoded with DIS-Style syntax, or simple (name, value) pairs.

"Listing" Return Types

<dirResult xmlns="http://osr.jpl.nasa.gov/xml/namespaces/dirlist/1.0">
  <dirEntry>
    <OFSN>/FF01.IMG</OFSN>
    <fileSize>1050624</fileSize>
  </dirEntry>
  <dirEntry>
    <OFSN>/FF01.LBL</OFSN>
    <fileSize>5143</fileSize>
  </dirEntry>
  <dirEntry>
    <OFSN>/test-data2/i943630r.raw</OFSN>
    <fileSize>126976</fileSize>
  </dirEntry>
  <dirEntry>
    <OFSN>/test-data2/i943630r.xml</OFSN>
    <fileSize>7862</fileSize>
  </dirEntry>
  .........
</dirResult>
              

<dirResult xmlns="http://osr.jpl.nasa.gov/xml/namespaces/dirlist/1.0">
  <dirEntry>
    <OFSN>/FF01.IMG</OFSN>
    <fileSize>1050624</fileSize>
  </dirEntry>
  <dirEntry>
    <OFSN>/FF01.LBL</OFSN>
    <fileSize>5143</fileSize>
  </dirEntry>
</dirResult>
              

<dirResult xmlns="http://osr.jpl.nasa.gov/xml/namespaces/dirlist/1.0">
  <dirEntry>
    <OFSN>/test-data1</OFSN>
    <fileSize>8669232</fileSize>
  </dirEntry>
  <dirEntry>
    <OFSN>/test-data2</OFSN>
    <fileSize>134838</fileSize>
  </dirEntry>
  <dirEntry>
    <OFSN>/test-data1/test-data11</OFSN>
    <fileSize>4334616</fileSize>
  </dirEntry>
</dirResult>
            

<dirResult xmlns="http://osr.jpl.nasa.gov/xml/namespaces/dirlist/1.0">
  <dirEntry>
    <OFSN>/test-data1</OFSN>
    <fileSize>8669232</fileSize>
  </dirEntry>
  <dirEntry>
    <OFSN>/test-data2</OFSN>
    <fileSize>134838</fileSize>
  </dirEntry>
</dirResult>
            

<dirResult xmlns="http://osr.jpl.nasa.gov/xml/namespaces/dirlist/1.0">
  <dirEntry>
    <OFSN>/test-data1/FF01.IMG</OFSN>
    <fileSize>1050624</fileSize>
  </dirEntry>
</dirResult>
            

<dirResult xmlns="http://osr.jpl.nasa.gov/xml/namespaces/dirlist/1.0">
  <dirEntry>
    <OFSN>/test-data1/FF01.IMG</OFSN>
    <fileSize>1050624</fileSize>
  </dirEntry>
</dirResult>
            

<dirResult xmlns="http://osr.jpl.nasa.gov/xml/namespaces/dirlist/1.0">
  <dirEntry>
    <OFSN>FF01.IMG.zip</OFSN>
    <fileSize>816445</fileSize>
  </dirEntry>
</dirResult>
            

<dirResult xmlns="http://osr.jpl.nasa.gov/xml/namespaces/dirlist/1.0">
  <dirEntry>
    <OFSN>FF01.IMG.zip</OFSN>
    <fileSize>816445</fileSize>
  </dirEntry>
</dirResult>
            

"Get" Return Types that apply both to PDS3 and PDS4 labels

<dirResult xmlns="http://osr.jpl.nasa.gov/xml/namespaces/dirlist/1.0">
  <dirEntry>
    <fileSize>1050624</fileSize>
  </dirEntry>
</dirResult>
            

"Get" Return Types that apply only to PDS4 labels

"Get" Return Types that apply only to PDS3 labels

<?xml version="1.0"?>
<!DOCTYPE dirresult PUBLIC "-//JPL/DTD OODT dirresult 1.0//EN" "http://starbrite.jpl.nasa.gov:80/dtd/dirresult.dtd">
<dirResult>
  <dirEntry>
    <fileSize>10390</fileSize>
  </dirEntry>
</dirResult>
            

"Get" Return Types that apply to PDS3 and PDS4 directories

<?xml version="1.0"?>
<!DOCTYPE dirresult PUBLIC "-//JPL/DTD OODT dirresult 1.0//EN" "http://starbrite.jpl.nasa.gov:80/dtd/dirresult.dtd">
<dirResult>
  <dirEntry>
    <fileSize>26563938</fileSize>
  </dirEntry>
</dirResult>