![]() |
![]() |
![]() |
![]() |
![]() |
• The SALT Deployment File (SALTDEPLOY) is an XML-based file used to define SALT GWWS server deployment information on a per Tuxedo machine basis. SALTDEPLOY does the following:
• specifies how many GWWS servers are deployed on a Tuxedo machineSALTDEPLOY also provides a system section to configure global resources (for example certificates, plug-in load libraries, and so on).Figure B‑1 shows a graphical representation of the SALT SALTDEPLOY file format.Figure B‑1 SALT Deployment File FormatAn XML Schema is associated with a SALT SALTDEPLOY file. The XML Schema file that describes the SALT SALTDEPLOY file format is located in the following directory: $TUXDIR/udataobj/salt/saltdep.xsd.Listing B‑1 shows a sample SALT SALTDEPLOY File.Listing B‑1 SALT SALTDEPLOY File ExampleSALTDEPLOYF format elements and their attributes are listed and described in the following section.The SALTDEPLOY file root element.Three sections must be defined within the <Deployment> element:
• <WSDF> elements
• <WSGateway> element
• <System> element.Specifies the WSDF to be imported in the SALTDEPLOY file. Multiple WSDF can be imported at the same time. Each WSDF file can only be imported once. Multiple WSDF with the same WSDF name cannot be imported in the same SALTDEPLOY file.
Specifies the WSDF local file path. Top element that encapsulates all GWWS instance definitions.Specifies a single GWWS instance.
Specifies inbound WSBinding objects for the GWWS server. Each inbound WSBinding object is specified using the <Binding> sub element.Specifies a list of services accessible in REST mode. All Oracle Tuxedo service names specified in this element are callable using HTTP or REST mechanisms. Any URL specifying a service not present on this list results in a 404 error for the caller. Any URL specifying a service present on this list (for which an Oracle Tuxedo service is not advertised), results in a 451 error for the caller.This element contains two attributes specifying http or https (for SSL), HTTP/REST listening endpoints.Only one <Network> element is allowed per GWWS instance.The http and https elements are optional, but at least one must be specified.The http and https attributes are constructed as follows:<host>: The name or IP address of the HTTP/REST listening endpoint.<port>: The port value of the HTTP/REST listening endpoint.All HTTP/REST requests are performed by the same <host>:<port> combination (i.e., it is not possible to use more than one such combination per gateway, per protocol (http and https).
HTTP host and port listening endpoint for REST requests. Format is a string containing a <host>:<port> pair corresponding to:<host> = name or IP address of the HTTP/REST listening endpoint.<port> = port value of the HTTP/REST listening endpoint. Specifies a single service callable using HTTP/REST mechanisms. The actual Oracle Tuxedo service called is further qualified by an HTTP method as specified using the <Method> element.
Note: This is not the actual Oracle Tuxedo service configured using the <Method> element.
Method identifier, among GET, PUT, POST or DELETE. Any other value results in a configuration error. Reference to a metadata repository entry. This is used to associate interface data with an HTTP/REST service and method. One use is for the configuration tool to generate automatic test code based on service metadata (interface). Specifies outbound WSBinding objects for the GWWS server. Each outbound WSBinding object is specified using the <Binding> sub element.
“<WSDF_name>:<WSBinding_id>”
For more information, see TMUSEIPV6 in the TUXENV(5) environment variable listing found in the Tuxedo 10g R3 Reference Guide, Section 5 - File Formats, Data Descriptions, MIBs, and System Processes Reference.
Select WS-Addressing on-the-wire version to use 200408 for the "submission" version, and 200508 for version 1. The <WSAddressing> sub element <Endpoint> must be specified for the listen endpoint address if this element is present.
"http(s)://<host>:<port>/<context_path>"
One attribute "id" describes the name of the transaction log inside a Transaction file. This is required if WS-TX transaction support is required.One attribute "address" describes the WS-AT protocol end point.One attribute "value" describes the maximum number of concurrent WS-TX transactions allowed. This is bounded by Oracle Tuxedo MAXGTT.
Value: String type containing a list of proxy server URLs.For example: proxy.server1.com,10.123.1.1:1080. Specifies one GWWS property.
Specifies the property name. Table B‑14 lists all the GWWS server properties.
Enables the GWWS server to deny the HTTP requests when the content length is larger than the property setting. If not specified, the GWWS server does not check for it. The string value can be one of the following three formats:
2.
3. The equivalent byte size value must be in [1 byte, 1G byte] range. Specifies the maximum thread pool size for the GWWS server.
Note: This value defines the maximum possible threads that may be spawned in the GWWS server. When the GWWS server is running, the actual spawned threads may be less than this value. The valid value is in [1, 1024]. The valid value is in [1, 65535].Default value: 300 The valid value is [1-255]. Default value: false Default value: false Mutually exclusive with enableMultiEncoding.This property must not be used with multi-byte encodings and in conjunction with MBSTRING buffers or fields; otherwise, a runtime error is thrown. Specifies global certificate information using sub elements <PrivateKey>, <VerifyClient>, <TrustedCert> and <CertPath>.
Note: GWWS converts certificate to wallet when SEC_PRINCIPAL_PASSWORD is set. If only X509 certicates are used under HTTP, then there is no conversion.To configure server identity certificates (SALT deploy configuration file <PrivateKey> element ), it is required that the root certificate authority be present in the SSL configuration file. Proper configuration is:When using the legacy security credentials format, specifies the PEM format private key file. The key file path is specified as the text value for this element. The server certificate is also stored in this private key file. The value of this element may contain a maximum of 256 characters (excluding the terminating NULL character).With either security credential format, the password for the Oracle Wallet or the GWWS private key file is specifed in the TUXCONFIG file using the SEC_PRINCIPAL_PASSVAR="environment_variable_name" parameter. The TUXCONFIG file must also set the SEC_PRINCIPAL_NAME="any_non-null_string(not_used)" parameter so that SEC_PRINCIPAL_PASSVAR will be properly processed in the configuration file.This element is mandatory if the parent <Certificate> element is configured.Specifies if Web service clients are required to send a certificate via HTTP over SSL connections. The valid element values are "true" and "false".
Note: If <VerifyClient> is set to “true”, or if WS-Addressing is used with SSL, trusted certificates must be stored in the directory setting with this element.Specifies the global plug-in load library information. Each <Interface> sub element specifies one plug-in library to be loaded.
Mandatory. Specifies a local shared library file path. This attribute value may contain a maximum of 256 characters (excluding the terminating NULL character). Optional. Specifies a particular string value that is passed to the library when initialized by the GWWS server at boot time. This attribute value may contain a maximum of 256 characters (excluding the terminating NULL character).
Note: For more information about how to develop a SALT plug-in interface, see “Using SALT Plug-ins” in the SALT Programming Web Services.