THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
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 namespace 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 as well as the 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.
Spring uses a similar way to map systemIds to locations on the classpath (spring.schemas files), and that way validates your Spring configuration files. Validation can be disabled by setting system property 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 to =VALIDATION_NONE), but the default is to have validation enabled. This is very useful when you are configuring CXF and not very familiar with CXF's configuration schemas or with Spring itself.What you need to know when writing a valid Spring configuration file is the system IDs for the schema file(s) defining the types that are using in the configuration file.
The table below contains includes the system IDs URIs for the CXF schema files configuration schemas that you may need to specify in your Spring configuration file, along with their target namespace.
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 these files, as they should be available at their URI. In practice however, only the standard schemas are actually available that way, but CXF aims at publishing its schemas in the future. In the meantime, 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 schemas.the original version of the schema in the trunk.
Configuration Schemas common to both Spring and Blueprint
URI |
|---|
Target Namespace | Classpath Resource | Module |
|---|
/schemas/configuration/http-conf.xsd | cxf-rt-transports-http | ||
/schemas/configuration/http-jetty.xsd | cxf-rt-transports-http-jetty | ||
/ |
schemas/ |
configuration/ |
jms.xsd |
}}cxf-rt-transports-jms | |
/org/apache/cxf/binding/soap/spring/schemas/configuration/security.xsd | cxf-core | ||
/schemas/configuration/soap.xsd | cxf-rt-bindings-soap | ||
/schemas/ws-addr-conf.xsd | cxf-rt-ws-addr | ||
/schemas/configuration/ |
wsrm-manager- |
types.xsd | cxf-rt- |
ws- |
rm |
/schemas/configuration/ |
wsrm- |
manager.xsd | cxf-rt- |
ws-rm | |
/schemas/clustering.xsd | cxf-rt-features-clustering |
* 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 |
|---|---|---|---|
/schemas |
/core.xsd | cxf-core | ||
/schemas/jaxrs.xsd | cxf-rt- |
frontend-jaxrs | ||
/schemas |
/jaxws.xsd | cxf-rt-frontend-jaxws | |
/ |
/schemas/configuration/jmsschemas/policy.xsd | cxf-rt-ws-policy | ||
/schemas/simple.xsd | cxf-rt- |
frontend-simple |
Blueprint-only Schemas
URI | Target Namespace | Classpath Resource | Module |
|---|---|---|---|
/schemas/blueprint/core.xsd | cxf-core | ||
/schemas/ |
blueprint/ |
jaxrs.xsd | cxf- |
rt-frontend- |
jaxrs |
/schemas/blueprint/jaxws.xsd | cxf-rt- |
frontend-jaxws | |||
/schemas/blueprint/policy.xsd | cxf-rt-ws |
-policy |
/schemas/blueprint/simple.xsd | cxf-rt-frontend-simple |
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!
| Code Block | ||||
|---|---|---|---|---|
| ||||
<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 |
|---|---|---|---|
/schemas/configuration/cxf-beans.xsd | cxf-core |
/schemas/wsdl/http-conf.xsd | cxf-rt-transports-http | |
/schemas/wsdl/jms.xsd | cxf-rt-transports-jms | ||
/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 |
/schemas/wsdl/addressing.xsd | cxf-core | ||
/schemas/ws-policy-200409 |
.xsd | cxf-rt-ws-rm |
/schemas/configuration/ |
wsrm-policy.xsd | cxf-rt-ws-rm |
...
/schemas/wsdl/wsdl.xsd | cxf-core | ||
/schemas/wsdl/http.xsd | cxf-core | ||
/schemas/xml.xsd | cxf-rt-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):
...