Using the command-line client

Overview

The client supports some core features of the Gateway. It is able to ping, send transmissions, request acknowledgements, and retrieve some basic version information. When issuing commands to the client, if the "--service=" argument is not set the client will default to the localhost. In these examples, the .exe is used, however the same arguments can be used for both the .exe. and .jar version.

The command line options as defined in the client are: 

 -f,--filename <arg>        Name of the transmission XML file to send.
 -m,--mode <arg>            Execution Mode ('ping', 'send', 'ack',
                            'lastack', 'version')
 -o,--output <arg>          File to route output to.
 -p,--pass <arg>            Password for the Gateway.
 -pm,--ping message <arg>   Message to send with ping
 -s,--service <arg>         Gateway web service
 -u,--user <arg>            Username for the Gateway.

"user" and "pass" are only requirements for "send", "ack", and "lastack" modes.

Pinging

To ping the OSU demo version of the Gateway use the following command:

  client-sstp-cli-X.X.exe -m ping -pm "alive?" -s "http://gateway-demo.osuosl.org/gateway/services/EFileServiceSoap?wsdl"

Replace the "--service=" entry with the desired location of the Gateway web service you would like to ping.

Sending

To send a transmission to the OSU demo using the client as user GATEWAY99, use the following command:

  client-sstp-cli-X.X.exe -m send -u GATEWAY99 -p GATEWAY99 -f myTransmission.xml
                         -s "http://gateway-demo.osuosl.org/gateway/services/EFileServiceSoap?wsdl"

Acknowledgements & Last Acknowledgements

To request a pending acknowledgement for the last transmission sent by user GATEWAY99 to the OSU demo, use the following command:

  client-sstp-cli-X.X.exe -m ack -u GATEWAY99 -p GATEWAY99 
                         -s "http://gateway-demo.osuosl.org/gateway/services/EFileServiceSoap?wsdl"

For the last acknowledgement sent for user GATEWAY99 use the following command:

  client-sstp-cli-X.X.exe -m lastack -u GATEWAY99 -p GATEWAY99 
                         -s "http://gateway-demo.osuosl.org/gateway/services/EFileServiceSoap?wsdl"

Version information

To query the OSU demo web service for its version information issue the following command:

  client-sstp-cli-X.X.exe -m version -s "http://gateway-demo.osuosl.org/gateway/services/EFileServiceSoap?wsdl"