Author: buildbot
Date: Wed May 10 15:47:41 2017
New Revision: 1012005
Log:
Production update by buildbot for cxf
Modified:
websites/production/cxf/content/cache/docs.pageCache
websites/production/cxf/content/docs/configuration.html
Modified: websites/production/cxf/content/cache/docs.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/cxf/content/docs/configuration.html
==============================================================================
--- websites/production/cxf/content/docs/configuration.html (original)
+++ websites/production/cxf/content/docs/configuration.html Wed May 10 15:47:41
2017
@@ -116,23 +116,8 @@ Apache CXF -- Configuration
<td height="100%">
<!-- Content -->
<div class="wiki-content">
-<div id="ConfluenceContent"><h1
id="Configuration-Configuration">Configuration</h1>
-
-<h2 id="Configuration-Subpages">Subpages</h2>
-<ul class="childpages-macro"><li><a shape="rect"
href="bus-configuration.html">Bus Configuration</a></li><li><a shape="rect"
href="featureslist.html">FeaturesList</a></li><li><a shape="rect"
href="jmx-management.html">JMX Management</a></li><li><a shape="rect"
href="wsaconfiguration.html">WSAConfiguration</a></li><li><a shape="rect"
href="wspconfiguration.html">WSPConfiguration</a></li><li><a shape="rect"
href="wsrmconfiguration.html">WSRMConfiguration</a></li></ul>
-
-<h2 id="Configuration-SupplyingaConfigurationfiletoCXF">Supplying a
Configuration file to CXF</h2>
-<p>CXF can discover XML configuration files which you have written. For both
web service clients and servers, the default location that CXF will look for a
configuration for is "/cxf.xml" on the class path. For example, when running
your application in a servlet container, this file is expected to be located in
a /WEB-INF/classes folder of your web application.</p>
-
-<p>If you wish to override this location, you can specify a command line
property: -Dcxf.config.file=some_other_config.xml. This custom configuration
file is also expected to be on the class path.</p>
-
-<p>To use a url as the configuration location, specify as follows:
-Dcxf.config.file.url=config_file_url.</p>
-
-
-<p>A CXF configuration file is really a <a shape="rect" class="external-link"
href="http://springframework.org"; rel="nofollow">Spring</a> configuration file,
so all configuration files will start with the following:</p>
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;">
-<beans xmlns="http://www.springframework.org/schema/beans";
+<div id="ConfluenceContent"><h1
id="Configuration-Configuration">Configuration</h1><h2
id="Configuration-Subpages">Subpages</h2><p></p><ul
class="childpages-macro"><li><a shape="rect" href="bus-configuration.html">Bus
Configuration</a></li><li><a shape="rect"
href="featureslist.html">FeaturesList</a></li><li><a shape="rect"
href="jmx-management.html">JMX Management</a></li><li><a shape="rect"
href="wsaconfiguration.html">WSAConfiguration</a></li><li><a shape="rect"
href="wspconfiguration.html">WSPConfiguration</a></li><li><a shape="rect"
href="wsrmconfiguration.html">WSRMConfiguration</a></li></ul><h2
id="Configuration-SupplyingaConfigurationfiletoCXF">Supplying a Configuration
file to CXF</h2><p>CXF can discover XML configuration files which you have
written. For both web service clients and servers, the default location that
CXF will look for a configuration for is "/cxf.xml" on the class path. For
example, when running your application in a servlet container, this file is
expecte
d to be located in a /WEB-INF/classes folder of your web application.</p><p>If
you wish to override this location, you can specify a command line property:
-Dcxf.config.file=some_other_config.xml. This custom configuration file is also
expected to be on the class path.</p><p>To use a url as the configuration
location, specify as follows: -Dcxf.config.file.url=config_file_url.</p><p>A
CXF configuration file is really a <a shape="rect" class="external-link"
href="http://springframework.org"; rel="nofollow">Spring</a> configuration file,
so all configuration files will start with the following:</p><div class="code
panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<pre class="brush: xml; gutter: false; theme: Default"
style="font-size:12px;"><beans
xmlns="http://www.springframework.org/schema/beans";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.0.xsd">
@@ -141,29 +126,15 @@ http://www.springframework.org/schema/be
</beans>
</pre>
-</div></div>
-
-<p>If you are new to Spring or do not desire to learn more about it, don't
worry, you won't have to. The only piece of Spring that you will see is the
<beans> element outlined above. Simply create this file, place it on your
classpath, and add the configuration for a component you wish to configure (see
below). Note starting with CXF 2.6.0, Maven users will need to add the
following dependency for the cxf.xml file to be read:</p>
-
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;">
-<dependency>
+</div></div><p>If you are new to Spring or do not desire to learn more about
it, don't worry, you won't have to. The only piece of Spring that you will see
is the <beans> element outlined above. Simply create this file, place it
on your classpath, and add the configuration for a component you wish to
configure (see below). Note starting with CXF 2.6.0, Maven users will need to
add the following dependency for the cxf.xml file to be read:</p><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
+<pre class="brush: xml; gutter: false; theme: Default"
style="font-size:12px;"><dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>3.0.6.RELEASE</version> (or most recent supported)
</dependency>
</pre>
-</div></div>
-
-<h2 id="Configuration-TypesofConfigurationfiles">Types of Configuration
files</h2>
-
-<h3 id="Configuration-Clientconfigurationfile">Client configuration file </h3>
-
-<p>Placing a cxf.xml file (or other-named file as configured above) in the
classpath of the Web Service Client can be used to configure client-specific
functionality. For example, the following client cxf.xml file turns off <a
shape="rect" class="external-link"
href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.4";
rel="nofollow">chunked transfer encoding</a> for a specific service in requests
and responses:</p>
-
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;">
-<beans xmlns="http://www.springframework.org/schema/beans";
+</div></div><h2 id="Configuration-TypesofConfigurationfiles">Types of
Configuration files</h2><h3 id="Configuration-Clientconfigurationfile">Client
configuration file</h3><p>Placing a cxf.xml file (or other-named file as
configured above) in the classpath of the Web Service Client can be used to
configure client-specific functionality. For example, the following client
cxf.xml file turns off <a shape="rect" class="external-link"
href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.4";
rel="nofollow">chunked transfer encoding</a> for a specific service in requests
and responses:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
+<pre class="brush: xml; gutter: false; theme: Default"
style="font-size:12px;"><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";
xsi:schemaLocation="http://cxf.apache.org/transports/http/configuration
@@ -177,34 +148,8 @@ http://www.springframework.org/schema/be
</http-conf:conduit>
</beans>
</pre>
-</div></div>
-
-<h3 id="Configuration-Serverconfigurationfiles">Server configuration files</h3>
-
-<p>Typically, the cxf.xml file in the classpath of the web service is intended
primarily for configuration of the CXF bus, the object used for the creation of
all services and endpoints. Endpoint configuration is primarily done either
via a WEB-INF/cxf-servlet.xml file or a Spring application context file
designated by the web application deployment descriptor (web.xml file). The
cxf-servlet.xml file is somewhat slower because it loads all possible CXF
modules for an endpoint; the Spring application context method is faster
because it allows you to specify which CXF modules are needed.</p>
-
-<p>For an example configuration via a cxf-servlet.xml file, our <a
shape="rect" class="external-link"
href="http://svn.apache.org/viewvc/cxf/trunk/systests/transports/src/test/java/org/apache/cxf/systest/servlet/";>system
tests</a> have a <a shape="rect" class="external-link"
href="http://svn.apache.org/viewvc/cxf/trunk/systests/transports/src/test/java/org/apache/cxf/systest/servlet/cxf-servlet.xml?view=markup";>cxf-servlet.xml
file</a> which is explicitly referenced in the init-param element in the <a
shape="rect" class="external-link"
href="http://svn.apache.org/viewvc/cxf/trunk/systests/transports/src/test/java/org/apache/cxf/systest/servlet/web-external.xml?view=markup";>web.xml</a>
deployment descriptor. (Note it is not necessary to use the
<strong>init-param</strong> element if you use the file name "cxf-servlet.xml";
this is the default name that CXF uses to look for such a file.)</p>
-
-<p>For an example of using a Spring application context file for endpoint
configuration, refer to our <a shape="rect" class="external-link"
href="http://svn.apache.org/viewvc/cxf/trunk/distribution/src/main/release/samples/java_first_spring_support/";>Java
First Spring Support</a> sample. You can see how the web.xml deployment
descriptor explicitly references the beans.xml application context file via a
<strong>context-param</strong> element (and ContextLoaderListener object); also
that the application context file manually imports the three cxf modules that
it needs.</p>
-
-<h1 id="Configuration-WhatcanIconfigureandhowdoIdoit?">What can I configure
and how do I do it?</h1>
-<p>If you want to change CXF's default behaviour, enable specific
functionality or fine tune a component's behaviour, you can in most cases do so
without writing a single line of code, simply by supplying a Spring
configuration file. <br clear="none">
-In some cases it also possible to achieve the same end by extending your wsdl
contract: you can add CXF specific extension elements to the wsdl:port element
and in that way fine tune the behaviour of the specified transport. Or you can
use WS-Policy to express the fact that your application uses WS-Addressing, for
example.</p>
-
-<p>Using Spring configuration files however is the most versatile way to
achieve a specific goal: you can use it to</p>
-
-<ol><li>Enable functionality via simple constructs called
features.</li><li>Set properties of runtime components by referring to these
runtime components using either plain Spring bean elements, or, more
conveniently, using CXF custom beans elements.</li><li>Modify the actual
composition of the runtime (change the way the runtime is wired up).</li></ol>
-
-
-<p>The following examples show the what the Spring configuration would look
like if you wanted to enable the logging of inbound and outbound messages and
faults.</p>
-
-<p><strong>Enabling message logging using plain Spring bean
elements</strong></p>
-
-<div class="confluence-information-macro
confluence-information-macro-note"><span class="aui-icon aui-icon-small
aui-iconfont-warning confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>Using this format is STRONGLY
discouraged as it ties your configuration with internal CXF class names (like
SpringBus). It is much better to use the cxf:bus element described
below</p></div></div>
-
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;">
-<beans xmlns="http://www.springframework.org/schema/beans";
+</div></div><h3 id="Configuration-Serverconfigurationfiles">Server
configuration files</h3><p>Typically, the cxf.xml file in the classpath of the
web service is intended primarily for configuration of the CXF bus, the object
used for the creation of all services and endpoints. Endpoint configuration is
primarily done either via a WEB-INF/cxf-servlet.xml file or a Spring
application context file designated by the web application deployment
descriptor (web.xml file). The cxf-servlet.xml file is somewhat slower because
it loads all possible CXF modules for an endpoint; the Spring application
context method is faster because it allows you to specify which CXF modules are
needed.</p><p>For an example configuration via a cxf-servlet.xml file, our <a
shape="rect" class="external-link"
href="http://svn.apache.org/viewvc/cxf/trunk/systests/transports/src/test/java/org/apache/cxf/systest/servlet/";>system
tests</a> have a <a shape="rect" class="external-link"
href="http://svn.apache.org/viewvc
/cxf/trunk/systests/transports/src/test/java/org/apache/cxf/systest/servlet/cxf-servlet.xml?view=markup">cxf-servlet.xml
file</a> which is explicitly referenced in the init-param element in the <a
shape="rect" class="external-link"
href="http://svn.apache.org/viewvc/cxf/trunk/systests/transports/src/test/java/org/apache/cxf/systest/servlet/web-external.xml?view=markup";>web.xml</a>
deployment descriptor. (Note it is not necessary to use the
<strong>init-param</strong> element if you use the file name "cxf-servlet.xml";
this is the default name that CXF uses to look for such a file.)</p><p>For an
example of using a Spring application context file for endpoint configuration,
refer to our <a shape="rect" class="external-link"
href="https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples/java_first_spring_support/";
rel="nofollow">Java First Spring Support</a> sample. You can see how the
web.xml deployment descriptor explicitly references the beans.xml application
context file via a <strong>context-param</strong> element (and
ContextLoaderListener object); also that the application context file manually
imports the three cxf modules that it needs.</p><h1
id="Configuration-WhatcanIconfigureandhowdoIdoit?">What can I configure and how
do I do it?</h1><p>If you want to change CXF's default behaviour, enable
specific functionality or fine tune a component's behaviour, you can in most
cases do so without writing a single line of code, simply by supplying a Spring
configuration file. <br clear="none"> In some cases it also possible to achieve
the same end by extending your wsdl contract: you can add CXF specific
extension elements to the wsdl:port element and in that way fine tune the
behaviour of the specified transport. Or you can use WS-Policy to express the
fact that your application uses WS-Addressing, for example.</p><p>Using Spring
configuration files however is the most versatile way to achieve a specific
goal: you can use it to</p><ol><li>
Enable functionality via simple constructs called features.</li><li>Set
properties of runtime components by referring to these runtime components using
either plain Spring bean elements, or, more conveniently, using CXF custom
beans elements.</li><li>Modify the actual composition of the runtime (change
the way the runtime is wired up).</li></ol><p>The following examples show the
what the Spring configuration would look like if you wanted to enable the
logging of inbound and outbound messages and faults.</p><p><strong>Enabling
message logging using plain Spring bean elements</strong></p><div
class="confluence-information-macro confluence-information-macro-note"><span
class="aui-icon aui-icon-small aui-iconfont-warning
confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>Using this format is STRONGLY
discouraged as it ties your configuration with internal CXF class names (like
SpringBus). It is much better to use the cxf:bus element described bel
ow</p></div></div><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
+<pre class="brush: xml; gutter: false; theme: Default"
style="font-size:12px;"><beans
xmlns="http://www.springframework.org/schema/beans";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.0.xsd">
@@ -236,15 +181,8 @@ http://www.springframework.org/schema/be
</bean>
</beans>
</pre>
-</div></div>
-
-<p>In this example, you specify that the CXF bus is implemented by class
org.apache.cxf.bus.spring.SpringBus, and that its id is "cxf". This is the
default, but you have to re-iterate the fact if you want the bus to contribute
the logging interceptors to the outbound and inbound interceptor chain for all
client and server endpoints. You can avoid this duplication by using the next
form of configuration:</p>
-
-<p><strong>Enabling message logging using custom CXF bean elements</strong></p>
-
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;">
-<beans xmlns="http://www.springframework.org/schema/beans";
+</div></div><p>In this example, you specify that the CXF bus is implemented by
class org.apache.cxf.bus.spring.SpringBus, and that its id is "cxf". This is
the default, but you have to re-iterate the fact if you want the bus to
contribute the logging interceptors to the outbound and inbound interceptor
chain for all client and server endpoints. You can avoid this duplication by
using the next form of configuration:</p><p><strong>Enabling message logging
using custom CXF bean elements</strong></p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<pre class="brush: xml; gutter: false; theme: Default"
style="font-size:12px;"><beans
xmlns="http://www.springframework.org/schema/beans";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xmlns:cxf="http://cxf.apache.org/core";
xsi:schemaLocation="
@@ -270,15 +208,8 @@ http://www.springframework.org/schema/be
</cxf:bus>
</beans>
</pre>
-</div></div>
-
-<p>Here, there is no need to specify the implementation class of the bus - nor
the fact that the inInterceptors, outInterceptors, outFaultInterceptors, and
inFaultInterceptors child elements are of type list. All of this information is
embedded in the underlying schema and the bean definition parser that's invoked
for <cxf:bus> elemens. Note that you have to specify the location of this
schema in the schemaLocation attribute of the <beans> element so that
Spring can validate the configuration file. But it gets even simpler in the
next example:</p>
-
-<p><strong>Enabling message logging using the Logging feature</strong></p>
-
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;">
-<beans xmlns="http://www.springframework.org/schema/beans";
+</div></div><p>Here, there is no need to specify the implementation class of
the bus - nor the fact that the inInterceptors, outInterceptors,
outFaultInterceptors, and inFaultInterceptors child elements are of type list.
All of this information is embedded in the underlying schema and the bean
definition parser that's invoked for <cxf:bus> elemens. Note that you
have to specify the location of this schema in the schemaLocation attribute of
the <beans> element so that Spring can validate the configuration file.
But it gets even simpler in the next example:</p><p><strong>Enabling message
logging using the Logging feature</strong></p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<pre class="brush: xml; gutter: false; theme: Default"
style="font-size:12px;"><beans
xmlns="http://www.springframework.org/schema/beans";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xmlns:cxf="http://cxf.apache.org/core";
xsi:schemaLocation="
@@ -292,17 +223,7 @@ http://www.springframework.org/schema/be
</cxf:bus>
</beans>
</pre>
-</div></div>
-
-<p>The following sections explain which of the above mechanisms (feature,
custom CXF bean or plain Spring bean; or indeed others such as wsdl extensors
or policy assertions) you can use to enable and/or configure the various
components in CXF, and what your configuration options are:</p>
-
-<ul><li><a shape="rect" href="bus-configuration.html">Bus</a></li><li><a
shape="rect" href="jax-ws-configuration.html">JAX-WS
Configuration</a></li><li>HTTP <a shape="rect"
href="client-http-transport-including-ssl-support.html">Client</a> and <a
shape="rect" href="standalone-http-transport.html">Server</a></li><li><a
shape="rect" href="jms-transport.html">JMS Transport</a></li><li>Soap
Binding</li><li>XML Binding</li><li><a shape="rect"
href="wsaconfiguration.html">WS-Addressing</a></li><li><a shape="rect"
href="wsrmconfiguration.html">WS-Reliable Messaging</a></li><li><a shape="rect"
href="wspconfiguration.html">WS-Policy Framework</a></li></ul>
-
-
-<p>For a list of available features, see <a shape="rect"
href="featureslist.html">here</a>.</p>
-
-<h2 id="Configuration-AdvancedConfiguration">Advanced Configuration</h2>
-<p>If you are writing your own component for CXF, please see <a shape="rect"
href="configuration-for-developers.html">Configuration for Developers</a>
page.</p></div>
+</div></div><p>The following sections explain which of the above mechanisms
(feature, custom CXF bean or plain Spring bean; or indeed others such as wsdl
extensors or policy assertions) you can use to enable and/or configure the
various components in CXF, and what your configuration options
are:</p><ul><li><a shape="rect"
href="bus-configuration.html">Bus</a></li><li><a shape="rect"
href="jax-ws-configuration.html">JAX-WS Configuration</a></li><li>HTTP <a
shape="rect" href="client-http-transport-including-ssl-support.html">Client</a>
and <a shape="rect" href="standalone-http-transport.html">Server</a></li><li><a
shape="rect" href="jms-transport.html">JMS Transport</a></li><li>Soap
Binding</li><li>XML Binding</li><li><a shape="rect"
href="wsaconfiguration.html">WS-Addressing</a></li><li><a shape="rect"
href="wsrmconfiguration.html">WS-Reliable Messaging</a></li><li><a shape="rect"
href="wspconfiguration.html">WS-Policy Framework</a></li></ul><p>For a list of
available features, see <
a shape="rect" href="featureslist.html">here</a>.</p><h2
id="Configuration-AdvancedConfiguration">Advanced Configuration</h2><p>If you
are writing your own component for CXF, please see <a shape="rect"
href="configuration-for-developers.html">Configuration for Developers</a>
page.</p></div>
</div>
<!-- Content -->
</td>
