SOAPMessenger

SOAP Is a method of communicating with XML data. Usually it is best to see SOAP as a way to call a function on a server and get a response. This tool is used as a library in the WOSFetch class.

Reason for use

Some sites, like the web of science, have multiple communication paths and SOAP is a standard which is relatively simple to implement, and so may be made available for that reason.

Parameters

The parameters for the tool can be placed in the specified config file.

wordiness

wordiness - (optional) sets the lowest level of log messages to be displayed to the console. The lower the log level, the more detailed the messages.
Possible Values:

  • OFF - Results in no messages being displayed.
  • ERROR - Results in only messages from the ERROR level to be displayed.
    • Error messages detail when the tool has experienced an error preventing it from completing its task
  • WARN - Results in only messages above and including WARN level messages to be displayed. Match does not produce any WARN level messages.
  • INFO - (Default) Results in all messages above and including INFO level messages to be displayed. INFO level messages detail when the tool has started and ended and when it begins/ends a phase ('Finding matches' and 'Beginning Rename of matches') and how many matches have been found.
  • DEBUG - Results in all messages above and including DEBUG level messages to be displayed. DEBUG level messages detail each matching input URI to its VIVO URI as they are processed. Additionally, it will display stacktrace information if an error occurs.
  • ALL or TRACE - Results in all messages above and including TRACE level messages to be displayed, since trace is the lowest level it is the same as ALL in practice. TRACE level messages details every matching set as it is processed in each phase along with SPARQL queries and start and stop for their execution.

Overview

Short Option

Long Option

Parameter Value Map

Description

Required

u

url

URL

The URL which will receive the message

true

m

message

MESSAGE

File path to the message

true

o

output

OUTPUT_FILE

File path for result XML

true

a

authentication

AUTH

Sets session id to value in format required by WOSFetch

false

p

requestproperty

Parameters to set as request properties. Sets cookies or other meta values.

true

  • No labels