You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@servicemix.apache.org by ff...@apache.org on 2008/09/10 04:47:45 UTC
svn commit: r693689 - in
/servicemix/components/bindings/servicemix-cxf-bc/trunk/src/main/java/org/apache/servicemix/cxfbc:
CxfBcComponent.java CxfBcConsumer.java CxfBcProvider.java
Author: ffang
Date: Tue Sep 9 19:47:45 2008
New Revision: 693689
URL: http://svn.apache.org/viewvc?rev=693689&view=rev
Log:
[SM-1566]Update generated schema configuration doc
Modified:
servicemix/components/bindings/servicemix-cxf-bc/trunk/src/main/java/org/apache/servicemix/cxfbc/CxfBcComponent.java
servicemix/components/bindings/servicemix-cxf-bc/trunk/src/main/java/org/apache/servicemix/cxfbc/CxfBcConsumer.java
servicemix/components/bindings/servicemix-cxf-bc/trunk/src/main/java/org/apache/servicemix/cxfbc/CxfBcProvider.java
Modified: servicemix/components/bindings/servicemix-cxf-bc/trunk/src/main/java/org/apache/servicemix/cxfbc/CxfBcComponent.java
URL: http://svn.apache.org/viewvc/servicemix/components/bindings/servicemix-cxf-bc/trunk/src/main/java/org/apache/servicemix/cxfbc/CxfBcComponent.java?rev=693689&r1=693688&r2=693689&view=diff
==============================================================================
--- servicemix/components/bindings/servicemix-cxf-bc/trunk/src/main/java/org/apache/servicemix/cxfbc/CxfBcComponent.java (original)
+++ servicemix/components/bindings/servicemix-cxf-bc/trunk/src/main/java/org/apache/servicemix/cxfbc/CxfBcComponent.java Tue Sep 9 19:47:45 2008
@@ -26,7 +26,7 @@
/**
*
* @author gnodet
- * @org.apache.xbean.XBean element="component"
+ * @org.apache.xbean.XBean element="component" description="a JBI component for hosting endpoints that can use either SOAP/HTTP or SOAP/JMS."
*/
public class CxfBcComponent extends DefaultComponent {
@@ -46,8 +46,10 @@
}
/**
+ * Specifies the list of endpoints hosted by the component.
* @param endpoints
* the endpoints to set
+ * @org.apache.xbean.Property description="the list of endpoints hosted by the component"
*/
public void setEndpoints(CxfBcEndpointType[] endpoints) {
this.endpoints = endpoints;
@@ -92,6 +94,15 @@
return bus;
}
+ /**
+ * Specifies the location of the CXF configuraiton file used to configure
+ * the CXF bus. This allows you to access features like JMS runtime
+ * behavior and WS-RM. The configuration set at the component level is
+ * superceeded by any configuration specified by an endpoint.
+ *
+ * @param busCfg a string containing the relative path to the configuration file
+ * @org.apache.xbean.Property description="the location of the CXF configuration file used to configure the CXF bus for all endpoints in the container. Endpoint-specific configuration overrides these settings. This allows you to configure features like WS-RM and JMS runtime behavior."
+ **/
public void setBusConfig(String busConfig) {
this.busCfg = busConfig;
}
Modified: servicemix/components/bindings/servicemix-cxf-bc/trunk/src/main/java/org/apache/servicemix/cxfbc/CxfBcConsumer.java
URL: http://svn.apache.org/viewvc/servicemix/components/bindings/servicemix-cxf-bc/trunk/src/main/java/org/apache/servicemix/cxfbc/CxfBcConsumer.java?rev=693689&r1=693688&r2=693689&view=diff
==============================================================================
--- servicemix/components/bindings/servicemix-cxf-bc/trunk/src/main/java/org/apache/servicemix/cxfbc/CxfBcConsumer.java (original)
+++ servicemix/components/bindings/servicemix-cxf-bc/trunk/src/main/java/org/apache/servicemix/cxfbc/CxfBcConsumer.java Tue Sep 9 19:47:45 2008
@@ -107,7 +107,7 @@
/**
*
* @author gnodet
- * @org.apache.xbean.XBean element="consumer"
+ * @org.apache.xbean.XBean element="consumer" description="a consumer endpoint that is capable of using SOAP/HTTP or SOAP/JMS"
*/
public class CxfBcConsumer extends ConsumerEndpoint implements
CxfBcEndpointWithInterceptor {
@@ -157,41 +157,95 @@
}
/**
- * @param wsdl
- * the wsdl to set
- */
+ * Specifies the location of the WSDL defining the endpoint's interface.
+ *
+ * @param wsdl the location of the WSDL contract as a <code>Resource</code> object
+ * @org.apache.xbean.Property description="the location of the WSDL document defining the endpoint's interface"
+ **/
public void setWsdl(Resource wsdl) {
this.wsdl = wsdl;
}
+ /**
+ * Returns the list of interceptors used to process fault messages being
+ * sent to the provider.
+ *
+ * @return a list of <code>Interceptor</code> objects
+ * */
public List<Interceptor> getOutFaultInterceptors() {
return outFault;
}
+ /**
+ * Returns the list of interceptors used to process fault messages being
+ * recieved by the endpoint.
+ *
+ * @return a list of <code>Interceptor</code> objects
+ * */
public List<Interceptor> getInFaultInterceptors() {
return inFault;
}
+ /**
+ * Returns the list of interceptors used to process responses being
+ * recieved by the endpoint.
+ *
+ * @return a list of <code>Interceptor</code> objects
+ * */
public List<Interceptor> getInInterceptors() {
return in;
}
+ /**
+ * Returns the list of interceptors used to process requests being
+ * sent to the provider.
+ *
+ * @return a list of <code>Interceptor</code> objects
+ * */
public List<Interceptor> getOutInterceptors() {
return out;
}
+ /**
+ * Specifies a list of interceptors used to process responses recieved
+ * by the endpoint.
+ *
+ * @param interceptors a list of <code>Interceptor</code> objects
+ * @org.apache.xbean.Property description="a list of beans configuring interceptors that process incoming responses"
+ * */
public void setInInterceptors(List<Interceptor> interceptors) {
in = interceptors;
}
+ /**
+ * Specifies a list of interceptors used to process faults recieved by
+ * the 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"
+ * */
public void setInFaultInterceptors(List<Interceptor> interceptors) {
inFault = interceptors;
}
+ /**
+ * Specifies a list of interceptors used to process requests sent by
+ * the endpoint.
+ *
+ * @param interceptors a list of <code>Interceptor</code> objects
+ * @org.apache.xbean.Property description="a list of beans configuring interceptors that process requests"
+ * */
public void setOutInterceptors(List<Interceptor> interceptors) {
out = interceptors;
}
+ /**
+ * Specifies a list of interceptors used to process faults sent by
+ * the 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"
+ * */
public void setOutFaultInterceptors(List<Interceptor> interceptors) {
outFault = interceptors;
}
@@ -420,6 +474,13 @@
}
}
+ /**
+ * Specifies the HTTP address to which requests are sent. This value
+ * will overide any value specified in the WSDL.
+ *
+ * @param locationURI the URI as a string
+ * @org.apache.xbean.Property description="the HTTP address to which requests are sent. This value will overide any value specified in the WSDL."
+ **/
public void setLocationURI(String locationURI) {
this.locationURI = locationURI;
}
@@ -684,6 +745,14 @@
return ret;
}
+ /**
+ * Specifies the location of the CXF configuraiton file used to configure
+ * the CXF bus. This allows you to access features like JMS runtime
+ * behavior and WS-RM.
+ *
+ * @param busCfg a string containing the relative path to the configuration file
+ * @org.apache.xbean.Property description="the location of the CXF configuration file used to configure the CXF bus. This allows you to configure features like WS-RM and JMS runtime behavior."
+ **/
public void setBusCfg(String busCfg) {
this.busCfg = busCfg;
}
@@ -692,6 +761,12 @@
return busCfg;
}
+ /**
+ * Specifies if the endpoint can support binnary attachments.
+ *
+ * @param mtomEnabled a boolean
+ * @org.apache.xbean.Property description="Specifies if MTOM / attachment support is enabled. Default is <code>false</code>."
+ **/
public void setMtomEnabled(boolean mtomEnabled) {
this.mtomEnabled = mtomEnabled;
}
@@ -700,6 +775,13 @@
return mtomEnabled;
}
+ /**
+ * Specifies the interval for which the endpoint will wait for a
+ * response, This is specified in seconds.
+ *
+ * @param timeout the number of seconds to wait for a response
+ * @org.apache.xbean.Property description="the number of seconds the endpoint will wait for a response. The default is 10."
+ **/
public void setTimeout(int timeout) {
this.timeout = timeout;
}
@@ -708,6 +790,13 @@
return timeout;
}
+ /**
+ * Specifies if the endpoint expects messages to use the JBI wrapper
+ * for SOAP messages.
+ *
+ * @param useJBIWrapper a boolean
+ * @org.apache.xbean.Property description="Specifies if the JBI wrapper is sent in the body of the message. Default is <code>true</code>."
+ **/
public void setUseJBIWrapper(boolean useJBIWrapper) {
this.useJBIWrapper = useJBIWrapper;
}
Modified: servicemix/components/bindings/servicemix-cxf-bc/trunk/src/main/java/org/apache/servicemix/cxfbc/CxfBcProvider.java
URL: http://svn.apache.org/viewvc/servicemix/components/bindings/servicemix-cxf-bc/trunk/src/main/java/org/apache/servicemix/cxfbc/CxfBcProvider.java?rev=693689&r1=693688&r2=693689&view=diff
==============================================================================
--- servicemix/components/bindings/servicemix-cxf-bc/trunk/src/main/java/org/apache/servicemix/cxfbc/CxfBcProvider.java (original)
+++ servicemix/components/bindings/servicemix-cxf-bc/trunk/src/main/java/org/apache/servicemix/cxfbc/CxfBcProvider.java Tue Sep 9 19:47:45 2008
@@ -98,7 +98,7 @@
/**
*
* @author gnodet
- * @org.apache.xbean.XBean element="provider"
+ * @org.apache.xbean.XBean element="provider" description="a provider endpoint that is capable of exposing SOAP/HTTP or SOAP/JMS services"
*/
public class CxfBcProvider extends ProviderEndpoint implements
CxfBcEndpointWithInterceptor {
@@ -274,38 +274,96 @@
message.put("jbiFault", true);
}
+ /**
+ * Returns the list of interceptors used to process fault messages being
+ * sent back to the consumer.
+ *
+ * @return a list of <code>Interceptor</code> objects
+ * */
public List<Interceptor> getOutFaultInterceptors() {
return outFault;
}
+ /**
+ * Returns the list of interceptors used to process fault messages being
+ * recieved by the endpoint.
+ *
+ * @return a list of <code>Interceptor</code> objects
+ * */
public List<Interceptor> getInFaultInterceptors() {
return inFault;
}
+ /**
+ * Returns the list of interceptors used to process requests being
+ * recieved by the endpoint.
+ *
+ * @return a list of <code>Interceptor</code> objects
+ * */
public List<Interceptor> getInInterceptors() {
return in;
}
+ /**
+ * Returns the list of interceptors used to process responses being
+ * sent back to the consumer.
+ *
+ * @return a list of <code>Interceptor</code> objects
+ * */
public List<Interceptor> getOutInterceptors() {
return out;
}
+ /**
+ * Specifies a list of interceptors used to process requests recieved
+ * by the 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"
+ * */
public void setInInterceptors(List<Interceptor> interceptors) {
in = interceptors;
}
+ /**
+ * Specifies a list of interceptors used to process faults recieved by
+ * the 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"
+ * */
public void setInFaultInterceptors(List<Interceptor> interceptors) {
inFault = interceptors;
}
+ /**
+ * Specifies a list of interceptors used to process responses sent by
+ * the endpoint.
+ *
+ * @param interceptors a list of <code>Interceptor</code> objects
+ * @org.apache.xbean.Property description="a list of beans configuring interceptors that process responses"
+ * */
public void setOutInterceptors(List<Interceptor> interceptors) {
out = interceptors;
}
+ /**
+ * Specifies a list of interceptors used to process faults sent by
+ * the 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"
+ * */
public void setOutFaultInterceptors(List<Interceptor> interceptors) {
outFault = interceptors;
}
+ /**
+ * Specifies the location of the WSDL defining the endpoint's interface.
+ *
+ * @param wsdl the location of the WSDL contract as a <code>Resource</code> object
+ * @org.apache.xbean.Property description="the location of the WSDL document defining the endpoint's interface"
+ **/
public void setWsdl(Resource wsdl) {
this.wsdl = wsdl;
}
@@ -435,6 +493,14 @@
}
}
+ /**
+ * Specifies the location of the CXF configuraiton file used to configure
+ * the CXF bus. This allows you to access features like JMS runtime
+ * behavior and WS-RM.
+ *
+ * @param busCfg a string containing the relative path to the configuration file
+ * @org.apache.xbean.Property description="the location of the CXF configuration file used to configure the CXF bus. This allows you to configure features like WS-RM and JMS runtime behavior."
+ **/
public void setBusCfg(String busCfg) {
this.busCfg = busCfg;
}
@@ -443,6 +509,13 @@
return busCfg;
}
+ /**
+ * Specifies the HTTP address of the exposed service. This value will
+ * overide any value specified in the WSDL.
+ *
+ * @param locationURI a <code>URI</code> object
+ * @org.apache.xbean.Property description="the HTTP address of the exposed service. This value will overide any value specified in the WSDL."
+ **/
public void setLocationURI(URI locationURI) {
this.locationURI = locationURI;
}
@@ -461,6 +534,12 @@
return this.ei;
}
+ /**
+ * Specifies if the endpoint can support binnary attachments.
+ *
+ * @param mtomEnabled a boolean
+ * @org.apache.xbean.Property description="Specifies if MTOM / attachment support is enabled. Default is <code>false</code>."
+ **/
public void setMtomEnabled(boolean mtomEnabled) {
this.mtomEnabled = mtomEnabled;
}
@@ -469,6 +548,13 @@
return mtomEnabled;
}
+ /**
+ * Specifies if the endpoint expects messages to use the JBI wrapper
+ * for SOAP messages.
+ *
+ * @param useJBIWrapper a boolean
+ * @org.apache.xbean.Property description="Specifies if the JBI wrapper is sent in the body of the message. Default is <code>true</code>."
+ **/
public void setUseJBIWrapper(boolean useJBIWrapper) {
this.useJBIWrapper = useJBIWrapper;
}