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/16 06:10:04 UTC
svn commit: r695723 - in
/servicemix/smx3/branches/servicemix-3.2/deployables/bindingcomponents/servicemix-cxf-bc/src/main/java/org/apache/servicemix/cxfbc:
CxfBcComponent.java CxfBcConsumer.java CxfBcProvider.java
Author: ffang
Date: Mon Sep 15 21:10:04 2008
New Revision: 695723
URL: http://svn.apache.org/viewvc?rev=695723&view=rev
Log:
[SM-1566]Update generated schema configuration doc for cxf bc
Modified:
servicemix/smx3/branches/servicemix-3.2/deployables/bindingcomponents/servicemix-cxf-bc/src/main/java/org/apache/servicemix/cxfbc/CxfBcComponent.java
servicemix/smx3/branches/servicemix-3.2/deployables/bindingcomponents/servicemix-cxf-bc/src/main/java/org/apache/servicemix/cxfbc/CxfBcConsumer.java
servicemix/smx3/branches/servicemix-3.2/deployables/bindingcomponents/servicemix-cxf-bc/src/main/java/org/apache/servicemix/cxfbc/CxfBcProvider.java
Modified: servicemix/smx3/branches/servicemix-3.2/deployables/bindingcomponents/servicemix-cxf-bc/src/main/java/org/apache/servicemix/cxfbc/CxfBcComponent.java
URL: http://svn.apache.org/viewvc/servicemix/smx3/branches/servicemix-3.2/deployables/bindingcomponents/servicemix-cxf-bc/src/main/java/org/apache/servicemix/cxfbc/CxfBcComponent.java?rev=695723&r1=695722&r2=695723&view=diff
==============================================================================
--- servicemix/smx3/branches/servicemix-3.2/deployables/bindingcomponents/servicemix-cxf-bc/src/main/java/org/apache/servicemix/cxfbc/CxfBcComponent.java (original)
+++ servicemix/smx3/branches/servicemix-3.2/deployables/bindingcomponents/servicemix-cxf-bc/src/main/java/org/apache/servicemix/cxfbc/CxfBcComponent.java Mon Sep 15 21:10:04 2008
@@ -28,7 +28,8 @@
/**
*
* @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 {
@@ -48,8 +49,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;
@@ -89,6 +92,17 @@
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/smx3/branches/servicemix-3.2/deployables/bindingcomponents/servicemix-cxf-bc/src/main/java/org/apache/servicemix/cxfbc/CxfBcConsumer.java
URL: http://svn.apache.org/viewvc/servicemix/smx3/branches/servicemix-3.2/deployables/bindingcomponents/servicemix-cxf-bc/src/main/java/org/apache/servicemix/cxfbc/CxfBcConsumer.java?rev=695723&r1=695722&r2=695723&view=diff
==============================================================================
--- servicemix/smx3/branches/servicemix-3.2/deployables/bindingcomponents/servicemix-cxf-bc/src/main/java/org/apache/servicemix/cxfbc/CxfBcConsumer.java (original)
+++ servicemix/smx3/branches/servicemix-3.2/deployables/bindingcomponents/servicemix-cxf-bc/src/main/java/org/apache/servicemix/cxfbc/CxfBcConsumer.java Mon Sep 15 21:10:04 2008
@@ -107,8 +107,8 @@
/**
*
* @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 {
@@ -159,41 +159,96 @@
}
/**
- * @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;
}
@@ -424,6 +479,14 @@
}
}
+ /**
+ * 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;
}
@@ -688,6 +751,15 @@
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;
}
@@ -696,6 +768,13 @@
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;
}
@@ -704,6 +783,14 @@
return mtomEnabled;
}
+ /**
+ * Specifies the interval for which the endpoint will wait for a
+ * response, This is specified in seconds.
+ *
+ * @param timeout the number of millis to wait for a response
+ * @org.apache.xbean.Property description="the number of millis the endpoint will wait for a response.
+ * The default is 1 hour."
+ **/
public void setTimeout(int timeout) {
this.timeout = timeout;
}
@@ -712,6 +799,14 @@
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/smx3/branches/servicemix-3.2/deployables/bindingcomponents/servicemix-cxf-bc/src/main/java/org/apache/servicemix/cxfbc/CxfBcProvider.java
URL: http://svn.apache.org/viewvc/servicemix/smx3/branches/servicemix-3.2/deployables/bindingcomponents/servicemix-cxf-bc/src/main/java/org/apache/servicemix/cxfbc/CxfBcProvider.java?rev=695723&r1=695722&r2=695723&view=diff
==============================================================================
--- servicemix/smx3/branches/servicemix-3.2/deployables/bindingcomponents/servicemix-cxf-bc/src/main/java/org/apache/servicemix/cxfbc/CxfBcProvider.java (original)
+++ servicemix/smx3/branches/servicemix-3.2/deployables/bindingcomponents/servicemix-cxf-bc/src/main/java/org/apache/servicemix/cxfbc/CxfBcProvider.java Mon Sep 15 21:10:04 2008
@@ -93,7 +93,8 @@
/**
*
* @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 {
@@ -292,38 +293,97 @@
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;
}
@@ -451,6 +511,15 @@
}
}
+ /**
+ * 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;
}
@@ -459,6 +528,14 @@
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;
}
@@ -477,6 +554,13 @@
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;
}
@@ -485,6 +569,14 @@
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;
}