wsdl example.pdf
TRANSCRIPT
(c) eaDocX Ltd 2011
Page 1
WSDL Example
Test & Sample Documents
WSDL Example
This document uses content from the EAExample model, which is (c) Sparx Systems.
It shows how WSDL definitions, stored in an EA model, can be printed using eaDocX.
Most of the useful tagged values have been included, but there are a large number of tagged
values defined for WSDL elements, so you may need to add to this list.
Section: docInfo
Generated on
At Author Repository
21/03/2013 10:12 eaDocX Development
C:\Users\Ian\Google Drive\1 - Marketing\Sample documents and models\Domain-specific examples\EAExample.eap
End
(c) eaDocX Ltd 2011
Page 2
WSDL Example
(c) eaDocX Ltd 2011
Page 3
WSDL Example
Section: Section1
1 WSDL
Figure 1 : WSDL
1.1 WSDLPackage1
Figure 2 : Overview
pkg WSDL
«WSDLnamespace»
WSDLPackage1
+ SampleWSDLFile1
+ Types
+ Messages
+ PortTypes
+ Bindings
+ Services
«WSDLnamespace»
WSDLPackage2
+ SampleWSDLFile2
+ Messages
+ PortTypes
+ Bindings
+ Services
«XSDschema»
Schema
+ InPrm
+ OtPrm
«WSDLnamespace»
WSDLPackage3
+ SampleWSDLFile3
+ Types
+ Messages
+ PortTypes
+ Bindings
+ Services
class Ov erv iew
«WSDL»
SampleWSDLFile1
SampleService
TODO: Add your WSDL Types, Messages, Portypes, Binding and Services by dragging elements from the WSDL
toolbox. Double-click the packages below to navigate between the relevant diagrams.
You can automatically generate WSDLs from this model. Drag WSDL components from the toolbox onto this
diagram and specify which services should be exposed.
Generate this WSDL by selecting
the WSDLnamespace in the Project
View and using the menu option
Project | Web Services | Generate
WSDL
«XSDschema»
Types
+ InputParameters
+ OutputParameters
Messages
+ SampleInput
+ SampleOutput
PortTypes
+ SamplePortTypeHTTP
+ SamplePortTypeSOAP
Bindings
+ SampleBindingHTTP
+ SampleBindingSOAP
Serv ices
+ SampleService
(c) eaDocX Ltd 2011
Page 4
WSDL Example
1.1.1 WSDL - SampleWSDLFile1
1.1.1.1 Children
Name Description
SampleService
1.1.2 Types
Figure 3 : Types
1.1.2.1 XSDcomplexType - InputParameters
1.1.2.2 XSDcomplexType - OutputParameters
1.1.2.2.1 Attributes
Attributes Details
externalElement
class Types
«XSDcomplexType»
OutputParameters
«XSDelement»
+ externalElement :OtPrm
«XSDcomplexType»
InputParameters
TODO : Drag Elements, Simple Types and Complex Types from
the Schema toolbox to add types for your WSDL
externalElement is referring to the XSDsimpleType
OtPrm in the package Schema
(c) eaDocX Ltd 2011
Page 5
WSDL Example
1.1.3 Messages
Figure 4 : Messages
WSDL Message Description Attributes
SampleOutput ResponseParam
SampleInput InputParam
1.1.4 PortTypes
Figure 5 : PortTypes
WSDL Port Type: SamplePortTypeSOAP
class Messages
«WSDLmessage»
SampleInput
+ InputParam :InputParameters
«WSDLmessage»
SampleOutput
+ ResponseParam :OutputParameters
TODO : Create your WSDL messages by dragging
Message and Message Parts from the WSDL toolbox.
Select types for the Message Parts from those defined
in the WSDLTypes package
class PortTypes
«WSDLportType»
SamplePortTypeSOAP
+ GetSampleSOAP(SampleInput, SampleOutput*)
«WSDLportType»
SamplePortTypeHTTP
+ GetSampleHTTP(SampleInput, SampleOutput*)
TODO : Create additional PortTypes by dragging PortType
elements from the WSDL toolbox. PortTypes must be defined for
use by the Bindings package.
(c) eaDocX Ltd 2011
Page 6
WSDL Example
1.1.4.1.1 Methods
Methods Details Parameter Summary
GetSampleSOAP
(in) Request: SampleInput
(out) Response: SampleOutput
WSDL Port Type: SamplePortTypeHTTP
1.1.4.1.2 Methods
Methods Details Parameter Summary
GetSampleHTTP
(in) Request: SampleInput
(out) Response: SampleOutput
1.1.5 Bindings
Figure 6 : Bindings
class Bindings
«WSDLbinding»
SampleBindingHTTP
+ GetSampleHTTP(SampleInput, SampleOutput*)
tags
protocol = http
verb = GET
«WSDLportType»
PortTypes::SamplePortTypeHTTP
+ GetSampleHTTP(SampleInput, SampleOutput*)
«WSDLportType»
PortTypes::SamplePortTypeSOAP
+ GetSampleSOAP(SampleInput, SampleOutput*)
«WSDLbinding»
SampleBindingSOAP
+ GetSampleSOAP(SampleInput, SampleOutput*)
tags
protocol = soap
style = document
transport = http://schemas.xmlsoap.org/soap/http
TODO : Create additional Bindings by dragging Binding elements from
the WSDL toolbox. Each Binding must realize one of the PortType
interfaces defined in the PortTypes package.
SamplePortTypeHTTP SamplePortTypeSOAP
(c) eaDocX Ltd 2011
Page 7
WSDL Example
1.1.5.1 Class - WSDLbinding - SampleBindingSOAP
1.1.5.1.1 Methods
Methods Details Parameter Summary
GetSampleSOAP
(in) Request: SampleInput
(out) Response: SampleOutput
Protocol: soap
Style: document
Transport: http://schemas.xmlsoap.org/soap/http
1.1.5.2 Class - WSDLbinding - SampleBindingHTTP
1.1.5.2.1 Methods
Methods Details Parameter Summary
GetSampleHTTP
(in) Request: SampleInput
(out) Response: SampleOutput
Protocol: http
Verb: GET
(c) eaDocX Ltd 2011
Page 8
WSDL Example
1.1.6 Services
Figure 7 : SampleService
WDSL Service Description
SampleService
1.2 WSDLPackage2
class SampleServ ice
«WSDLser...
SampleServ ice
«WSDLbinding»
Bindings::SampleBindingSOAP
+ GetSampleSOAP(SampleInput, SampleOutput*)
«WSDLbinding»
Bindings::SampleBindingHTTP
+ GetSampleHTTP(SampleInput, SampleOutput*)
TODO : Create additional services by dragging Service elements from the WSDL toolbox. You may
specify Service Ports for each Binding defined in the Bindings package.
SamplePortSOAPSamplePortHTTP
class Ov erv iew
«WSDL»
SampleWSDLFile2
SampleService
TODO: Add your WSDL Types, Messages, Portypes, Binding and Services by dragging elements from the WSDL
toolbox. Double-click the packages below to navigate between the relevant diagrams.
You can automatically generate WSDLs from this model. Drag WSDL components from the toolbox onto this
diagram and specify which services should be exposed.
Generate this WSDL by selecting
the WSDLnamespace in the Project
View and using the menu option
Project | Web Services | Generate
WSDL
Messages
+ SampleInput
+ SampleOutput
PortTypes
+ SamplePortTypeHTTP
+ SamplePortTypeSOAP
Bindings
+ SampleBindingHTTP
+ SampleBindingSOAP
Serv ices
+ SampleService
(c) eaDocX Ltd 2011
Page 9
WSDL Example
Figure 8 : Overview
1.2.1 WSDL - SampleWSDLFile2
1.2.1.1 Children
Name Description
SampleService
1.2.2 Messages
Figure 9 : Messages
WSDL Message Description Attributes
SampleInput InputParam
SampleOutput ResponseParam
class Messages
«WSDLmessage»
SampleInput
+ InputParam :InPrm
«WSDLmessage»
SampleOutput
+ ResponseParam :OtPrm
TODO : Create your WSDL messages by dragging
Message and Message Parts from the WSDL toolbox.
Select types for the Message Parts from those defined
in the WSDLTypes package
The WSDL Message Part InputParam is
referring to the XSDsimpleType InPrm in
the package Schema
The WSDL Message Part ResponseParam is
referring to the XSDsimpleType OtPrm in the
package Schema
(c) eaDocX Ltd 2011
Page 10
WSDL Example
1.2.3 PortTypes
Figure 10 : PortTypes
WSDL Port Type: SamplePortTypeSOAP
1.2.3.1.1 Methods
Methods Details Parameter Summary
GetSampleSOAP
(in) Request: SampleInput
(out) Response: SampleOutput
WSDL Port Type: SamplePortTypeHTTP
1.2.3.1.2 Methods
Methods Details Parameter Summary
GetSampleHTTP
(in) Request: SampleInput
(out) Response: SampleOutput
class PortTypes
«WSDLportType»
SamplePortTypeSOAP
+ GetSampleSOAP(SampleInput, SampleOutput*)
«WSDLportType»
SamplePortTypeHTTP
+ GetSampleHTTP(SampleInput, SampleOutput*)
TODO : Create additional PortTypes by dragging PortType
elements from the WSDL toolbox. PortTypes must be defined for
use by the Bindings package.
(c) eaDocX Ltd 2011
Page 11
WSDL Example
1.2.4 Bindings
Figure 11 : Bindings
1.2.4.1 Class - WSDLbinding - SampleBindingSOAP
1.2.4.1.1 Methods
Methods Details Parameter Summary
GetSampleSOAP
(in) Request: SampleInput
(out) Response: SampleOutput
Protocol: soap
Style: document
Transport: http://schemas.xmlsoap.org/soap/http
1.2.4.2 Class - WSDLbinding - SampleBindingHTTP
1.2.4.2.1 Methods
Methods Details Parameter Summary
class Bindings
«WSDLbinding»
SampleBindingHTTP
+ GetSampleHTTP(SampleInput, SampleOutput*)
tags
protocol = http
verb = GET
«WSDLportType»
PortTypes::SamplePortTypeHTTP
+ GetSampleHTTP(SampleInput, SampleOutput*)
«WSDLportType»
PortTypes::SamplePortTypeSOAP
+ GetSampleSOAP(SampleInput, SampleOutput*)
«WSDLbinding»
SampleBindingSOAP
+ GetSampleSOAP(SampleInput, SampleOutput*)
tags
protocol = soap
style = document
transport = http://schemas.xmlsoap.org/soap/http
TODO : Create additional Bindings by dragging Binding elements from
the WSDL toolbox. Each Binding must realize one of the PortType
interfaces defined in the PortTypes package.
SamplePortTypeHTTP SamplePortTypeSOAP
(c) eaDocX Ltd 2011
Page 12
WSDL Example
Methods Details Parameter Summary
GetSampleHTTP
(in) Request: SampleInput
(out) Response: SampleOutput
Protocol: http
Verb: GET
1.2.5 Services
Figure 12 : SampleService
WDSL Service Description
SampleService
class SampleServ ice
«WSDLser...
SampleServ ice
«WSDLbinding»
Bindings::SampleBindingSOAP
+ GetSampleSOAP(SampleInput, SampleOutput*)
«WSDLbinding»
Bindings::SampleBindingHTTP
+ GetSampleHTTP(SampleInput, SampleOutput*)
TODO : Create additional services by dragging Service elements from the WSDL toolbox. You may
specify Service Ports for each Binding defined in the Bindings package.
SamplePortSOAPSamplePortHTTP
(c) eaDocX Ltd 2011
Page 13
WSDL Example
1.3 WSDLPackage3
Figure 13 : Overview
1.3.1 WSDL - SampleWSDLFile3
1.3.1.1 Children
Name Description
SampleService
1.3.2 Types
class Ov erv iew
«WSDL»
SampleWSDLFile3
SampleService
TODO: Add your WSDL Types, Messages, Portypes, Binding and Services by dragging elements from the WSDL
toolbox. Double-click the packages below to navigate between the relevant diagrams.
You can automatically generate WSDLs from this model. Drag WSDL components from the toolbox onto this
diagram and specify which services should be exposed.
Generate this WSDL by selecting
the WSDLnamespace in the Project
View and using the menu option
Project | Web Services | Generate
WSDL
«XSDschema»
Types
+ InputParameters
+ OutputParameters
Messages
+ SampleInput
+ SampleOutput
PortTypes
+ SamplePortTypeHTTP
+ SamplePortTypeSOAP
Bindings
+ SampleBindingHTTP
+ SampleBindingSOAP
Serv ices
+ SampleService
class Types
«XSDcomplex...
InputParameters
TODO : Drag Elements, Simple Types and Complex Types from
the Schema toolbox to add types for your WSDL
«XSDtopLevelElement»
OutputParameters
«XSDcomplex...
OutputParameters::
ComplexType1
(c) eaDocX Ltd 2011
Page 14
WSDL Example
Figure 14 : Types
1.3.2.1 XSDcomplexType - InputParameters
1.3.3 Messages
Figure 15 : Messages
WSDL Message Description Attributes
SampleInput InputParam
SampleOutput ResponseParam
class Messages
«WSDLmessage»
SampleInput
+ InputParam :InputParameters
«WSDLmessage»
SampleOutput
+ ResponseParam :OutputParameters
TODO : Create your WSDL messages by dragging
Message and Message Parts from the WSDL toolbox.
Select types for the Message Parts from those defined
in the WSDLTypes package
The WSDL Message Part ResponseParam is
referring to an XSDtopLevelElement class
OutputParameters in the Types package
The WSDL Message Part InputParam is referring
to an XSDcomplexType class InputParameters in
the Types package
(c) eaDocX Ltd 2011
Page 15
WSDL Example
1.3.4 PortTypes
Figure 16 : PortTypes
WSDL Port Type: SamplePortTypeSOAP
1.3.4.1.1 Methods
Methods Details Parameter Summary
GetSampleSOAP
(in) Request: SampleInput
(out) Response: SampleOutput
WSDL Port Type: SamplePortTypeHTTP
1.3.4.1.2 Methods
Methods Details Parameter Summary
GetSampleHTTP
(in) Request: SampleInput
(out) Response: SampleOutput
class PortTypes
«WSDLportType»
SamplePortTypeSOAP
+ GetSampleSOAP(SampleInput, SampleOutput*)
«WSDLportType»
SamplePortTypeHTTP
+ GetSampleHTTP(SampleInput, SampleOutput*)
TODO : Create additional PortTypes by dragging PortType
elements from the WSDL toolbox. PortTypes must be defined for
use by the Bindings package.
(c) eaDocX Ltd 2011
Page 16
WSDL Example
1.3.5 Bindings
Figure 17 : Bindings
1.3.5.1 Class - WSDLbinding - SampleBindingSOAP
1.3.5.1.1 Methods
Methods Details Parameter Summary
GetSampleSOAP
(in) Request: SampleInput
(out) Response: SampleOutput
Protocol: soap
Style: document
Transport: http://schemas.xmlsoap.org/soap/http
1.3.5.2 Class - WSDLbinding - SampleBindingHTTP
1.3.5.2.1 Methods
Methods Details Parameter Summary
class Bindings
«WSDLbinding»
SampleBindingHTTP
+ GetSampleHTTP(SampleInput, SampleOutput*)
tags
protocol = http
verb = GET
«WSDLportType»
PortTypes::SamplePortTypeHTTP
+ GetSampleHTTP(SampleInput, SampleOutput*)
«WSDLportType»
PortTypes::SamplePortTypeSOAP
+ GetSampleSOAP(SampleInput, SampleOutput*)
«WSDLbinding»
SampleBindingSOAP
+ GetSampleSOAP(SampleInput, SampleOutput*)
tags
protocol = soap
style = document
transport = http://schemas.xmlsoap.org/soap/http
TODO : Create additional Bindings by dragging Binding elements from
the WSDL toolbox. Each Binding must realize one of the PortType
interfaces defined in the PortTypes package.
SamplePortTypeHTTP SamplePortTypeSOAP
(c) eaDocX Ltd 2011
Page 17
WSDL Example
Methods Details Parameter Summary
GetSampleHTTP
(in) Request: SampleInput
(out) Response: SampleOutput
Protocol: http
Verb: GET
1.3.6 Services
Figure 18 : SampleService
WDSL Service Description
SampleService
1.4 Schema
class SampleServ ice
«WSDLser...
SampleServ ice
«WSDLbinding»
Bindings::SampleBindingSOAP
+ GetSampleSOAP(SampleInput, SampleOutput*)
«WSDLbinding»
Bindings::SampleBindingHTTP
+ GetSampleHTTP(SampleInput, SampleOutput*)
TODO : Create additional services by dragging Service elements from the WSDL toolbox. You may
specify Service Ports for each Binding defined in the Bindings package.
SamplePortSOAPSamplePortHTTP
class Schema
string
«XSDsimple...
InPrm
string
«XSDsimple...
OtPrm
(c) eaDocX Ltd 2011
Page 18
WSDL Example
Figure 19 : Schema
XD Simple Types Description
OtPrm
InPrm
End
Appendix A It contains the following Word styles:
2 Heading 1
2.1 Heading 2
2.1.1 Heading 3
2.1.1.1 Heading 4
2.1.1.1.1 Heading 5
2.1.1.1.1.1 Heading 6
2.1.1.1.1.1.1 Heading 7
Style: Normal
2.2 Styles for Inline Text
Style: GenNormal
Inline Normal
Inline Bullet
1. Inline Numbered
(c) eaDocX Ltd 2011
Page 19
WSDL Example
2.3 Styles for Tables
Table Heading Red, bold, 12 point
Table text
Table bullet No indent, no spacing above & below
1. Table List No indent, no spacing
2.4 Styles for Matrix Reports
Matrix Title Matrix Target Heading
Matrix Title
Matrix Source Heading
Matrix body V small
(c) eaDocX Ltd 2011
Page 20
WSDL Example