Use of Schemas and Namespaces

CXF uses XML schemas extensively in the runtime: Its core includes the JAXB mappings of standard schemas such as http://schemas.xmlsoap.org/wsdl/ and http://www.w3.org/2006/03/addressing/ws-addr.xsd. CXF also defines its own schemas for WSDL extensions such as the jms-address element in namespace http://cxf.apache.org/transports/jms, and schemas for both Spring and Blueprint (OSGi) configuration, for example the http://cxf.apache.org/jaxws and http://cxf.apache.org/blueprint/jaxws namespaces.

To avoid accessing resources over the network during a build, CXF maintains local copies of these schemas. Logically however, third party as well as CXF schemas are referred to by their public URIs in schemaLocation attributes and similar places. The CXF code generators use catalog files to map them to their actual location in the trunk, see the pom.xml file in the api module for an example.

Note if you're using Spring it will validate your Spring configuration files, using information in each JAR's META-INF/spring.schemas file (an example here). Validation is extremely helpful in diagnosing errors in CXF configurations, but it is also expensive at runtime. Once you have got your application working, you can disable validation by setting a system property: -Dorg.apache.spring.validation.mode=VALIDATION_NONE

The table below includes the URIs for the CXF configuration schemas that you need to specify in your Spring configuration file's schemaLocation attribute so that Spring's validating parser can validate the file. In theory you need not be concerned with the actual location of the files: Spring can normally detect their location from the classpath. And if you want to check the content of a schema file (in a binary distribution), you should be able to do so using its URI. You can also use the classpath location in the table below to find the original version of the schema in the trunk.

Configuration Schemas common to both Spring and Blueprint

* wsrm-manager.xsd does an "xsd:include" on wsrm-manager-types.xsd as they are in the same namespace. As such, the user just needs to reference wsrm-manager.xsd to use both.

Spring-only Schemas

URI

Target Namespace

Classpath Resource

Module

http://cxf.apache.org/schemas/core.xsd

http://cxf.apache.org/core

/schemas/core.xsd

cxf-core

http://cxf.apache.org/schemas/jaxrs.xsd

http://cxf.apache.org/jaxrs

/schemas/jaxrs.xsd

cxf-rt-frontend-jaxrs

http://cxf.apache.org/schemas/jaxws.xsd

http://cxf.apache.org/jaxws

/schemas/jaxws.xsd

cxf-rt-frontend-jaxws

http://cxf.apache.org/schemas/policy.xsd

http://cxf.apache.org/policy

/schemas/policy.xsd

cxf-rt-ws-policy

http://cxf.apache.org/schemas/simple.xsd

http://cxf.apache.org/simple

/schemas/simple.xsd

cxf-rt-frontend-simple

Blueprint-only Schemas

Example

The following is an example of a valid Spring configuration file. Using the table above, there is no magic involved in setting the correct value for the schemaLocation attribute!

<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:http-conf="http://cxf.apache.org/transports/http/configuration"
    xmlns:jaxws="http://cxf.apache.org/jaxws"
    xsi:schemaLocation="
http://cxf.apache.org/transports/http/configuration http://cxf.apache.org/schemas/configuration/http-conf.xsd
http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">

    <http-conf:conduit name="{http://cxf.apache.org/hello_world_soap_http}SoapPort.http-conduit">
        <http-conf:client DecoupledEndpoint="http://localhost:9999/decoupled_endpoint"/>
    </http-conf:conduit>

    <jaxws:client name="{http://cxf.apache.org/hello_world_soap_http}SoapPort" createdFromAPI="true">
        <jaxws:conduitSelector>
            <bean class="org.apache.cxf.endpoint.DeferredConduitSelector"/>
        </jaxws:conduitSelector>
    </jaxws:client>
</beans>

Other Schemas

The following schemas are imported by one or more of the schemas above, directly or indirectly. You may also find their classpath locations useful when you import or include any of the schemas below in your own schema, and want to know hpw you can access them locally.

URI

Target Namespace

Classpath Resource

Module

http://cxf.apache.org/schemas/configuration/cxf-beans.xsd

http://cxf.apache.org/configuration/beans

/schemas/configuration/cxf-beans.xsd

cxf-core

http://cxf.apache.org/schemas/wsdl/http-conf.xsd

http://cxf.apache.org/transports/http/configuration

/schemas/wsdl/http-conf.xsd

cxf-rt-transports-http

http://cxf.apache.org/schemas/wsdl/jms.xsd

http://cxf.apache.org/transports/jms

/schemas/wsdl/jms.xsd

cxf-rt-transports-jms

http://www.w3.org/2010/soapjms

http://www.w3.org/2010/soapjms

/schemas/wsdl/spec/jms-spec-wsdl.xsd

cxf-rt-transports-jms

http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd

http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd

/schemas/oasis-200401-wss-wssecurity-secext-1.0.xsd

cxf-rt-ws-policy

http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd

http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd

/schemas/oasis-200401-wss-wssecurity-utility-1.0.xsd

cxf-rt-ws-policy

http://schemas.xmlsoap.org/ws/2004/08/addressing

http://schemas.xmlsoap.org/ws/2004/08/addressing

/schemas/wsdl/addressing.xsd

cxf-core

http://schemas.xmlsoap.org/ws/2004/09/policy/ws-policy.xsd

http://schemas.xmlsoap.org/ws/2004/09/policy

/schemas/ws-policy-200409.xsd

cxf-rt-ws-rm

http://schemas.xmlsoap.org/ws/2005/02/rm/wsrm-policy.xsd

http://schemas.xmlsoap.org/ws/2005/02/rm/policy

/schemas/configuration/wsrm-policy.xsd

cxf-rt-ws-rm

http://schemas.xmlsoap.org/wsdl/

http://schemas.xmlsoap.org/wsdl/

/schemas/wsdl/wsdl.xsd

cxf-core

http://schemas.xmlsoap.org/wsdl/http/

http://schemas.xmlsoap.org/wsdl/http/

/schemas/wsdl/http.xsd

cxf-core

http://www.w3.org/2001/xml.xsd

http://www.w3.org/XML/1998/namespace

/schemas/xml.xsd

cxf-rt-ws-policy

http://www.w3.org/2006/07/ws-policy.xsd

http://www.w3.org/2006/07/ws-policy

/schemas/ws-policy-200607.xsd

cxf-rt-ws-policy

Note for Developers: If you define your own configuration schema, place it in the schemas subdirectory of the resources directory, then combine http://cxf.apache.org/ and the path of the schema relative to the resources directory to form the system ID, and make the latter known to Spring by adding a line similar to the following to the spring.schemas file in your module's META-INF directory (note the escaped : character):

http\://cxf.apache.org/schemas/wsdl/http-conf.xsd=schemas/wsdl/http-conf.xsd
  • No labels

0 Comments