Author: gertv
Date: Wed Dec 15 21:41:31 2010
New Revision: 1049719
URL: http://svn.apache.org/viewvc?rev=1049719&view=rev
Log:
SMXCOMP-833: Improve servicemix-cxf-se javadoc for wiki/xsd documentation
Modified:
servicemix/components/trunk/engines/servicemix-cxf-se/pom.xml
servicemix/components/trunk/engines/servicemix-cxf-se/src/main/java/org/apache/servicemix/cxfse/CxfSeEndpoint.java
servicemix/components/trunk/engines/servicemix-cxf-se/src/main/java/org/apache/servicemix/cxfse/CxfSeProxyFactoryBean.java
Modified: servicemix/components/trunk/engines/servicemix-cxf-se/pom.xml
URL:
http://svn.apache.org/viewvc/servicemix/components/trunk/engines/servicemix-cxf-se/pom.xml?rev=1049719&r1=1049718&r2=1049719&view=diff
==============================================================================
--- servicemix/components/trunk/engines/servicemix-cxf-se/pom.xml (original)
+++ servicemix/components/trunk/engines/servicemix-cxf-se/pom.xml Wed Dec 15
21:41:31 2010
@@ -201,7 +201,6 @@
</exclusions>
</dependency>
-
<!-- documentation -->
<dependency>
<groupId>org.apache.servicemix</groupId>
Modified:
servicemix/components/trunk/engines/servicemix-cxf-se/src/main/java/org/apache/servicemix/cxfse/CxfSeEndpoint.java
URL:
http://svn.apache.org/viewvc/servicemix/components/trunk/engines/servicemix-cxf-se/src/main/java/org/apache/servicemix/cxfse/CxfSeEndpoint.java?rev=1049719&r1=1049718&r2=1049719&view=diff
==============================================================================
---
servicemix/components/trunk/engines/servicemix-cxf-se/src/main/java/org/apache/servicemix/cxfse/CxfSeEndpoint.java
(original)
+++
servicemix/components/trunk/engines/servicemix-cxf-se/src/main/java/org/apache/servicemix/cxfse/CxfSeEndpoint.java
Wed Dec 15 21:41:31 2010
@@ -80,8 +80,7 @@ import org.springframework.util.Reflecti
/**
* @author gnodet
- * @org.apache.xbean.XBean element="endpoint" description="an endpoint using
- * CXF's JAX-WS frontend"
+ * @org.apache.xbean.XBean element="endpoint" description="an endpoint using
CXF's JAX-WS frontend"
*/
public class CxfSeEndpoint extends ProviderEndpoint implements
InterceptorProvider {
@@ -139,8 +138,7 @@ public class CxfSeEndpoint extends Provi
* object should use the JAX-WS annotations.
*
* @param pojo a JAX-WS annotated object
- * @org.apache.xbean.Property description="a bean configuring the JAX-WS
- * annotated implementation for the endpoint"
+ * @org.apache.xbean.Property description="a bean configuring the JAX-WS
annotated implementation for the endpoint"
*/
public void setPojo(Object pojo) {
this.pojo = pojo;
@@ -191,8 +189,7 @@ public class CxfSeEndpoint extends Provi
* endpoint.
*
* @param interceptors a list of <code>Interceptor</code> objects
- * @org.apache.xbean.Property description="a list of beans configuring
- * interceptors that process incoming requests"
+ * @org.apache.xbean.Property description="a list of beans configuring
interceptors that process incoming requests"
*/
public void setInInterceptors(List<Interceptor> interceptors) {
in.addAll(interceptors);
@@ -203,8 +200,7 @@ public class CxfSeEndpoint extends Provi
* endpoint.
*
* @param interceptors a list of <code>Interceptor</code> objects
- * @org.apache.xbean.Property description="a list of beans configuring
- * interceptors that process incoming faults"
+ * @org.apache.xbean.Property description="a list of beans configuring
interceptors that process incoming faults"
*/
public void setInFaultInterceptors(List<Interceptor> interceptors) {
inFault.addAll(interceptors);
@@ -215,8 +211,7 @@ public class CxfSeEndpoint extends Provi
* endpoint.
*
* @param interceptors a list of <code>Interceptor</code> objects
- * @org.apache.xbean.Property description="a list of beans configuring
- * interceptors that process response messages"
+ * @org.apache.xbean.Property description="a list of beans configuring
interceptors that process response messages"
*/
public void setOutInterceptors(List<Interceptor> interceptors) {
out.addAll(interceptors);
@@ -227,14 +222,17 @@ public class CxfSeEndpoint extends Provi
* endpoint.
*
* @param interceptors a list of <code>Interceptor</code> objects
- * @org.apache.xbean.Property description="a list of beans configuring
- * interceptors that process fault messages
being
- * returned to the consumer"
+ * @org.apache.xbean.Property description="a list of beans configuring
interceptors that process fault messages being returned to the consumer"
*/
public void setOutFaultInterceptors(List<Interceptor> interceptors) {
outFault.addAll(interceptors);
}
+ /**
+ * Specifies a map of properties
+ *
+ * @org.apache.xbean.Property description="Specifies a map of properties"
+ */
public Map getProperties() {
return properties;
}
@@ -598,9 +596,7 @@ public class CxfSeEndpoint extends Provi
* Specifies if the endpoint can process messages with binary data.
*
* @param mtomEnabled a <code>boolean</code>
- * @org.apache.xbean.Property description="Specifies if the service can
- * consume MTOM formatted binary data. The
- * default is <code>false</code>."
+ * @org.apache.xbean.Property description="Specifies if the service can
consume MTOM formatted binary data. The default is <code>false</code>."
*/
public void setMtomEnabled(boolean mtomEnabled) {
this.mtomEnabled = mtomEnabled;
@@ -615,11 +611,7 @@ public class CxfSeEndpoint extends Provi
* wrapper used for SOAP messages. Ignore the value of useSOAPEnvelope if
* useJBIWrapper is true
*
- * @org.apache.xbean.Property description="Specifies if the endpoint
expects
- * to receive the JBI wrapper in the message
- * received from the NMR. The default is
- * <code>true</code>. Ignore the value of
- * useSOAPEnvelope if useJBIWrapper is true"
+ * @org.apache.xbean.Property description="Specifies if the endpoint
expects to receive the JBI wrapper in the message received from the NMR. The
default is <code>true</code>. Ignore the value of useSOAPEnvelope if
useJBIWrapper is true"
*/
public void setUseJBIWrapper(boolean useJBIWrapper) {
this.useJBIWrapper = useJBIWrapper;
@@ -633,11 +625,7 @@ public class CxfSeEndpoint extends Provi
* Specifies if the endpoint expects soap messages when useJBIWrapper is
* false, if useJBIWrapper is true then ignore useSOAPEnvelope
*
- * @org.apache.xbean.Property description="Specifies if the endpoint
expects
- * soap messages when useJBIWrapper is false, if
- * useJBIWrapper is true then ignore
- * useSOAPEnvelope. The default is
- * <code>true</code>.
+ * @org.apache.xbean.Property description="Specifies if the endpoint
expects soap messages when useJBIWrapper is false, if useJBIWrapper is true
then ignore useSOAPEnvelope. The default is <code>true</code>.
*/
public void setUseSOAPEnvelope(boolean useSOAPEnvelope) {
this.useSOAPEnvelope = useSOAPEnvelope;
@@ -648,12 +636,10 @@ public class CxfSeEndpoint extends Provi
}
/**
- * Specifies if the endpoint use aegis databinding to marshell/unmarshell
+ * Specifies if the endpoint use aegis databinding to marshall/unmarshall
* message
*
- * @org.apache.xbean.Property description="Specifies if the endpoint use
- * aegis databinding to marshell/unmarshell
- * message. The default is <code>false</code>.
+ * @org.apache.xbean.Property description="Specifies if the endpoint use
aegis databinding to marshall/unmarshall message. The default is
<code>false</code>.
*/
public void setUseAegis(boolean useAegis) {
this.useAegis = useAegis;
@@ -666,9 +652,7 @@ public class CxfSeEndpoint extends Provi
/**
* Specifies the servicemodel service name generated from the pojo
*
- * @org.apache.xbean.Property description="Specifies the servicemodel
- * service name generated from the
pojo.
- * The default is
<code>null</code>.
+ * @org.apache.xbean.Property description="Specifies the servicemodel
service name generated from the pojo. The default is <code>null</code>.
*/
public void setPojoService(QName pojoService) {
this.pojoService = pojoService;
@@ -681,9 +665,7 @@ public class CxfSeEndpoint extends Provi
/**
* Specifies the servicemodel endpoint name generated from the pojo
*
- * @org.apache.xbean.Property description="Specifies the servicemodel
- * endpoint name generated from
the pojo.
- * The default is
<code>null</code>.
+ * @org.apache.xbean.Property description="Specifies the servicemodel
endpoint name generated from the pojo. The default is <code>null</code>.
*/
public void setPojoEndpoint(QName pojoEndpoint) {
this.pojoEndpoint = pojoEndpoint;
@@ -693,6 +675,11 @@ public class CxfSeEndpoint extends Provi
return pojoEndpoint;
}
+ /**
+ * Specifies the servicemodel interface name generated from the pojo
+ *
+ * @org.apache.xbean.Property description="Specifies the servicemodel
interface name generated from the pojo. The default is <code>null</code>.
+ */
protected void setPojoInterfaceName(QName pojoInterfaceName) {
this.pojoInterfaceName = pojoInterfaceName;
}
@@ -706,9 +693,7 @@ public class CxfSeEndpoint extends Provi
* Specifies if the endpoint use xmlbeans databinding to
marshell/unmarshell
* message
*
- * @org.apache.xbean.Property description="Specifies if the endpoint use
- * xmlbeans databinding to marshell/unmarshell
- * message. The default is <code>false</code>.
+ * @org.apache.xbean.Property description="Specifies if the endpoint use
xmlbeans databinding to marshell/unmarshell message. The default is
<code>false</code>.
*/
public void setUseXmlBeans(boolean useXmlBeans) {
this.useXmlBeans = useXmlBeans;
Modified:
servicemix/components/trunk/engines/servicemix-cxf-se/src/main/java/org/apache/servicemix/cxfse/CxfSeProxyFactoryBean.java
URL:
http://svn.apache.org/viewvc/servicemix/components/trunk/engines/servicemix-cxf-se/src/main/java/org/apache/servicemix/cxfse/CxfSeProxyFactoryBean.java?rev=1049719&r1=1049718&r2=1049719&view=diff
==============================================================================
---
servicemix/components/trunk/engines/servicemix-cxf-se/src/main/java/org/apache/servicemix/cxfse/CxfSeProxyFactoryBean.java
(original)
+++
servicemix/components/trunk/engines/servicemix-cxf-se/src/main/java/org/apache/servicemix/cxfse/CxfSeProxyFactoryBean.java
Wed Dec 15 21:41:31 2010
@@ -196,18 +196,32 @@ public class CxfSeProxyFactoryBean imple
return type;
}
+ /**
+ * Specifies the webservice POJO type
+ */
public void setType(Class type) {
this.type = type;
}
+ /**
+ * The name of the endpoint.
+ *
+ * @org.apache.xbean.Property description="The name of the endpoint."
+ * */
public String getEndpoint() {
return endpoint;
}
+
public void setEndpoint(String endpointName) {
this.endpoint = endpointName;
}
+ /**
+ * Specifies the servicemodel interface name
+ *
+ * @org.apache.xbean.Property description="Specifies the servicemodel
interface name"
+ * */
public QName getInterfaceName() {
return interfaceName;
}
@@ -216,6 +230,11 @@ public class CxfSeProxyFactoryBean imple
this.interfaceName = interfaceName;
}
+ /**
+ * Specifies the servicemodel service name
+ *
+ * @org.apache.xbean.Property description="Specifies the servicemodel
service name"
+ * */
public QName getService() {
return service;
}
@@ -225,8 +244,10 @@ public class CxfSeProxyFactoryBean imple
}
/**
- * @return the context
- */
+ * Allows injecting the ComponentContext
+ *
+ * @org.apache.xbean.Property description="Allows injecting the
ComponentContext"
+ * */
public ComponentContext getContext() {
return context;
}
@@ -239,24 +260,22 @@ public class CxfSeProxyFactoryBean imple
this.context = context;
}
- /**
- * @return the container
- */
public Container getContainer() {
return container;
}
/**
- * @param container
- * the container to set
+ * Allows injecting a JBI Container instance (e.g. for testing purposes).
*/
public void setContainer(Container container) {
this.container = container;
}
/**
- * @return the factory
- */
+ * Allows injecting a ClientFactory
+ *
+ * @org.apache.xbean.Property description="Allows injecting a
ClientFactory"
+ * */
public ClientFactory getFactory() {
return factory;
}
@@ -269,29 +288,26 @@ public class CxfSeProxyFactoryBean imple
this.factory = factory;
}
- /**
- * @return the name
- */
public String getName() {
return name;
}
/**
- * @param name
- * the name to set
+ * Specifies the JNDI name for looking up the ClientFactory. Defaults to
<code>java:comp/env/jbi/ClientFactory</code>.
+ *
+ * @param name the name to set
*/
public void setName(String name) {
this.name = name;
}
- /**
- * @return the propagateSecuritySubject
- */
public boolean isPropagateSecuritySubject() {
return propagateSecuritySubject;
}
/**
+ * When set to <code>true</code>, the security subject is propagated along
to the proxied endpoint. Defaults to <code>false</code>.
+ *
* @param propagateSecuritySubject
* the propagateSecuritySubject to set
*/
@@ -317,8 +333,7 @@ public class CxfSeProxyFactoryBean imple
* JBI wrapper used for SOAP messages. Ignore the value of useSOAPEnvelope
* if useJBIWrapper is true
*
- * @org.apache.xbean.Property description="Specifies if the endpoint
expects to receive the JBI wrapper in the message received from the NMR. The
default is <code>true</code>.
- * Ignore the value of useSOAPEnvelope if
useJBIWrapper is true"
+ * @org.apache.xbean.Property description="Specifies if the endpoint
expects to receive the JBI wrapper in the message received from the NMR. The
default is <code>true</code>. Ignore the value of useSOAPEnvelope if
useJBIWrapper is true"
* */
public void setUseJBIWrapper(boolean useJBIWrapper) {
this.useJBIWrapper = useJBIWrapper;
@@ -332,8 +347,7 @@ public class CxfSeProxyFactoryBean imple
* Specifies if the endpoint expects soap messages when useJBIWrapper is
false,
* if useJBIWrapper is true then ignore useSOAPEnvelope
*
- * @org.apache.xbean.Property description="Specifies if the endpoint
expects soap messages when useJBIWrapper is false,
- * if useJBIWrapper is true then ignore
useSOAPEnvelope. The default is <code>true</code>.
+ * @org.apache.xbean.Property description="Specifies if the endpoint
expects soap messages when useJBIWrapper is false, if useJBIWrapper is true
then ignore useSOAPEnvelope. The default is <code>true</code>.
* */
public void setUseSOAPEnvelope(boolean useSOAPEnvelope) {
this.useSOAPEnvelope = useSOAPEnvelope;
@@ -343,6 +357,12 @@ public class CxfSeProxyFactoryBean imple
return useSOAPEnvelope;
}
+ /**
+ * Specifies if the endpoint can process messages with binary data.
+ *
+ * @param mtomEnabled a <code>boolean</code>
+ * @org.apache.xbean.Property description="Specifies if the service can
consume MTOM formatted binary data. The default is <code>false</code>."
+ */
public void setMtomEnabled(boolean mtomEnabled) {
this.mtomEnabled = mtomEnabled;
}
@@ -351,6 +371,11 @@ public class CxfSeProxyFactoryBean imple
return mtomEnabled;
}
+ /**
+ * Allows injecting a custom component registry for looking up the proxied
endpoint
+ *
+ * @org.apache.xbean.Property description="Allows injecting a custom
component registry for looking up the proxying endpoint."
+ * */
public void setComponentRegistry(Object componentRegistry) {
this.componentRegistry = componentRegistry;
}
