man/soapsuds.1

   1 .\"
   2 .\" soapsuds manual page.
   3 .\" (C) 2003 Novell, Inc.
   4 .\" Author:
   5 .\"   Lluis Sanchez Gual (lluis@ximian.com)
   6 .\"
   7 .TH soapsuds 1
   8 .SH NAME
   9 soapsuds \- Mono's Remoting Proxy Generator
  10 .SH SYNOPSIS
  11 .PP
  12 .B soapsuds
  13 [options] [inputs] [outputs]
  14 .SH DESCRIPTION
  15 .I soapsuds
  16 is a tool for generating WSDL documents and client proxies for remoting services.
  17 A WSDL document describes the methods that a service provides together with XML schemas
  18 of all referenced data structures. A client proxy is a class which offers the same methods
  19 as the service it represents, but provides no implementation, it just forwards calls to the
  20 remote service.
  21 .PP
  22 Generated client proxies are not strictly necessary, since the runtime can
  23 automatically generate proxies from the original service types. However, it implies the need
  24 of distributing the service class to all clients. In some scenarios a better approach is
  25 to use soapsuds to generate a proxy class which has the same interface as the service,
  26 but without any implementation.
  27 .PP
  28 .I soapsuds
  29 can generate a WSDL document from a set of types specified with the option
  30 .I -types
  31 or can extract the types from an assembly specified with
  32 .I -inputassemblyfile.
  33 In this last case, soapsuds will include schemas for all serializable classes in
  34 the WSDL document.
  35 .PP
  36 Taking as input a WSDL document (or anything from which such document can be generated)
  37 the tool can generate source code for the client proxy (using the
  38 .I -gc
  39 option) or it can directly generate an assembly that implements the proxy (with the
  40 .I -outputassemblyfile
  41 option). soapsuds will also generate fake serializable classes for all types defined
  42 in the schema. However, beware that those classes will lack the semantics of the
  43 original classes, since only data structure is generated.
  44 .PP
  45 .SH INPUT SOURCES
  46 The following sources are available (only one can be specified):
  47 .TP
  48 .I "-urltoschema:url" "-url:url"
  49 Url from which to retrieve the WSDL document.
  50 .TP
  51 .I "-types:type1,assembly[,serviceEndPoint][;type2,assembly[,serviceEndPoint]]..."
  52 Specifies types for which to generate a schema or proxy. If no service endpoint is
  53 provided, the one provided with the
  54 .I -serviceendpoint
  55 option is used.
  56 .TP
  57 .I "-inputassemblyfile:file", "-ia:file"
  58 Assembly that contains the types to export.
  59 .TP
  60 .I "-inputschemafile:schena", "-is:schema"
  61 Schema from which to generate proxy classes.
  62 .SH INPUT OPTIONS
  63 The following options are available:
  64 .TP
  65 .I "-inputdirectory:directory", "-id:directory"
  66 Directory where DLLs are located.
  67 .TP
  68 .I "-serviceendpoint:url", "-se:url"
  69 Url of the service to be placed in the WSDL document.
  70 .SH OUTPUTS
  71 The following output options are available (more than one can be specified):
  72 .TP
  73 .I "-outputassemblyfile:file", "-oa:file"
  74 Generates the proxy code and compiles it into an assembly with the provided name.
  75 .TP
  76 .I "-outputschemafile:file", "-os:file"
  77 Generates a WSDL document that represents the provided types.
  78 .TP
  79 .I "-generatecode", "-gc"
  80 Generates proxy source code for the provided WSDL document or types.
  81 .SH OUTPUT OPTIONS
  82 The following options are available:
  83 .TP
  84 .I "-outputdirectory:directory", "-od:directory"
  85 Directory where generated files will be placed.
  86 .TP
  87 .I "-proxynamespace:namespace", "-pn:namespace"
  88 Namespace of the generated proxy.
  89 .TP
  90 .I "-nowrappedproxy", "-nowp"
  91 Do not generate a wrapped proxy.
  92 .TP
  93 .I "-wrappedproxy", "-wp"
  94 Generate a wrapped proxy.
  95 .TP
  96 .I "-strongnamefile:file", "-sn:file"
  97 Strong name file.
  98 .SH GENERAL OPTIONS
  99 The following options are available:
 100 .TP
 101 .I "-nologo"
 102 Supress the startup logo.
 103 .TP
 104 .I "-u:username", "-user:username"
 105 The user name to use when connecting to the server.
 106 .TP
 107 .I "-p:password", "-password:password"
 108 The password to use when connecting to the server.
 109 .TP
 110 .I "-d:domain", "-domain:domain"
 111 The domain to use when connecting to the server.
 112 .TP
 113 .I "-httpproxyname:name", "-hpn:name"
 114 Name of the http proxy.
 115 .TP
 116 .I "-httpproxyport:port", "-hpp:port"
 117 Port of the http proxy.
 118 .PP
 119 .SH AUTHORS
 120 Lluis Sanchez Gual (lluis@ximian.com)
 121 .PP
 122 .SH LICENSE
 123 wsdl is released under the terms of the GNU GPL.
 124 .PP
 125 .SH SEE ALSO
 126 wsdl(1), disco(1), mono(1), mcs(1)