RodlToWsdl

Overview

The RodlToWsdl class converts RODL resources into WSDL schemas.

It can be used in the RO Server module for providing WSDL documents to soap clients so they can operate with the server using SOAP messaging.

The RodlToWsdl class allows users to define some additional conversion options, i.e. if the result WSDL document should contain the Client-ID value in the header, what target Namespace and XSD it should use, if it should store values as literals, etc. See the Properties section for more details.

Location

 

constructor

 

constructor(library: RodlLibrary)

 

RodlToWsdl(RodlLibrary library)

 

Sub New (library As RodlLibrary)

Parameters:

  • library:

Convert

Converts a RODL service definition to a WSDL SOAP services definition.

 

method Convert(destination: Stream; targetService: RodlService)

 

void Convert(Stream destination, RodlService targetService)

 

Sub Convert(destination As Stream, targetService As RodlService)

Parameters:

  • destination: Stream that will contain the resulting WSDL
  • targetService:

ExternalTypesAsReferences

Gets or sets a flag indicating whether a "contract-first" WSDL should be created where type definitions are moved to separate XSD files and links to them are added to the resulting WSDL instead of embedding type definitions into the resulting WSDL.

 

property ExternalTypesAsReferences: Boolean read write;

 

Boolean ExternalTypesAsReferences { get; set; }

 

Property ExternalTypesAsReferences As Boolean

Location

Gets or sets the base part of the "location" tag of the SOAP Address.

This value is used in generated tags in the following way: "%Location%?service=%your_service_name%"

 

property Location: String read write;

 

String Location { get; set; }

 

Property Location As String

ShowClientId

Gets or sets a flag indicating whether a client ID should become part of the resulting WSDL as a SOAP header.

 

property ShowClientId: Boolean read write;

 

Boolean ShowClientId { get; set; }

 

Property ShowClientId As Boolean

TargetNamespace

Gets or sets the namespace to be used for WSDL services.

The default value is http://tempuri.org/.

 

property TargetNamespace: String read write;

 

String TargetNamespace { get; set; }

 

Property TargetNamespace As String

TargetXsd

Gets or sets the URL of the external XSD file. Type definitions for RODL types imported from this XSD (as defined by their ImportedFromUrl attribute) will be excluded from generated XSD's or WSDL's.

 

property TargetXsd: String read write;

 

String TargetXsd { get; set; }

 

Property TargetXsd As String

UseDocument

Gets or sets a flag indicating whether a Document SOAP mode is used.

See more details on the SOAP Message Options page.

 

property UseDocument: Boolean read write;

 

Boolean UseDocument { get; set; }

 

Property UseDocument As Boolean

UseLiteral

Gets or sets a flag indicating whether a Literal SOAP mode is used.

See more details on the SOAP Message Options page.

 

property UseLiteral: Boolean read write;

 

Boolean UseLiteral { get; set; }

 

Property UseLiteral As Boolean

 

ExternalTypesAsReferences

Gets or sets a flag indicating whether a "contract-first" WSDL should be created where type definitions are moved to separate XSD files and links to them are added to the resulting WSDL instead of embedding type definitions into the resulting WSDL.

 

property ExternalTypesAsReferences: Boolean read write;

 

Boolean ExternalTypesAsReferences { get; set; }

 

Property ExternalTypesAsReferences As Boolean

Location

Gets or sets the base part of the "location" tag of the SOAP Address.

This value is used in generated tags in the following way: "%Location%?service=%your_service_name%"

 

property Location: String read write;

 

String Location { get; set; }

 

Property Location As String

ShowClientId

Gets or sets a flag indicating whether a client ID should become part of the resulting WSDL as a SOAP header.

 

property ShowClientId: Boolean read write;

 

Boolean ShowClientId { get; set; }

 

Property ShowClientId As Boolean

TargetNamespace

Gets or sets the namespace to be used for WSDL services.

The default value is http://tempuri.org/.

 

property TargetNamespace: String read write;

 

String TargetNamespace { get; set; }

 

Property TargetNamespace As String

TargetXsd

Gets or sets the URL of the external XSD file. Type definitions for RODL types imported from this XSD (as defined by their ImportedFromUrl attribute) will be excluded from generated XSD's or WSDL's.

 

property TargetXsd: String read write;

 

String TargetXsd { get; set; }

 

Property TargetXsd As String

UseDocument

Gets or sets a flag indicating whether a Document SOAP mode is used.

See more details on the SOAP Message Options page.

 

property UseDocument: Boolean read write;

 

Boolean UseDocument { get; set; }

 

Property UseDocument As Boolean

UseLiteral

Gets or sets a flag indicating whether a Literal SOAP mode is used.

See more details on the SOAP Message Options page.

 

property UseLiteral: Boolean read write;

 

Boolean UseLiteral { get; set; }

 

Property UseLiteral As Boolean

 

constructor

 

constructor(library: RodlLibrary)

 

RodlToWsdl(RodlLibrary library)

 

Sub New (library As RodlLibrary)

Parameters:

  • library:

Convert

Converts a RODL service definition to a WSDL SOAP services definition.

 

method Convert(destination: Stream; targetService: RodlService)

 

void Convert(Stream destination, RodlService targetService)

 

Sub Convert(destination As Stream, targetService As RodlService)

Parameters:

  • destination: Stream that will contain the resulting WSDL
  • targetService:

See Also