servicemix-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ge...@apache.org
Subject svn commit: r683596 - in /servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common: Endpoint.java endpoints/ConsumerEndpoint.java endpoints/PollingEndpoint.java
Date Thu, 07 Aug 2008 12:06:07 GMT
Author: gertv
Date: Thu Aug  7 05:06:06 2008
New Revision: 683596

URL: http://svn.apache.org/viewvc?rev=683596&view=rev
Log:
SM-1494: Improve docs for shared library servicemix-common

Modified:
    servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/Endpoint.java
    servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/endpoints/ConsumerEndpoint.java
    servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/endpoints/PollingEndpoint.java

Modified: servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/Endpoint.java
URL: http://svn.apache.org/viewvc/servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/Endpoint.java?rev=683596&r1=683595&r2=683596&view=diff
==============================================================================
--- servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/Endpoint.java
(original)
+++ servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/Endpoint.java
Thu Aug  7 05:06:06 2008
@@ -53,8 +53,12 @@
     public String getEndpoint() {
         return endpoint;
     }
+
     /**
-     * @param endpoint The endpoint to set.
+     * Sets 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"
      */
     public void setEndpoint(String endpoint) {
         this.endpoint = endpoint;
@@ -66,37 +70,53 @@
     public QName getService() {
         return service;
     }
+
     /**
-     * @param service The service to set.
+     * Sets the 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"
      */
     public void setService(QName service) {
         this.service = service;
         this.key = null;
     }
+    
     /**
      * @return Returns the role.
      */
     public abstract Role getRole();
+    
     /**
      * @return Returns the description.
      */
     public Document getDescription() {
         return description;
     }
+
     /**
-     * @param description The description to set.
+     * Associates an XML document with the endpoint. The XML document describes 
+     * the endpoint and is typically found in the service unit packaging.
+     *
+     * @param	description	a <code>Document</code> describing the endpoint
+     * @org.apache.xbean.Property description="an XML document describing the endpoint"
      */
     public void setDescription(Document description) {
         this.description = description;
     }
+    
     /**
      * @return Returns the interfaceName.
      */
     public QName getInterfaceName() {
         return interfaceName;
     }
+
     /**
-     * @param interfaceName The interfaceName to set.
+     * Sets the QName 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"
      */
     public void setInterfaceName(QName interfaceName) {
         this.interfaceName = interfaceName;
@@ -109,7 +129,12 @@
     }
 
     /**
-     * @param serviceUnit The serviceUnit to set.
+     * 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"
      */
     public void setServiceUnit(ServiceUnit serviceUnit) {
         this.serviceUnit = serviceUnit;

Modified: servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/endpoints/ConsumerEndpoint.java
URL: http://svn.apache.org/viewvc/servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/endpoints/ConsumerEndpoint.java?rev=683596&r1=683595&r2=683596&view=diff
==============================================================================
--- servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/endpoints/ConsumerEndpoint.java
(original)
+++ servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/endpoints/ConsumerEndpoint.java
Thu Aug  7 05:06:06 2008
@@ -92,7 +92,10 @@
     }
 
     /**
-     * @param targetEndpoint the targetEndpoint to set
+     * Sets the endpoint name of the target endpoint.
+     *
+     * @param        targetEndpoint  a string specifiying the name of the target endpoint
+     * @org.apache.xbean.Property description="the name of the endpoint to which requests
are sent"
      */
     public void setTargetEndpoint(String targetEndpoint) {
         this.targetEndpoint = targetEndpoint;
@@ -106,7 +109,10 @@
     }
 
     /**
-     * @param targetInterface the targetInterface to set
+     * Sets the name of the target interface.
+     *
+     * @param        targetInterface a QName specifiying the name of the target interface
+     * @org.apache.xbean.Property description="the QName of the interface to which requests
are sent"
      */
     public void setTargetInterface(QName targetInterface) {
         this.targetInterface = targetInterface;
@@ -120,7 +126,10 @@
     }
 
     /**
-     * @param targetService the targetService to set
+     * Sets the name of the target service.
+     *
+     * @param        targetService   a QName specifiying the name of the target interface
+     * @org.apache.xbean.Property description="the QName of the service to which requests
are sent"
      */
     public void setTargetService(QName targetService) {
         this.targetService = targetService;
@@ -134,7 +143,10 @@
     }
 
     /**
-     * @param targetOperation the targetOperation to set
+     * Sets the name of the target operation.
+     *
+     * @param        targetOperation a QName specifiying the name of the target operation
+     * @org.apache.xbean.Property description="the QName of the operation to which requests
are sent"
      */
     public void setTargetOperation(QName targetOperation) {
         this.targetOperation = targetOperation;

Modified: servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/endpoints/PollingEndpoint.java
URL: http://svn.apache.org/viewvc/servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/endpoints/PollingEndpoint.java?rev=683596&r1=683595&r2=683596&view=diff
==============================================================================
--- servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/endpoints/PollingEndpoint.java
(original)
+++ servicemix/components/shared-libraries/trunk/servicemix-common/src/main/java/org/apache/servicemix/common/endpoints/PollingEndpoint.java
Thu Aug  7 05:06:06 2008
@@ -76,6 +76,12 @@
         return delay;
     }
 
+    /**
+     * Sets the amount of time the endpoint waits before making the first poll.
+     *
+     * @param        delay   a long specifying the number of milliseconds to wait
+     * @org.apache.xbean.Property description="the number of milliseconds to wait before
the first poll"
+     */
     public void setDelay(long delay) {
         this.delay = delay;
     }
@@ -84,6 +90,15 @@
         return firstTime;
     }
 
+    /**
+     * Sets the date on which the first poll will be executed. If a delay is 
+     * also set using <code>setDelay</code>, the delay interval will be added

+     * after the date specified,
+     *
+     * @param        firstTime       a <code>Date</code> specifying when to make
the 
+     *                               first polling attempt
+     * @org.apache.xbean.Property description="the date of the first polling attempt. The
date is specified using the <code>YYYY-MM-DD</code> format. The <code>delay</code>
value is added after the date."
+     */
     public void setFirstTime(Date firstTime) {
         this.firstTime = firstTime;
     }
@@ -92,6 +107,12 @@
         return period;
     }
 
+    /**
+     * Sets the number of milliseconds between polling attempts.
+     *
+     * @param        period  a long specifying the gap between polling attempts
+     * @org.apache.xbean.Property description="the number of milliseconds between polling
attempts"
+     */
     public void setPeriod(long period) {
         this.period = period;
     }



Mime
View raw message