Add org.apache.commons.vfs2.provider.ftp.FTPClientWrapper.sendOptions(String,

String)

Author: garydgregory

commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FTPClientWrapper.java

@@ -24,6 +24,7 @@
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import org.apache.commons.net.ftp.FTPClient;
+import org.apache.commons.net.ftp.FTPConnectionClosedException;
 import org.apache.commons.net.ftp.FTPFile;
 import org.apache.commons.net.ftp.FTPReply;
 import org.apache.commons.vfs2.FileSystemException;
@@ -94,17 +95,14 @@ public boolean completePendingCommand() throws IOException {
         if (ftpClient != null) {
             return getFtpClient().completePendingCommand();
         }
-
         return true;
     }
 
     private FTPClient createClient() throws FileSystemException {
         final GenericFileName rootName = getRoot();
-
         UserAuthenticationData authData = null;
         try {
             authData = UserAuthenticatorUtils.authenticate(fileSystemOptions, FtpFileProvider.AUTHENTICATOR_TYPES);
-
             return createClient(rootName, authData);
         } finally {
             UserAuthenticatorUtils.cleanup(authData);
@@ -168,7 +166,6 @@ private FTPClient getFtpClient() throws FileSystemException {
         if (ftpClient == null) {
             ftpClient = createClient();
         }
-
         return ftpClient;
     }
 
@@ -328,6 +325,32 @@ public InputStream retrieveFileStream(final String relPath, final long restartOf
         }
     }
 
+    /**
+     * A convenience method to send the FTP OPTS command to the server, receive the reply, and return the reply code.
+     * <p>
+     * FTP request Syntax:
+     * </p>
+     * <pre>{@code
+     * opts             = opts-cmd SP command-name
+     *                         [ SP command-options ] CRLF
+     * opts-cmd         = "opts"
+     * command-name     = <any FTP command which allows option setting>
+     * command-options  = <format specified by individual FTP command>
+     * }</pre>
+     * @param commandName The OPTS command name.
+     * @param commandOptions The OPTS command options.
+     * @return The reply code received from the server.
+     * @throws FTPConnectionClosedException If the FTP server prematurely closes the connection as a result of the client being idle or some other reason
+     *                                      causing the server to send FTP reply code 421. This exception may be caught either as an IOException or
+     *                                      independently as itself.
+     * @throws IOException                  If an I/O error occurs while either sending the command or receiving the server reply.
+     */
+    public int sendOptions(final String commandName, String commandOptions) throws IOException {
+        // Commons Net 3.12.0
+        // return getFtpClient().opts(commandName, commandOptions);
+        return getFtpClient().sendCommand("OPTS", commandName + ' ' + commandOptions);
+    }
+
     @Override
     public void setBufferSize(final int bufferSize) throws FileSystemException {
         getFtpClient().setBufferSize(bufferSize);

commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/ftp/FtpProviderTestCase.java

@@ -23,14 +23,13 @@
 import java.nio.charset.StandardCharsets;
 import java.time.Duration;
 
-import junit.framework.Test;
-
 import org.apache.commons.vfs2.AbstractProviderTestCase;
 import org.apache.commons.vfs2.AbstractProviderTestConfig;
 import org.apache.commons.vfs2.FileObject;
 import org.apache.commons.vfs2.FileSystemManager;
 import org.apache.commons.vfs2.FileSystemOptions;
 import org.apache.commons.vfs2.ProviderTestSuite;
+import org.apache.commons.vfs2.impl.DecoratedFileObject;
 import org.apache.commons.vfs2.impl.DefaultFileSystemManager;
 import org.apache.ftpserver.FtpServer;
 import org.apache.ftpserver.FtpServerFactory;
@@ -44,6 +43,8 @@
 import org.apache.ftpserver.usermanager.impl.BaseUser;
 import org.junit.jupiter.api.Assertions;
 
+import junit.framework.Test;
+
 /**
  * Tests for FTP file systems.
  */
@@ -202,7 +203,16 @@ public FileObject getBaseTestFolder(final FileSystemManager manager) throws Exce
         final FileSystemOptions options = new FileSystemOptions();
         final FtpFileSystemConfigBuilder builder = FtpFileSystemConfigBuilder.getInstance();
         init(builder, options);
-        return manager.resolveFile(uri, options);
+        // OPTS UTF-8
+        final FileObject remoteFolder = manager.resolveFile(uri, options);
+        final FtpFileObject ftpFileObject = remoteFolder instanceof DecoratedFileObject
+                ? (FtpFileObject) ((DecoratedFileObject) remoteFolder).getDecoratedFileObject()
+                : (FtpFileObject) remoteFolder;
+        final FtpFileSystem ftpFileSystem = (FtpFileSystem) ftpFileObject.getFileSystem();
+        final FTPClientWrapper client = (FTPClientWrapper) ftpFileSystem.getClient();
+        // TODO Needs Apache Commons Net 3.12.0
+        // client.sendOptions("UTF-8", "NLST");
+        return remoteFolder;
     }
 
     /**

src/changes/changes.xml

@@ -48,6 +48,7 @@ The <action> type attribute can be add,update,fix,remove.
     <release version="2.10.1" date="YYYY-MM-DD" description="This is a feature and maintenance release. Java 8 or later is required.">
       <!-- FIX -->
       <!-- ADD -->
+      <action dev="ggregory" type="update" due-to="Gary Gregory">Add org.apache.commons.vfs2.provider.ftp.FTPClientWrapper.sendOptions(String, String).</action>
       <!-- UPDATE -->
       <action dev="ggregory" type="update" due-to="Gary Gregory">Bump org.apache.ftpserver:ftpserver-core from 1.2.0 to 1.2.1.</action>
       <action dev="ggregory" type="update" due-to="Gary Gregory">Bump org.apache.mina:mina-core from 2.1.10 to 2.2.4.</action>