soapsuds(1)

💅 soapsuds — the manual, but make it make sense

okay bestie, quick vibe check: this is the manual page for soapsuds, living in the General Commands Manual section of your friendly neighborhood Unix system. It's Mono's Remoting Proxy Generator and it's lowkey iconic. Sit down, hydrate, let's go. 🫶

✨ NAME ✨

soapsuds — Mono's Remoting Proxy Generator

✨ SYNOPSIS ✨

soapsuds [options] [inputs] [outputs]

✨ DESCRIPTION ✨

soapsuds is that girl for generating WSDL documents and client proxies for remoting services. A WSDL document is literally just a description of the methods a service provides, plus XML schemas of every referenced data structure. And a client proxy? It's a class that offers the same methods as the service it represents, but it has no implementation — it's giving understudy energy, it just forwards calls to the remote service. 🎭

ngl, generated client proxies are not strictly necessary, because the runtime can automatically generate proxies from the original service types. The catch? That implies you'd have to distribute the service class to all your clients. 🙈 In some scenarios the better approach is to use soapsuds to generate a proxy class that has the same interface as the service, but without any implementation.

Here's the tea on how it works: soapsuds can generate a WSDL document from a set of types specified with the -types option, or it can extract the types from an assembly specified with -inputassemblyfile. In this last case, soapsuds will include schemas for all serializable classes in the WSDL document. ✨

Taking as input a WSDL document (or anything from which such a document can be generated), the tool can generate source code for the client proxy (using the -gc option), or it can directly generate an assembly that implements the proxy (with the -outputassemblyfile option). soapsuds will also generate fake serializable classes for all types defined in the schema. However — and this is the important part — beware that those classes will lack the semantics of the original classes, since only data structure is generated. 💀

🌸 INPUT SOURCES 🌸

The following sources are available, and bestie, only one can be specified:

• -urltoschema:url, -url:url — Url from which to retrieve the WSDL document.
• -types:type1,assembly[,serviceEndPoint][;type2,assembly[,serviceEndPoint]]... — Specifies types for which to generate a schema or proxy. If no service endpoint is provided, the one provided with the -serviceendpoint option is used.
• -inputassemblyfile:file, -ia:file — Assembly that contains the types to export.
• -inputschemafile:schena, -is:schema — Schema from which to generate proxy classes.

🦋 INPUT OPTIONS 🦋

The following options are available:

• -inputdirectory:directory, -id:directory — Directory where DLLs are located.
• -serviceendpoint:url, -se:url — Url of the service to be placed in the WSDL document.

🎀 OUTPUTS 🎀

The following output options are available — and yes, more than one can be specified, we love a multihyphenate:

• -outputassemblyfile:file, -oa:file — Generates the proxy code and compiles it into an assembly with the provided name.
• -outputschemafile:file, -os:file — Generates a WSDL document that represents the provided types.
• -generatecode, -gc — Generates proxy source code for the provided WSDL document or types.

💖 OUTPUT OPTIONS 💖

The following options are available:

• -outputdirectory:directory, -od:directory — Directory where generated files will be placed.
• -proxynamespace:namespace, -pn:namespace — Namespace of the generated proxy.
• -nowrappedproxy, -nowp — Do not generate a wrapped proxy.
• -wrappedproxy, -wp — Generate a wrapped proxy.
• -strongnamefile:file, -sn:file — Strong name file.

⭐ GENERAL OPTIONS ⭐

The following options are available:

• -nologo — Supress the startup logo.
• -u:username, -user:username — The user name to use when connecting to the server.
• -p:password, -password:password — The password to use when connecting to the server.
• -d:domain, -domain:domain — The domain to use when connecting to the server.
• -httpproxyname:name, -hpn:name — Name of the http proxy.
• -httpproxyport:port, -hpp:port — Port of the http proxy.

👑 AUTHORS 👑

Lluis Sanchez Gual (lluis@ximian.com) — absolute legend, we stan. 💜

🌈 LICENSE 🌈

wsdl is released under the terms of the GNU GPL.

🧚 SEE ALSO 🧚

wsdl(1), disco(1), mono(1), mcs(1)

fr fr, that's the whole page. no cap. go generate something cute. 💅

and that's a wrap on the soapsuds(1) page from the General Commands Manual — mwah, tysm for reading, ily, bye bestie! 🍓✨