Reference Guide

     Previous  Next    Open TOC in new window    View as PDF - New Window  Get Adobe Reader - New Window
Content starts here

Oracle SALT Web Service Definition File Reference

The following sections provide SALT Web Service Definition File (WSDF) reference information:

 


Overview

The Oracle SALT Web Service Definition File (WSDF) is an XML-based file used to define Oracle SALT Web service components (for example, Web Service Bindings, Web Service Operations, Web Service Policies, and so on). WSDF is a SALT specific representation of the Web Service Definition Language data model. There are two WSDF types:

For more information, see tmwsdlgen and wsdlcvt in the Oracle SALT Command Reference.

 


Oracle SALT WSDF Format

Figure A-1 shows a graphical representation of the WSDF format.

Figure A-1 SALT Web Service Definition File Format

SALT Web Service Definition File Format

 


XML Schema

An XML Schema is associated with the WSDF. The XML Schema file that describes the WSDF format is located in the following directory: $TUXDIR/udataobj/salt/wsdf.xsd.

 


Oracle SALT WSDF Examples

Listing A-1 and Listing A-2 show native and non-native WSDF examples.

Listing A-1 Native WSDF (Composed Manually)
<Definition name="bankapp" 
  xmlns=http://www.bea.com/Tuxedo/WSDF/2007 >
  <WSBinding id="bankapp_binding" >
    <Servicegroup id="bankapp">
      <Policy location="/home/user/rm.xml" />
      <Service name="inquiry" />
      <Service name="deposit" />
    </Servicegroup>
    <SOAP>
      <AccessingPoints>
        <Endpoint id="HTTP1" address="http://myhost:7001" />
        <Endpoint id="HTTPS1" address="https://myhost:7002/bankapp" />
      </AccessingPoints>
    </SOAP>
  </ WSBinding >
</Definition>
Listing A-2 Non-Native WSDF (Generated from an External WSDL Document)
<Definition name="myWebservice"
  wsdlNamespace="http://www.example.org/myWebservice"
  xmlns=http://www.bea.com/Tuxedo/WSDF/2007 >
  <WSBinding id="A_binding">
    <Servicegroup id="portType">
      <Service name="operation_1" soapAction="op1" />
      <Service name="operation_2" soapAction="op2" />
    </Servicegroup>
    <SOAP version="1.1" style="rpc" use="encoded">
      <AccessingPoints>
        <Endpoint id="example_http_port"
                  address="http://www.example.org/abc" />
        <Endpoint id="example_https_port"
                  address="https://www.example.org/abcssl" />
      </AccessingPoints>
    </SOAP>
  </WSBinding>
  <WSBinding id="B_binding">
    <Servicegroup id="portType">
      <Service name="operation_3" soapAction="op3" />
      <Service name="operation_4" soapAction="op4" />
    </Servicegroup>
    <SOAP version="1.2">
      <AccessingPoints>
        <Endpoint id="another_http_port"
                  address="http://www.example.org/def" />
      </AccessingPoints>
    </SOAP>
  </WSBinding>
</Definition>

 


Oracle SALT WSDF Element Descriptions

WSDF format elements and their attributes are listed and described in the following section.

<Definition>

The WSDF file root element.

Table A-1 <Definition> Attributes
Attribute
Description
Required
name
The WSDF name. This attribute value may contain a maximum of 30 characters (excluding the terminating NULL character).
Native WSDF: you must manually provide a distinct application name.
Non-native WSDF: this value is the same as the WSDL converter (wsdlcvt) command line input parameter “output_basename.
Yes
wsdlNamespace
The corresponding WSDL document target namespace for the WSDF.
Native WSDF: you can optionally specify a distinct URI string so that the generated WSDL can use this as the target namespace. If not specified, the default WSDL target namespace is as follows: "urn:<wsdf_name>.wsdl". For example, if the WSDF name is “simpapp”, then the default WSDL target namespace is “urn:simpapp.wsdl”.
Non-native WSDF: the value is the WSDL target namespace of the external WSDL document.
No

<WSBinding>

Defines concrete protocol binding information. Zero or more WSBinding objects can be specified in one WSDF file.

Native WSDF: you can set SOAP version, encoding style, several endpoints for Web Service Client connection through sub element <SOAP> and a set of Tuxedo services to be exposed for invocation through sub element <Servicegroup>.

Non-native WSDF: each SOAP binding object (i.e., wsdl:binding object with soap:binding extension) in the external WSDL document is translated into one WSBinding object.

Table A-2 <WSBinding> Attributes
Attribute
Description
Required
id
Identifies the WSBinding object. The value must be unique within the WSDF. This attribute value may contain a maximum of 78 characters (excluding the terminating NULL character).
Native WSDF: the value is specified by customers and is used as the wsdl:binding name in the generated WSDL document.
Non-native WSDF: the value is the wsdl:binding name defined in the external WSDL document.
Yes

<Servicegroup>

Defines a Servicegroup object for one WSBinding object. Each WSBinding object must have exactly one Servicegroup. The Servicegroup object is used to encapsulate a set of Tuxedo services.

<Service>

Specifies a service for the WSBinding object.

Native WSDF: each service is a Tuxedo service.

Non-native WSDF: each service represents a converted Tuxedo service from a wsdl:operation object defined in the external WSDL document.

Table A-4 <Service> Attributes
Attribute
Description
Required
name
Specifies the service name. This attribute value may contain a maximum of 255 characters (excluding the terminating NULL character).
Native WSDF: the service name value is used as the wsdl:operation name in the generated WSDL document.
Non-native WSDF: the service name is equal to the wsdl:operation name defined in the external WSDL document.
Yes
tuxedoRef
An optional attribute used to reference the service definition in the Tuxedo Service Metadata Repository.
If not specified, attribute "name" value is used as the reference value.
No
soapAction
Specifies the service soapAction attribute. This is a non-native WSDF attribute. It is used to save the soapAction setting for each wsdl:operation defined in the external WSDL document.

Note: Do not specify this attribute for a native WSDF.

No
namespace
Specifies service namespace attribute. This is a non-native WSDF attribute. It is used to save the namespace setting for each wsdl:operation defined in the external WSDL document.

Note: Do not specify this attribute for a native WSDF.

No

<Input>

Specifies Input message attributes for a particular service. This element is optional.

Table A-5 <Input> Attributes
Attribute
Description
Required
name
Specifies the service input message name attribute. This is a non-native WSDF attribute. It is used is used to save the name for the input wsdl:message defined in the external WSDL document.

Note: Do not specify this attribute for a native WSDF.

No
wsaAction
Specifies the service input message wsaAction attribute. This is a non-native WSDF attribute. It is used is used to save the wsaAction attribute of the input wsdl:message defined in the external WSDL document.

Note: Do not specify this attribute for a native WSDF.

No

<Output>

Specifies Output message attributes for a particular service. This element is optional.

Table A-6 <Output> Attributes
Attribute
Description
Required
name
Specifies the service output message name attribute. This is a non-native WSDF attribute. It is used to save the name for the output wsdl:message defined in the external WSDL document.

Note: Do not specify this attribute for a native WSDF.

No
wsaAction
Specifies the service output message name attribute. This is a non-native WSDF attribute. It is used to save the wsaAction attribute of the output wsdl:message defined in the external WSDL document.

Note: Do not specify this attribute for a native WSDF.

No

<Fault>

Specifies Fault message attributes for a particular service. This element is optional.

Table A-7 <Fault> Attributes
Attribute
Description
Required
name
Specifies the service fault message name attribute. This is a non-native WSDF attribute. It is used to save the name for the fault wsdl:message defined in the external WSDL document.

Note: Do not specify this attribute for a native WSDF.

No
wsaAction
Specifies the service fault message wsaAction attribute. This is a non-native WSDF attribute. It is used to save the wsaAction attribute of the fault wsdl:message defined in the external WSDL document.

Note: Do not specify this attribute for a native WSDF.

No

<Msghandler>

Specifies a customized message conversion handler. Optional for <Input>, <Output> and/or <Fault> elements of any service. The value of this element is the handler name, which may contain a maximum of 30 characters (excluding the terminating NULL character).

The GWWS server looks for the message conversion handler from all known message conversion plug-in shared libraries using the handler name.The message conversion handler allows you to develop customized Tuxedo buffer and SOAP message payload transformation functions to replace the default GWWS message conversions.

For more information, see “ Programming Message Conversion Plug-ins in the Oracle SALT Programming Web Services.

<Policy>

References one Web Service Policy file applied to one of the following two levels:

At most, 10 Web Service policies can be referenced for each object.

Table A-8 <Policy> Attributes
Attribute
Description
Required
location
Specifies the local file path for the referenced WS-Policy file. This attribute value may contain a maximum of 256 characters (excluding the terminating NULL character).
Specifically, Oracle SALT pre-defines WS-Policy template files for typical WS-* scenarios. These files can be found under the $TUXDIR/udataobj/salt/policy directory. You can reference these template files using the string format “salt:<template_file_name>”.
For example, if you want to reference SALT WS-SecurityPolicy 1.0 template file “wssp1.0-signbody.xml”, you should define the following XML snippet in the WSDF file:
<Policy location=”salt:wssp1.0-signbody.xml” />
Yes
use
Specifies if the WS-Policy file is applied to the input message, output message, fault message, or the combination of the three. If multiple messages are set, use a space as the delimiter.
For example, if you want to configure a WS-Policy file “mypolicy.xml” to be applied to “input” and “output” messages, you should define the following XML snippet in the WSDF file:
<Policy location=”mypolicy.xml” use=”input output”/>
Oracle SALT limits the applicable messages for each supported WS-Policy assertion.
For more information, see the following sections:
No

<Property>

Specifies SALT specific properties for each service object.

Table A-9 <Property> Attributes
Attribute
Description
Required
name
Specifies the property name. Table A-10 lists all the GWWS server properties.
Yes
value
Specifies the property value.
Yes

The following table lists all properties that can be specified for each service object.

Table A-10 <Property> Name List
Property
Description
Values
async_timeout
Outbound service: Specifies a time setting to wait for SOAP response.
Inbound service: No behavior impact.
(0-32767] (sec)
Default: 60 secs.
disableWSAddressing
Outbound service: Disables explicit Web Service Addressing requests with this property.
Inbound service: No behavior impact.
{True|False}
Default: False

<SOAP>

Specifies SOAP protocol information for the WSBinding object. SOAP version, message style accessing endpoints are specified in this element.

Table A-11 <SOAP> Attributes
Attribute
Description
Required
version
Specifies SOAP version for this WSBinding object. The valid values are “1.1” and “1.2”. If not specified, "1.1" is used.
No
style
Specifies SOAP message style for this WSBinding object. The valid values are “rpc” and “document”. If not specified, "document" is used.
No
use
Specifies SOAP message encoding style for this WSBinding object. The valid values are “encoded” and “literal”.
If not specified explicitly, this value is automatically selected according to “style” value. If “style” is “rpc”, then “encoded” is used; if “style” is “document”, then “literal” is used.
No

Note: In the current SALT release, only “rpc/encoded” and “document/literal” are supported.

<AccessingPoints>

Specifies the endpoint list for the WSBinding object. Each sub element <Endpoint> represents one particular endpoint.

There is no attribute for this element.

<Endpoint>

Specifies each accessing endpoint for the WSBinding object.

<Realm>

Specifies the HTTP Realm attribute of an HTTP and/or HTTP/S endpoint. If this element is configured for one endpoint, the GWWS tries to incorporate HTTP basic authentication information in the request messages when issuing outbound calls through this endpoint.

For more information, see “ Configuring Transport Level Security” in the Oracle SALT Administration Guide.

Note: This element only works for non-native (external) WSDF files.

  Back to Top       Previous  Next