Author: gnodet
Date: Mon Jan 26 08:40:05 2009
New Revision: 737651
URL: http://svn.apache.org/viewvc?rev=737651&view=rev
Log:
SM-1778: Improve servicemix-eip schema documentation
Modified:
servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/AsyncBaseLifeCycle.java
servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/endpoints/AbstractEndpoint.java
Modified:
servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/AsyncBaseLifeCycle.java
URL:
http://svn.apache.org/viewvc/servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/AsyncBaseLifeCycle.java?rev=737651&r1=737650&r2=737651&view=diff
==============================================================================
---
servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/AsyncBaseLifeCycle.java
(original)
+++
servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/AsyncBaseLifeCycle.java
Mon Jan 26 08:40:05 2009
@@ -107,6 +107,9 @@
return container;
}
+ /**
+ * @org.apache.xbean.Property hidden="true"
+ */
protected void setComponent(ServiceMixComponent component) {
this.component = component;
this.logger = component.getLogger();
@@ -136,7 +139,10 @@
public String getCurrentState() {
return currentState;
}
-
+
+ /**
+ * @org.apache.xbean.Property hidden="true"
+ */
protected void setCurrentState(String currentState) {
this.currentState = currentState;
}
@@ -409,6 +415,13 @@
return executor;
}
+ /**
+ * The executor to use for various tasks that need to be performed by the
component.
+ * If none is provided, one will be created from the executorFactory.
+ *
+ * @param executor
+ * @see #setExecutorFactory(ExecutorFactory)
+ */
public void setExecutor(Executor executor) {
this.executor = executor;
}
@@ -417,6 +430,14 @@
return executorFactory;
}
+ /**
+ * The executor factory to use to create the executor.
+ * If none is provided, one will be retrieved from the JBI container when
the component
+ * is deployed into ServiceMix 3.x, or a default implementation will be
used.
+ *
+ * @param executorFactory
+ * @see #setExecutor(Executor)
+ */
public void setExecutorFactory(ExecutorFactory executorFactory) {
this.executorFactory = executorFactory;
}
Modified:
servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/endpoints/AbstractEndpoint.java
URL:
http://svn.apache.org/viewvc/servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/endpoints/AbstractEndpoint.java?rev=737651&r1=737650&r2=737651&view=diff
==============================================================================
---
servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/endpoints/AbstractEndpoint.java
(original)
+++
servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/endpoints/AbstractEndpoint.java
Mon Jan 26 08:40:05 2009
@@ -59,10 +59,10 @@
}
/**
- * Sets the name of the endpoint.
+ * The name of the endpoint.
*
* @param endpoint a string specifiying the name of the endpoint
- * @org.apache.xbean.Property description="the name of the endpoint"
+ * @org.apache.xbean.Property
*/
public void setEndpoint(String endpoint) {
this.endpoint = endpoint;
@@ -77,10 +77,10 @@
}
/**
- * Sets the name of the service the endpoint exposes.
+ * The qualified name of the service the endpoint exposes.
*
* @param service a QName specifiying the name of the service
- * @org.apache.xbean.Property description="the QName of the service
exposed by the endpoint"
+ * @org.apache.xbean.Property
*/
public void setService(QName service) {
this.service = service;
@@ -104,7 +104,7 @@
* unit packaging.
*
* @param description a <code>Document</code> describing the endpoint
- * @org.apache.xbean.Property description="an XML document describing the
endpoint"
+ * @org.apache.xbean.Property description="an XML document describing the
endpoint" hidden="true"
*/
public void setDescription(Document description) {
this.description = description;
@@ -118,10 +118,10 @@
}
/**
- * Sets the QName of the interface exposed by the endpoint.
+ * The qualified name of the interface exposed by the endpoint.
*
* @param interfaceName a QName specifiying the name of the interface
- * @org.apache.xbean.Property description="the QName of the interface
exposed by the endpoint"
+ * @org.apache.xbean.Property
*/
public void setInterfaceName(QName interfaceName) {
this.interfaceName = interfaceName;
@@ -138,7 +138,7 @@
* Associates an endpoint with a service unit. The service unit is used by
the container to manage the endpoint's lifecycle.
*
* @param serviceUnit a <code>ServiceUnit</code> to which the endpoint
will be associated
- * @org.apache.xbean.Property description="the service unit responsible
for the endpoint"
+ * @org.apache.xbean.Property description="the service unit responsible
for the endpoint" hidden="true
*/
public void setServiceUnit(ServiceUnit serviceUnit) {
this.serviceUnit = serviceUnit;
@@ -181,6 +181,10 @@
return definition;
}
+ /**
+ * @param definition
+ * @org.apache.xbean.Property hidden="true"
+ */
public void setDefinition(Definition definition) {
this.definition = definition;
}
