B OracleAS Web Services Client Schema

This appendix describes the oracle-webservices-client.xml file. This configuration file can be used to pass Oracle specific deployment and run-time information to a Web service client. It works in conjunction with the Oracle proprietary deployment descriptors orion-web.xml, orion-application-client.xml, and orion-ejb-jar.xml.

The configuration elements in this file are defined by the oracle-webservices-client-10_0.xsd schema file. This file can be found in the oc4j-schemas.jar file.

OC4J_HOME\j2ee\home\lib\oc4j-schemas.jar

OC4J_HOME represents the directory where you installed Oracle Containers for J2EE (OC4J).

The information in a oracle-webservices-client.xml file can be assembled into a Web service client by the ddFileName argument to the WebServicesAssembler genInterface or genProxy command. For more information on using the oracle-webservices-client-10_0.xsd schema file in specifying a management configuration for clients, see Chapter 3, "Managing Web Services".

Hierarchy of XML Elements in oracle-webservices-client

The following conceptual code fragment illustrates the hierarchy of elements defined by the oracle-webservices-client.xsd schema file.

<oracle-webservice-clients>
  <webservice-client>
     <service-qname>
     <port-info>
You can enter a client Web services management (security, reliability, and auditing) configuration here
     <type-mappings>
You can define a custom serializer to map between WSDL types and custom Java types here

Elements and Attributes of oracle-webservices-client

This section is an alphabetical dictionary of the elements defined by the oracle-webservices.client-10_0.xsd schema file. See the preceding section, "Hierarchy of XML Elements in oracle-webservices-client" if you are interested in the hierarchy.

<oracle-webservice-clients>

Parent element:  root element for a configuration that passes Oracle-specific information to a Web services client

Child element:  <webservice-client>

Required? Optional

This element can be used to specify an Oracle-specific configuration for Web service clients.

<port-info>

Parent element:  <webservice-client>

Child elements:  Can have <wsdl-port>, <service-endpoint-interface>, <stub-property>, <call-property>, <runtime>, <operations> subelements

Required? Optional

This element corresponds to a port in the WSDL; the <wsdl-port> subelement provides the mapping. You can use this element to pass port-specific information to a Web service client.

For examples of using a <port-info> element to pass a management configuration to a client, see "How to Pass a Management Configuration to a Client Programmatically".

This element is of type port-infoType which is defined in the service-ref-mapping-10_0.xsd schema. This file can be found in the oc4j-schemas.jar file.

<service-qname>

Parent element:  <webservice-client>

Child element:  None

Required? Optional

The value of this element maps the <webservice-client> configuration to a service in the WSDL definition.

The <service-qname> is a fully-qualified-nameType which consists of a namespaceURI and a localpart. The fully-qualified-nameType is defined in the service-ref-mapping-10_0.xsd. This file can be found in the oc4j-schemas.jar file.

<type-mappings>

Parent element:  <webservice-client>

Child element:  Can have one or more <type-mapping> subelements if there is a custom type mapping between a custom Java class and an XML type

Required? Optional

This element can be used to specify sequence of zero or more <type-mapping> elements, each of which describes a non-default Java-to-XML type mapping for the web service client. For example:

<oracle-webservice-clients>
   <webservice-client>
    ...
    <type-mappings>
      <type-mapping java-class="oracle.demo.custom_type.MyDate"         xml-type="xsd:dateTime">
        <serializer class="oracle.demo.custom_type.MyDateSerializer"/>
      </type-mapping>
    </type-mappings>
    ...

The <type-mappings> element is of type type-mappingsType, which consists of a Java to XML type mapping and a custom serializer. The type-mappingsType is defined in the oracle-webservices-types-10_0.xsd. This file can be found in the oc4j-schemas.jar file.

<webservice-client>

Parent element:  <oracle-webservice-clients>

Child element:  <port-info>, <service-qname>, <type-mappings>

Required? Optional

This element can be used to set an Oracle specific configuration for a Web service client.