processWSDL: Read and process a Web Service Description Language file

Description Usage Arguments Value Author(s) See Also Examples

Description

This reads and converts a WSDL file for a server into a collection of functions and methods.

Usage

1
2
3
4
processWSDL(fileName = "KEGG.wsdl", handlers =
             WSDLParseHandlers(fileName), nameSpaces = character(),
             useInternalNodes = TRUE, verbose = FALSE, port = 1L,
             checkCircularTypes = TRUE)

Arguments

fileName

the name of the WSDL file or URI.

handlers

a list of handler functions that are passed to xmlTreeParse to perform transformations on the XML nodes as the are parsed and converted to R objects. The default handlers drop comments and take care of importing files that are referenced via <wsdl:import> nodes.

nameSpaces

a character vector that identifies the namespace-URI mappings used for calls to this server. This maps the namespace abbreviations to the actual URIs. This can be a named character vector of these mappings, or alternatively a simple character string that identifies the name of the element in the .SOAPDefaultNameSpaces list. And if we don't know the collection of namespaces, we use NA to indicate that we shall determine this later.

useInternalNodes

a logical value indicating whether to use internal/C-level nodes for the XML tree or to use R objects representing the nodes.

verbose

a logical value indicating whether to emit messages to the console signalling progress being made and what elements are being processed. This is passed to processSchemaTypes.

port

a number or string that is used to identify which of the port elements to use in the WSDL. This allows the caller to specify whether they want to use, e.g., SOAP 1.1 or SOAP 1.2 or SOAP PUT if the WSDL provides more than one of these

checkCircularTypes

a logical value that controls whether we check for circular references in definitions of data types in the XML schema.

Value

An object of class SOAPServerDescription.

Author(s)

Duncan Temple Lang <duncan@wald.ucdavis.edu>

See Also

UseDashInSOAPNames is an R option that can be set by the user that is understood by this package to control whether to either leave SOAP method names as-is, or if FALSE, to remove _ in the names and capitalize the first character in all but the first word of the name. In other words, if UseDashInSOAPNames is set to FALSE, the name abc_def_ghi is mapped to abcDefGhi. By default, the value is unset and treated as TRUE, so dashes are preserved.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
  tmp = processWSDL(system.file("examples", "KEGG.wsdl", package = "SSOAP"))

   # The first set of operations, and the method "color_pathway_by_objects"
  o = tmp@operations[[1]][["color_pathway_by_objects"]]
  names(o@parameters)
  o@parameters[["fg_color_list"]]
  o@returnValue


  ff = genSOAPClientInterface(tmp@operations[[1]], def = tmp, tmp@name, verbose=FALSE)

# ff$functions$get_all_neighbors_by_gene(kid="eco:b0002", threshold= as.integer(500), orgs = c("ecs","ypk"))

## Not run: 
  x = ff@functions$get_paralogs_by_gene("eco:b0002", 1, 10)

## End(Not run)

  tp = get(".operation", environment(ff@functions$get_paralogs_by_gene))@returnValue


  # A different WSDL file.
  tmp = processWSDL(system.file("examples", "XMethodsFilesystemService.wsdl.xml", package = "SSOAP"))

## Not run: 
    cs = processWSDL("http://www.chemspider.com/MassSpecAPI.asmx?WSDL", port= 3)
    cs = processWSDL("http://www.chemspider.com/MassSpecAPI.asmx?WSDL", port = "MassSpecAPIHttpGet")

## End(Not run)

sckott/SSOAP documentation built on Sept. 16, 2020, 5:49 p.m.