Author: buildbot
Date: Mon Dec 1 01:47:27 2014
New Revision: 931125
Log:
Production update by buildbot for cxf
Modified:
websites/production/cxf/content/cache/docs.pageCache
websites/production/cxf/content/docs/annotations.html
Modified: websites/production/cxf/content/cache/docs.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/cxf/content/docs/annotations.html
==============================================================================
--- websites/production/cxf/content/docs/annotations.html (original)
+++ websites/production/cxf/content/docs/annotations.html Mon Dec 1 01:47:27
2014
@@ -116,22 +116,8 @@ Apache CXF -- Annotations
<td height="100%">
<!-- Content -->
<div class="wiki-content">
-<div id="ConfluenceContent"><p>CXF provides several custom annotations that
can be used to configure and customize the CXF runtime.</p>
-
-<h3
id="Annotations-org.apache.cxf.feature.Features">org.apache.cxf.feature.Features</h3>
-<p>The @Features annotation is used to add <a shape="rect"
href="features.html">Features</a>. See the <a shape="rect"
href="featureslist.html">FeaturesList</a> for the list of Features we provide
"out of the box", but you can easily create your own. In many cases, however,
those features have Annotations themselves which can be used and provide
greater control over configuration.</p>
-
-<h3
id="Annotations-org.apache.cxf.interceptor.InInterceptors,org.apache.cxf.interceptor.OutInterceptors,org.apache.cxf.interceptor.OutFaultInterceptors,org.apache.cxf.interceptor.InFaultInterceptors">org.apache.cxf.interceptor.InInterceptors,
<br clear="none" class="atl-forced-newline">
org.apache.cxf.interceptor.OutInterceptors, <br clear="none"
class="atl-forced-newline"> org.apache.cxf.interceptor.OutFaultInterceptors,
<br clear="none" class="atl-forced-newline">
org.apache.cxf.interceptor.InFaultInterceptors</h3>
-<p>Add interceptors to the various chains used to process messages. See <a
shape="rect" href="interceptors.html">Interceptors</a> for more detail.</p>
-
-<p><span class="confluence-anchor-link"
id="Annotations-WSDLDocumentation"></span></p>
-<h3
id="Annotations-org.apache.cxf.annotations.WSDLDocumentationorg.apache.cxf.annotations.WSDLDocumentationCollection(since2.3)">org.apache.cxf.annotations.WSDLDocumentation
<br clear="none" class="atl-forced-newline">
org.apache.cxf.annotations.WSDLDocumentationCollection (since 2.3)</h3>
-<p>For "java first" scenarios where the WSDL is derived from the Java
interfaces/code, these annotations allow adding wsd:documentation elements to
various locations in the generated wsdl. </p>
-
-<p>For example:</p>
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[
-@WebService
+<div id="ConfluenceContent"><p>CXF provides several custom annotations that
can be used to configure and customize the CXF runtime.</p><h3
id="Annotations-org.apache.cxf.feature.Features">org.apache.cxf.feature.Features</h3><p>The
@Features annotation is used to add <a shape="rect"
href="features.html">Features</a>. See the <a shape="rect"
href="featureslist.html">FeaturesList</a> for the list of Features we provide
"out of the box", but you can easily create your own. In many cases, however,
those features have Annotations themselves which can be used and provide
greater control over configuration.</p><h3
id="Annotations-org.apache.cxf.interceptor.InInterceptors,org.apache.cxf.interceptor.OutInterceptors,org.apache.cxf.interceptor.OutFaultInterceptors,org.apache.cxf.interceptor.InFaultInterceptors">org.apache.cxf.interceptor.InInterceptors,
<br clear="none" class="atl-forced-newline">
org.apache.cxf.interceptor.OutInterceptors, <br clear="none"
class="atl-forced-newline"> org.apach
e.cxf.interceptor.OutFaultInterceptors, <br clear="none"
class="atl-forced-newline">
org.apache.cxf.interceptor.InFaultInterceptors</h3><p>Add interceptors to the
various chains used to process messages. See <a shape="rect"
href="interceptors.html">Interceptors</a> for more detail.</p><p><span
class="confluence-anchor-link"
id="Annotations-WSDLDocumentation"></span></p><h3
id="Annotations-org.apache.cxf.annotations.WSDLDocumentationorg.apache.cxf.annotations.WSDLDocumentationCollection(since2.3)">org.apache.cxf.annotations.WSDLDocumentation
<br clear="none" class="atl-forced-newline">
org.apache.cxf.annotations.WSDLDocumentationCollection (since 2.3)</h3><p>For
"java first" scenarios where the WSDL is derived from the Java interfaces/code,
these annotations allow adding wsd:documentation elements to various locations
in the generated wsdl.</p><p>For example:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[@WebService
@WSDLDocumentationCollection(
{
@WSDLDocumentation("My portType documentation"),
@@ -148,68 +134,45 @@ public interface MyService {
}
]]></script>
-</div></div>
+</div></div><p><span class="confluence-anchor-link"
id="Annotations-SchemaValidation"></span></p><h3
id="Annotations-org.apache.cxf.annotations.SchemaValidation(since2.3)">org.apache.cxf.annotations.SchemaValidation
(since 2.3)</h3><p>Turns on SchemaValidation for messages. By default, for
performance reasons, CXF does not validate message against the schema. By
turning on validation, problems with messages not matching the schema are
easier to determine.   These annotations can be applied globally to
the SEI, but also can be applied at method level in both the SEI and
Implementation.</p><p> </p><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><td colspan="1" rowspan="1"
class="confluenceTd">IN</td><td colspan="1" rowspan="1"
class="confluenceTd">Apply schema validation to INcoming messages on client and
server</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">REQUEST</td><td colspan="1" rowspan="1"
class="confluenceTd"><strong>(Since 2.7.
14, 3.0.3, 3.1</strong>) Apply schema validation to Request messages. 
This annotation will cause validation to be applied to OUTgoing Client
messages, and INcoming Server messages.</td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd">OUT</td><td colspan="1" rowspan="1"
class="confluenceTd">Apply schema validation to OUTgoing messages on Client and
Server</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">RESPONSE</td><td colspan="1" rowspan="1"
class="confluenceTd"><strong>(Since 2.7.14, 3.0.3, 3.1)</strong> Apply schema
validation to Response messages.  This annotation will cause validation to
be applied to INcoming Client messages, and OUTgoing Server
messages.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">BOTH</td><td colspan="1" rowspan="1"
class="confluenceTd">Apply schema validation to both INcoming and OUTgoing
messages on Client and Server</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">NONE</td><td colspan="1" row
span="1" class="confluenceTd">All schema validation is disabled.  This is
the default if no annotations are provided.</td></tr></tbody></table></div><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[@WebService
+@SchemaValidation(type = SchemaValidationType.BOTH)
+public interface MyService {
+ Foo validateBoth(Bar data);
-<p><span class="confluence-anchor-link"
id="Annotations-SchemaValidation"></span></p>
-<h3
id="Annotations-org.apache.cxf.annotations.SchemaValidation(since2.3)">org.apache.cxf.annotations.SchemaValidation
(since 2.3)</h3>
-<p>Turns on SchemaValidation for messages. By default, for performance
reasons, CXF does not validate message against the schema. By turning on
validation, problems with messages not matching the schema are easier to
determine.</p>
-
-<p><span class="confluence-anchor-link"
id="Annotations-DataBinding"></span></p>
-<h3
id="Annotations-org.apache.cxf.annotations.DataBinding(since2.2.4)">org.apache.cxf.annotations.DataBinding
(since 2.2.4)</h3>
-<p>Sets the DataBinding class that is associated with the service. By
default, CXF assumes you are using the JAXB data binding. However, CXF
supports different databindings such as XMLBeans, Aegis, SDO, and possibly
more. This annotation can be used in place of configuration to select the
databinding class.</p>
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[
-@DataBinding(org.apache.cxf.sdo.SDODataBinding.class)
+ @SchemaValidation(type = SchemaValidationType.NONE)
+ Foo validateNone(Bar data);
+
+ @SchemaValidation(type = SchemaValidationType.IN)
+ Foo validateIn(Bar data);
+
+ @SchemaValidation(type = SchemaValidationType.OUT)
+ Foo validateOut(Bar data);
+
+ @SchemaValidation(type = SchemaValidationType.REQUEST)
+ Foo validateRequest(Bar data);
+
+ @SchemaValidation(type = SchemaValidationType.RESPONSE)
+ Foo validateResponse(Bar data);
+}]]></script>
+</div></div><p> </p><p><span class="confluence-anchor-link"
id="Annotations-DataBinding"></span></p><h3
id="Annotations-org.apache.cxf.annotations.DataBinding(since2.2.4)">org.apache.cxf.annotations.DataBinding
(since 2.2.4)</h3><p>Sets the DataBinding class that is associated with the
service. By default, CXF assumes you are using the JAXB data binding. However,
CXF supports different databindings such as XMLBeans, Aegis, SDO, and possibly
more. This annotation can be used in place of configuration to select the
databinding class.</p><div class="code panel pdl" style="border-width:
1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[@DataBinding(org.apache.cxf.sdo.SDODataBinding.class)
public interface MyService {
public commonj.sdo.DataObject echoStruct(
commonj.sdo.DataObject struct
);
}
]]></script>
-</div></div>
-
-<p><span class="confluence-anchor-link" id="Annotations-Logging"></span></p>
-<h3
id="Annotations-org.apache.cxf.annotations.Logging(since2.3)">org.apache.cxf.annotations.Logging
(since 2.3)</h3>
-<p>Turns on logging for the endpoint. Can be used to control the size limits
of what gets logged as well as the location. It supports the following
attributes:</p>
-<div class="table-wrap"><table class="confluenceTable"><tbody><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p>limit </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> Sets the size limit after which the
message is truncated in the logs. Default is 64K</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p>inLocation </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> Sets the location to log
incoming messages. Can be <stderr>, <stdout>, <logger>, or a
file: URL. Default is <logger></p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p>outLocation </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> Sets the location to log outgoing
messages. Can be <stderr>, <stdout>, <logger>, or a file:
URL. Default is <logger></p></td></tr></tbody></table></div>
-
-
-
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[
-@Logging(limit=16000, inLocation="<stdout>")
+</div></div><p><span class="confluence-anchor-link"
id="Annotations-Logging"></span></p><h3
id="Annotations-org.apache.cxf.annotations.Logging(since2.3)">org.apache.cxf.annotations.Logging
(since 2.3)</h3><p>Turns on logging for the endpoint. Can be used to control
the size limits of what gets logged as well as the location. It supports the
following attributes:</p><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>limit</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Sets the size limit after which the message is
truncated in the logs. Default is 64K</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p>inLocation</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Sets the location to log incoming messages.
Can be <stderr>, <stdout>, <logger>, or a file: URL. Default
is <logger></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>outLocatio
n</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Sets the
location to log outgoing messages. Can be <stderr>, <stdout>,
<logger>, or a file: URL. Default is
<logger></p></td></tr></tbody></table></div><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[@Logging(limit=16000,
inLocation="<stdout>")
public interface MyService {
String echoString(String s);
}
]]></script>
-</div></div>
-
-
-<p><span class="confluence-anchor-link" id="Annotations-GZIP"></span></p>
-<h3
id="Annotations-org.apache.cxf.annotations.GZIP(since2.3)">org.apache.cxf.annotations.GZIP
(since 2.3)</h3>
-
-<p>Enables GZIP compression of on-the-wire data. Supported attributes:</p>
-<div class="table-wrap"><table class="confluenceTable"><tbody><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p>threshold</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>the threshold under which
messages are not gzipped</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>force</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>force GZIP compression instead of negotiating via the
Accept-Encoding header</p></td></tr></tbody></table></div>
-
-<p>GZIP is a negotiated enhancement. An initial request from a client will
not be gzipped, but an Accept header will be added and if the server supports
it, the response will be gzipped and any subsequent requests will be.</p>
-
-
-<p><span class="confluence-anchor-link"
id="Annotations-FastInfoset"></span></p>
-<h3
id="Annotations-org.apache.cxf.annotations.FastInfoset(since2.3)">org.apache.cxf.annotations.FastInfoset
(since 2.3)</h3>
-<p>Enables FastInfoset of on-the-wire data. Supported attributes:</p>
-<div class="table-wrap"><table class="confluenceTable"><tbody><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p>force</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> forces the use of fastinfoset instead of
negotiating. Default is false</p></td></tr></tbody></table></div>
-
-<p>FastInfoset is a negotiated enhancement. An initial request from a client
will not be in fastinfoset, but an Accept header will be added and if the
server supports it, the response will be in fastinfoset and any subsequent
requests will be.</p>
-
-<p><span class="confluence-anchor-link"
id="Annotations-EndpointProperty"></span></p>
-<h3
id="Annotations-org.apache.cxf.annotations.EndpointPropertyorg.apache.cxf.annotations.EndpointProperties(since2.3)">org.apache.cxf.annotations.EndpointProperty
<br clear="none" class="atl-forced-newline">
org.apache.cxf.annotations.EndpointProperties (since 2.3)</h3>
-<p>Adds a property to an endpoint. Many things such as WS-Security related
things and such can be configured via endpoint properties. Traditionally,
these would be set via the <jaxws:properties> element on the
<jaxws:endpoint> element in the spring config, but these annotations
allow these properties to be configured into the code.</p>
-
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[
-@WebService
+</div></div><p><span class="confluence-anchor-link"
id="Annotations-GZIP"></span></p><h3
id="Annotations-org.apache.cxf.annotations.GZIP(since2.3)">org.apache.cxf.annotations.GZIP
(since 2.3)</h3><p>Enables GZIP compression of on-the-wire data. Supported
attributes:</p><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>threshold</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>the threshold under which messages are not
gzipped</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>force</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>force GZIP compression instead of negotiating via the
Accept-Encoding header</p></td></tr></tbody></table></div><p>GZIP is a
negotiated enhancement. An initial request from a client will not be gzipped,
but an Accept header will be added and if the server supports it, the response
will be gzipped and any subsequent requests will be.</p><p><span class=
"confluence-anchor-link" id="Annotations-FastInfoset"></span></p><h3
id="Annotations-org.apache.cxf.annotations.FastInfoset(since2.3)">org.apache.cxf.annotations.FastInfoset
(since 2.3)</h3><p>Enables FastInfoset of on-the-wire data. Supported
attributes:</p><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>force</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>forces the use of fastinfoset instead of negotiating.
Default is false</p></td></tr></tbody></table></div><p>FastInfoset is a
negotiated enhancement. An initial request from a client will not be in
fastinfoset, but an Accept header will be added and if the server supports it,
the response will be in fastinfoset and any subsequent requests will
be.</p><p><span class="confluence-anchor-link"
id="Annotations-EndpointProperty"></span></p><h3
id="Annotations-org.apache.cxf.annotations.EndpointPropertyorg.apache.cxf.annotations.EndpointProperties(since2.
3)">org.apache.cxf.annotations.EndpointProperty <br clear="none"
class="atl-forced-newline"> org.apache.cxf.annotations.EndpointProperties
(since 2.3)</h3><p>Adds a property to an endpoint. Many things such as
WS-Security related things and such can be configured via endpoint properties.
Traditionally, these would be set via the <jaxws:properties> element on
the <jaxws:endpoint> element in the spring config, but these annotations
allow these properties to be configured into the code.</p><div class="code
panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[@WebService
@EndpointProperties(
{
@EndpointProperty(key = "my.property", value="some
value"),
@@ -219,27 +182,14 @@ public interface MyService {
String echoString(String s);
}
]]></script>
-</div></div>
-
-<p><span class="confluence-anchor-link" id="Annotations-Policy"></span></p>
-<h3
id="Annotations-org.apache.cxf.annotations.Policyorg.apache.cxf.annotations.Policies(since2.3)">org.apache.cxf.annotations.Policy
<br clear="none" class="atl-forced-newline">
org.apache.cxf.annotations.Policies (since 2.3)</h3>
-<p>Used to attach WS-Policy fragments to a service or operation. The Policy
supports the attributes:</p>
-<div class="table-wrap"><table class="confluenceTable"><tbody><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p>uri</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> <strong>REQUIRED</strong> the location of
the file containing the Policy definition</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p>includeInWSDL</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> Whether to include the policy in the
generated WSDL when generating a wsdl. Default is true</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p>placement</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> Specify where to place the
policy </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>faultClass </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> if placement is a FAULT, this specifies which fault
the policy would apply to </p></td></tr></tbody></table></div>
-
-
- <div class="aui-message warning shadowed information-macro">
+</div></div><p><span class="confluence-anchor-link"
id="Annotations-Policy"></span></p><h3
id="Annotations-org.apache.cxf.annotations.Policyorg.apache.cxf.annotations.Policies(since2.3)">org.apache.cxf.annotations.Policy
<br clear="none" class="atl-forced-newline">
org.apache.cxf.annotations.Policies (since 2.3)</h3><p>Used to attach WS-Policy
fragments to a service or operation. The Policy supports the
attributes:</p><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>uri</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>REQUIRED</strong> the location of the file
containing the Policy definition</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>includeInWSDL</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Whether to include the policy in the generated WSDL
when generating a wsdl. Default is true</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p>place
ment</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specify where
to place the policy</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>faultClass</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>if placement is a FAULT, this specifies which fault the
policy would apply to</p></td></tr></tbody></table></div> <div
class="aui-message warning shadowed information-macro">
<span class="aui-icon icon-warning">Icon</span>
<div class="message-content">
<p>When using a custom Spring configuration, you
need to import META-INF/cxf/cxf-extension-policy.xml</p>
</div>
</div>
-
-
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[
-
-
-@Policies({
+<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[@Policies({
@Policy(uri = "annotationpolicies/TestInterfacePolicy.xml"),
@Policy(uri = "annotationpolicies/TestImplPolicy.xml",
placement = Policy.Placement.SERVICE_PORT),
@@ -267,16 +217,8 @@ public static interface TestInterface {
}
]]></script>
-</div></div>
-
-<p><span class="confluence-anchor-link" id="Annotations-Policy"></span></p>
-<h3
id="Annotations-org.apache.cxf.annotations.UseAsyncMethod(since2.6.0)">org.apache.cxf.annotations.UseAsyncMethod
(since 2.6.0)</h3>
-<p>Used on the JAX-WS service implementation object to mark a method as
preferring the 'async' version of the method instead of the synchronous
version. With JAX-WS, services default to the synchronous methods that
require the returning value to be returned from the method. By marking a
method with the @UseAsyncMethod annotation, if the transport supports it, CXF
will call the async version that takes an AsynHandler object and the service
can call that handler when the response is ready. If the transport does not
support the CXF continuations, the synchronous method will be called as
normal.</p>
-
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><