Author: gertv
Date: Thu Dec 16 19:03:09 2010
New Revision: 1050098
URL: http://svn.apache.org/viewvc?rev=1050098&view=rev
Log:
SMXCOMP-833: Improve servicemix-ftp javadoc for wiki/xsd documentation
Modified:
servicemix/components/trunk/bindings/servicemix-ftp/src/main/java/org/apache/servicemix/ftp/FTPClientPool.java
servicemix/components/trunk/bindings/servicemix-ftp/src/main/java/org/apache/servicemix/ftp/FtpPollerEndpoint.java
servicemix/components/trunk/bindings/servicemix-ftp/src/main/java/org/apache/servicemix/ftp/FtpSenderEndpoint.java
servicemix/components/trunk/shared-libraries/servicemix-common/src/main/java/org/apache/servicemix/common/endpoints/PollingEndpoint.java
Modified:
servicemix/components/trunk/bindings/servicemix-ftp/src/main/java/org/apache/servicemix/ftp/FTPClientPool.java
URL:
http://svn.apache.org/viewvc/servicemix/components/trunk/bindings/servicemix-ftp/src/main/java/org/apache/servicemix/ftp/FTPClientPool.java?rev=1050098&r1=1050097&r2=1050098&view=diff
==============================================================================
---
servicemix/components/trunk/bindings/servicemix-ftp/src/main/java/org/apache/servicemix/ftp/FTPClientPool.java
(original)
+++
servicemix/components/trunk/bindings/servicemix-ftp/src/main/java/org/apache/servicemix/ftp/FTPClientPool.java
Thu Dec 16 19:03:09 2010
@@ -69,6 +69,11 @@ public class FTPClientPool extends Socke
return username;
}
+ /**
+ * Set the login to use to access the FTP server.
+ *
+ * @param username
+ */
public void setUsername(String username) {
this.username = username;
}
@@ -77,6 +82,11 @@ public class FTPClientPool extends Socke
return password;
}
+ /**
+ * Set the password for logging into the FTP server.
+ *
+ * @param password to set.
+ */
public void setPassword(String password) {
this.password = password;
}
@@ -85,6 +95,11 @@ public class FTPClientPool extends Socke
return binaryMode;
}
+ /**
+ * Use binary mode transfers. Defaults to <code>true</code>.
+ *
+ * @param binaryMode is a boolean setting the type of data transfer to
binary. Default value is true.
+ */
public void setBinaryMode(boolean binaryMode) {
this.binaryMode = binaryMode;
}
@@ -97,7 +112,9 @@ public class FTPClientPool extends Socke
}
/**
- * @param passiveMode the passiveMode to set
+ * Use passive mode FTP transfers. Defaults to <code>false</code>
+ *
+ * @param passiveMode is a boolean setting the type into passive mode.
*/
public void setPassiveMode(boolean passiveMode) {
this.passiveMode = passiveMode;
@@ -107,6 +124,11 @@ public class FTPClientPool extends Socke
return config;
}
+ /**
+ * Configure a custom FTPClientConfig instance to allow more fine-grained
control over the FTP connections in the pool.
+ *
+ * @param config the <code>config</code> implementation to use.
+ */
public void setConfig(FTPClientConfig config) {
this.config = config;
}
@@ -119,6 +141,8 @@ public class FTPClientPool extends Socke
}
/**
+ * Configure the encoding used in the FTP control connections. Defaults
to <code>ISO-8859-1</code>
+ *
* @param controlEncoding the controlEncoding to set
*/
public void setControlEncoding(String controlEncoding) {
@@ -132,8 +156,12 @@ public class FTPClientPool extends Socke
return dataTimeout;
}
+
/**
- * @param dataTimeout the dataTimeout to set
+ * Specifies a timeout used on the FTP data connection. Defaults to
<code>120000</code>
+ *
+ * @param dataTimeout after which the connection should be closed.
+ * .
*/
public void setDataTimeout(int dataTimeout) {
this.dataTimeout = dataTimeout;
Modified:
servicemix/components/trunk/bindings/servicemix-ftp/src/main/java/org/apache/servicemix/ftp/FtpPollerEndpoint.java
URL:
http://svn.apache.org/viewvc/servicemix/components/trunk/bindings/servicemix-ftp/src/main/java/org/apache/servicemix/ftp/FtpPollerEndpoint.java?rev=1050098&r1=1050097&r2=1050098&view=diff
==============================================================================
---
servicemix/components/trunk/bindings/servicemix-ftp/src/main/java/org/apache/servicemix/ftp/FtpPollerEndpoint.java
(original)
+++
servicemix/components/trunk/bindings/servicemix-ftp/src/main/java/org/apache/servicemix/ftp/FtpPollerEndpoint.java
Thu Dec 16 19:03:09 2010
@@ -88,6 +88,13 @@ public class FtpPollerEndpoint extends P
super(serviceUnit, service, endpoint);
}
+ /**
+ * Bean defining the class implementing the JBI DefaultComponent. This bean
+ * must be an implementation of the
+ * <code>org.apache.servicemix.common.DefaultComponent</code> class.
+ *
+ * @param component the <code>component</code> implementation to use
+ */
public FtpPollerEndpoint(DefaultComponent component, ServiceEndpoint
endpoint) {
super(component, endpoint);
}
@@ -221,7 +228,10 @@ public class FtpPollerEndpoint extends P
}
/**
- * @param clientPool the clientPool to set
+ * Set a custom FTPClientPool. If this property has not been set, the FTP
client pool will be created based on the information
+ * provided in the URI.
+ *
+ * @param clientPool the <code>clientPool</code> implementation to use
*/
public void setClientPool(FTPClientPool clientPool) {
this.clientPool = clientPool;
@@ -235,7 +245,7 @@ public class FtpPollerEndpoint extends P
}
/**
- * @param uri the uri to set
+ * Configures the endpoint from a URI.
*/
public void setUri(URI uri) {
this.uri = uri;
@@ -246,19 +256,21 @@ public class FtpPollerEndpoint extends P
}
/**
- * Sets the optional filter to choose which files to process
+ * Sets the filter to select which files have to be processed. When not
set, all files will be picked up by the poller.
*/
public void setFilter(FileFilter filter) {
this.filter = filter;
}
- /**
- * Returns whether or not we should delete the file when its processed
- */
public boolean isDeleteFile() {
return deleteFile;
}
+ /**
+ * Delete the file after it has been succesfully processed? Defaults to
<code>true</code>
+ *
+ * @param deleteFile
+ */
public void setDeleteFile(boolean deleteFile) {
this.deleteFile = deleteFile;
}
@@ -267,6 +279,12 @@ public class FtpPollerEndpoint extends P
return recursive;
}
+ /**
+ * Specifies whether subdirectories should be polled. Defaults to
<code>true</code>
+ *
+ * @param recursive is a boolean specifying whether subdirectories should
be polled. Default value is true.
+ * .
+ */
public void setRecursive(boolean recursive) {
this.recursive = recursive;
}
@@ -275,6 +293,12 @@ public class FtpPollerEndpoint extends P
return marshaler;
}
+ /**
+ * Set a custom FileMarshaler implementation to control how the file
contents is being translated into a JBI message.
+ * The default implementation reads XML contents from the file.
+ *
+ * @param marshaler the <code>marshaler</code> implementation to use
+ */
public void setMarshaler(FileMarshaler marshaler) {
this.marshaler = marshaler;
}
@@ -283,10 +307,22 @@ public class FtpPollerEndpoint extends P
return targetOperation;
}
+ /**
+ * Set the operation to be invoked on the target service.
+ *
+ * @param targetOperation a QName specifiying the name of the target
operation
+ */
public void setTargetOperation(QName targetOperation) {
this.targetOperation = targetOperation;
}
+ /**
+ * When set to <code>true</code>, the poller will do an explicit
<code>cwd</code> into the directory to be polled.
+ * Default to <code>false</code>. Recursive polling will not be possible
if this feature is enabled.
+ *
+ * @param changeWorkingDirectory is a boolean specifying if the endpoint
can change the working directory
+ * .
+ */
public void setChangeWorkingDirectory(boolean changeWorkingDirectory) {
this.changeWorkingDirectory = changeWorkingDirectory;
}
@@ -295,6 +331,12 @@ public class FtpPollerEndpoint extends P
return stateless;
}
+ /**
+ * When set to <code>false</code>
+ *
+ * @param stateless is a boolean specifying whether the polled file should
be sent asynchronous or synchronous to the nmr. Default value is true.
+ * .
+ */
public void setStateless(boolean stateless) {
this.stateless = stateless;
}
@@ -331,11 +373,8 @@ public class FtpPollerEndpoint extends P
}
/**
- * Bean defining the class implementing the file locking strategy. This
bean
- * must be an implementation of the
- * <code>org.apache.servicemix.locks.LockManager</code> interface. By
- * default, this will be set to an instances of
- * <code>org.apache.servicemix.common.locks.impl.SimpleLockManager</code>.
+ * Set a custom LockManager implementation for keeping track of which
files are already being processed.
+ * The default implementation is a simple, in-memory lock management
system.
*
* @param lockManager the <code>LockManager</code> implementation to use
*/
@@ -484,6 +523,8 @@ public class FtpPollerEndpoint extends P
send(exchange);
}
+
+
public String getLocationURI() {
return uri.toString();
}
Modified:
servicemix/components/trunk/bindings/servicemix-ftp/src/main/java/org/apache/servicemix/ftp/FtpSenderEndpoint.java
URL:
http://svn.apache.org/viewvc/servicemix/components/trunk/bindings/servicemix-ftp/src/main/java/org/apache/servicemix/ftp/FtpSenderEndpoint.java?rev=1050098&r1=1050097&r2=1050098&view=diff
==============================================================================
---
servicemix/components/trunk/bindings/servicemix-ftp/src/main/java/org/apache/servicemix/ftp/FtpSenderEndpoint.java
(original)
+++
servicemix/components/trunk/bindings/servicemix-ftp/src/main/java/org/apache/servicemix/ftp/FtpSenderEndpoint.java
Thu Dec 16 19:03:09 2010
@@ -80,6 +80,12 @@ public class FtpSenderEndpoint extends P
return checkDuplicates;
}
+ /**
+ * Specifies whether duplicates should be checked. Defaults to
<code>true</code>.
+ *
+ * @param checkDuplicates is a boolean specifying whether duplicate should
be checked. Default value is true.
+ * .
+ */
public void setCheckDuplicates(boolean checkDuplicates) {
this.checkDuplicates = checkDuplicates;
}
@@ -139,6 +145,12 @@ public class FtpSenderEndpoint extends P
return clientPool;
}
+ /**
+ * Set a custom FTPClientPool. If this property has not been set, the FTP
client pool will be created based on the information
+ * provided in the URI.
+ *
+ * @param clientPool the <code>clientPool</code> implementation to use
+ */
public void setClientPool(FTPClientPool clientPool) {
this.clientPool = clientPool;
}
@@ -147,6 +159,12 @@ public class FtpSenderEndpoint extends P
return marshaler;
}
+ /**
+ * Set a custom FileMarshaler implementation to control how the file
contents is being translated into a JBI message.
+ * The default implementation reads XML contents from the file.
+ *
+ * @param marshaler the <code>marshaler</code> implementation to use
+ */
public void setMarshaler(FileMarshaler marshaler) {
this.marshaler = marshaler;
}
@@ -168,6 +186,12 @@ public class FtpSenderEndpoint extends P
return overwrite;
}
+ /**
+ * Specifies if a file with the same name already exists on the FTP
server, the file should be overwritten.
+ * Defaults to <code>false</code>.
+ *
+ * @param overwrite if a file with the same name already exists on the
FTP server, the file should be overwritten.
+ */
public void setOverwrite(boolean overwrite) {
this.overwrite = overwrite;
}
Modified:
servicemix/components/trunk/shared-libraries/servicemix-common/src/main/java/org/apache/servicemix/common/endpoints/PollingEndpoint.java
URL:
http://svn.apache.org/viewvc/servicemix/components/trunk/shared-libraries/servicemix-common/src/main/java/org/apache/servicemix/common/endpoints/PollingEndpoint.java?rev=1050098&r1=1050097&r2=1050098&view=diff
==============================================================================
---
servicemix/components/trunk/shared-libraries/servicemix-common/src/main/java/org/apache/servicemix/common/endpoints/PollingEndpoint.java
(original)
+++
servicemix/components/trunk/shared-libraries/servicemix-common/src/main/java/org/apache/servicemix/common/endpoints/PollingEndpoint.java
Thu Dec 16 19:03:09 2010
@@ -138,6 +138,11 @@ public abstract class PollingEndpoint ex
return scheduler;
}
+ /**
+ * Set a custom Scheduler implementation if you need more fine-grained
control over the polling schedule.
+ *
+ * @param scheduler
+ */
public void setScheduler(Scheduler scheduler) {
this.scheduler = scheduler;
}
