genSOAPClientInterface         package:SSOAP         R Documentation

_C_r_e_a_t_e _R _f_u_n_c_t_i_o_n_s _t_o _a_c_c_e_s_s _S_O_A_P _s_e_r_v_e_r _m_e_t_h_o_d_s

_D_e_s_c_r_i_p_t_i_o_n:

     This function creates function definitions, etc. that provide
     access to the methods described in the SOAP server description
     details.

_U_s_a_g_e:

     genSOAPClientInterface(operations = def@operations[[1]], def, name = def@name,
                            env = new.env(), where = globalenv(), server = def@server,
                            nameSpaces = def@nameSpaces, verbose = FALSE)

_A_r_g_u_m_e_n_t_s:

operations: a list of the descriptions of the server's methods. Each
          method description  provides information about the parameters
          and the return value.

     def: the 'SOAPServerDescription-class' object.

    name: currently unused 

     env: an environment object.  This is used ?

   where: the location (usually in the search path) where new S4
          classes will  be defined to represent the complex return
          types.  This can be any value that is acceptable for the
          'where' argument of 'setClass', i.e.  an integer, a package
          name (package:name) or, explicitly, an environment.  

  server: an object which will be used as the server in the SOAP calls.
          This provides the user with a mechanism to provide an
          alternative server object such as one which contains a
          password or which already has a connection to the SOAP
          server, or controls the connection in different ways. 

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.

 verbose: a logical indicating whether information about the processing
          should be displayed on the console, as it occurs.

_A_u_t_h_o_r(_s):

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

_R_e_f_e_r_e_n_c_e_s:

     <URL: http://www.w3.org/TR/SOAP/> <URL:
     http://www.omegahat.org/SSOAP>, <URL:
     http://www.omegahat.org/bugs>.

_S_e_e _A_l_s_o:

     'processWSDL'

_E_x_a_m_p_l_e_s:

      kegg = processWSDL("http://soap.genome.jp/KEGG.wsdl")
        # note that we force the use of the 1.1 name spaces to get arrays
        # handled correctly on the server side.
      iface = genSOAPClientInterface(def = kegg, nameSpaces = "1.1")

      tmp = processWSDL(system.file("examples", "KEGG.wsdl", package = "SSOAP"))
      ff = genSOAPClientInterface(tmp@operations[[1]], def = tmp, tmp@name, verbose=FALSE)

      as.character.Definition = function(x)  structure(x[["definition"]], names = x[["entry_id"]])
      as.character.list = function(x) sapply(x, as.character)

      o = ff@functions$list_organisms()

      as.character.list(o)

