Table of Contents Previous Next PDF


Oracle SALT Web Service Definition File Reference

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:
Native WSDF (Tuxedo generated)
A native WSDF is composed manually. You must define a set of Tuxedo services and how they are exposed as Web services in a native WSDF. The native WSDF is similar to the SALT 1.1 configuration file.
Note:
A native WSDF is the input file used by the SALT WSDL generator (tmwsdlgen).
Non-native WSDF (Externally generated)
A non-native WSDF is generated from an external WSDL file via the SALT WSDL converter (wsdlcvt). In most cases, you do not need to change the generated WSDF except for configuring advanced features.
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
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.
 
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.
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”.
<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.
 
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.
<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.
 
Native WSDF: the value is specified by customers and is used as the wsdl:portType name in the generated WSDL document.
Non-native WSDF: the value is the wsdl:portType name defined in the external WSDL document.
<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.
 
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.
If not specified, attribute "name" value is used as the reference value.
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.
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.
<Input>
Specifies Input message attributes for a particular service. This element is optional.
 
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.
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.
<Output>
Specifies Output message attributes for a particular service. This element is optional.
 
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.
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.
<Fault>
Specifies Fault message attributes for a particular service. This element is optional.
 
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.
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.
<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:
<Service> level
At most, 10 Web Service policies can be referenced for each object.
 
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:
Configuring Advanced Web Service Messaging Features” in the Oracle SALT Administration Guide
Configuring Message-Level Web Service Security” in the Oracle SALT Administration Guide
<Property>
Specifies SALT specific properties for each service object.
 
Specifies the property name. Table A‑10 lists all the GWWS server properties.
The following table lists all properties that can be specified for each service object.
 
Default: 60 secs.
<SOAP>
Specifies SOAP protocol information for the WSBinding object. SOAP version, message style accessing endpoints are specified in this element.
 
Specifies SOAP version for this WSBinding object. The valid values are “1.1” and “1.2”. If not specified, "1.1" is used.
Specifies SOAP message style for this WSBinding object. The valid values are “rpc” and “document”. If not specified, "document" is used.
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.
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.
 
"http(s)://<host>:<port>/<context_path>"
<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:

Copyright © 1994, 2017, Oracle and/or its affiliates. All rights reserved.