org.apache.commons.vfs2.provider.ftp.FtpClientFactory Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-vfs2 Show documentation
Show all versions of commons-vfs2 Show documentation
Apache Commons VFS is a Virtual File System library.
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.vfs2.provider.ftp;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.io.Writer;
import java.net.Proxy;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.commons.net.PrintCommandListener;
import org.apache.commons.net.ftp.FTPClient;
import org.apache.commons.net.ftp.FTPClientConfig;
import org.apache.commons.net.ftp.FTPReply;
import org.apache.commons.net.ftp.parser.FTPFileEntryParserFactory;
import org.apache.commons.vfs2.FileSystemException;
import org.apache.commons.vfs2.FileSystemOptions;
import org.apache.commons.vfs2.util.UserAuthenticatorUtils;
/**
* Create a FtpClient instance.
*/
public final class FtpClientFactory {
private FtpClientFactory() {
}
/**
* Creates a new connection to the server.
*
* @param hostname The host name of the server.
* @param port The port to connect to.
* @param username The name of the user for authentication.
* @param password The user's password.
* @param workingDirectory The base directory.
* @param fileSystemOptions The FileSystemOptions.
* @return An FTPClient.
* @throws FileSystemException if an error occurs while connecting.
*/
public static FTPClient createConnection(final String hostname, final int port, final char[] username,
final char[] password, final String workingDirectory, final FileSystemOptions fileSystemOptions)
throws FileSystemException {
final FtpConnectionFactory factory = new FtpConnectionFactory(FtpFileSystemConfigBuilder.getInstance());
return factory.createConnection(hostname, port, username, password, workingDirectory, fileSystemOptions);
}
/** Connection Factory, used to configure the FTPClient. */
public static final class FtpConnectionFactory extends ConnectionFactory {
private FtpConnectionFactory(final FtpFileSystemConfigBuilder builder) {
super(builder);
}
@Override
protected FTPClient createClient(final FileSystemOptions fileSystemOptions) {
return new FTPClient();
}
@Override
protected void setupOpenConnection(final FTPClient client, final FileSystemOptions fileSystemOptions) {
// nothing to do for FTP
}
}
/**
* Abstract Factory, used to configure different FTPClients.
*
* @param
* The type of FTPClient.
* @param
* The type of FtpFileSystemConfigBuilder
*/
public abstract static class ConnectionFactory {
private static final char[] ANON_CHAR_ARRAY = "anonymous".toCharArray();
private static final int BUFSZ = 40;
private final Log log = LogFactory.getLog(getClass());
protected B builder;
protected ConnectionFactory(final B builder) {
this.builder = builder;
}
public C createConnection(final String hostname, final int port, char[] username, char[] password,
final String workingDirectory, final FileSystemOptions fileSystemOptions) throws FileSystemException {
// Determine the username and password to use
if (username == null) {
username = ANON_CHAR_ARRAY;
}
if (password == null) {
password = ANON_CHAR_ARRAY;
}
try {
final C client = createClient(fileSystemOptions);
if (log.isDebugEnabled()) {
final Writer writer = new StringWriter(1024) {
@Override
public void flush() {
final StringBuffer buffer = getBuffer();
String message = buffer.toString();
if (message.toUpperCase().startsWith("PASS ") && message.length() > 5) {
message = "PASS ***";
}
log.debug(message);
buffer.setLength(0);
}
};
client.addProtocolCommandListener(new PrintCommandListener(new PrintWriter(writer)));
}
configureClient(fileSystemOptions, client);
final FTPFileEntryParserFactory myFactory = builder.getEntryParserFactory(fileSystemOptions);
if (myFactory != null) {
client.setParserFactory(myFactory);
}
final Boolean remoteVerification = builder.getRemoteVerification(fileSystemOptions);
if (remoteVerification != null) {
client.setRemoteVerificationEnabled(remoteVerification.booleanValue());
}
try {
// Set connect timeout
final Integer connectTimeout = builder.getConnectTimeout(fileSystemOptions);
if (connectTimeout != null) {
client.setDefaultTimeout(connectTimeout.intValue());
}
final String controlEncoding = builder.getControlEncoding(fileSystemOptions);
if (controlEncoding != null) {
client.setControlEncoding(controlEncoding);
}
final Boolean autodetectUTF8 = builder.getAutodetectUtf8(fileSystemOptions);
if (autodetectUTF8 != null) {
client.setAutodetectUTF8(autodetectUTF8);
}
final Proxy proxy = builder.getProxy(fileSystemOptions);
if (proxy != null) {
client.setProxy(proxy);
}
client.connect(hostname, port);
final int reply = client.getReplyCode();
if (!FTPReply.isPositiveCompletion(reply)) {
throw new FileSystemException("vfs.provider.ftp/connect-rejected.error", hostname);
}
// Login
if (!client.login(UserAuthenticatorUtils.toString(username),
UserAuthenticatorUtils.toString(password))) {
throw new FileSystemException("vfs.provider.ftp/login.error", hostname,
UserAuthenticatorUtils.toString(username));
}
FtpFileType fileType = builder.getFileType(fileSystemOptions);
if (fileType == null) {
fileType = FtpFileType.BINARY;
}
// Set binary mode
if (!client.setFileType(fileType.getValue())) {
throw new FileSystemException("vfs.provider.ftp/set-file-type.error", fileType);
}
// Set dataTimeout value
final Integer dataTimeout = builder.getDataTimeout(fileSystemOptions);
if (dataTimeout != null) {
client.setDataTimeout(dataTimeout.intValue());
}
final Integer socketTimeout = builder.getSoTimeout(fileSystemOptions);
if (socketTimeout != null) {
client.setSoTimeout(socketTimeout.intValue());
}
final Boolean userDirIsRoot = builder.getUserDirIsRoot(fileSystemOptions);
if (workingDirectory != null && (userDirIsRoot == null || !userDirIsRoot.booleanValue())) {
if (!client.changeWorkingDirectory(workingDirectory)) {
throw new FileSystemException("vfs.provider.ftp/change-work-directory.error",
workingDirectory);
}
}
final Boolean passiveMode = builder.getPassiveMode(fileSystemOptions);
if (passiveMode != null && passiveMode.booleanValue()) {
client.enterLocalPassiveMode();
}
setupOpenConnection(client, fileSystemOptions);
} catch (final IOException e) {
if (client.isConnected()) {
client.disconnect();
}
throw e;
}
return client;
} catch (final Exception exc) {
throw new FileSystemException("vfs.provider.ftp/connect.error", exc, hostname);
}
}
protected abstract C createClient(FileSystemOptions fileSystemOptions) throws FileSystemException;
protected abstract void setupOpenConnection(C client, FileSystemOptions fileSystemOptions) throws IOException;
private void configureClient(final FileSystemOptions fileSystemOptions, final C client) {
final String key = builder.getEntryParser(fileSystemOptions);
if (key != null) {
final FTPClientConfig config = new FTPClientConfig(key);
final String serverLanguageCode = builder.getServerLanguageCode(fileSystemOptions);
if (serverLanguageCode != null) {
config.setServerLanguageCode(serverLanguageCode);
}
final String defaultDateFormat = builder.getDefaultDateFormat(fileSystemOptions);
if (defaultDateFormat != null) {
config.setDefaultDateFormatStr(defaultDateFormat);
}
final String recentDateFormat = builder.getRecentDateFormat(fileSystemOptions);
if (recentDateFormat != null) {
config.setRecentDateFormatStr(recentDateFormat);
}
final String serverTimeZoneId = builder.getServerTimeZoneId(fileSystemOptions);
if (serverTimeZoneId != null) {
config.setServerTimeZoneId(serverTimeZoneId);
}
final String[] shortMonthNames = builder.getShortMonthNames(fileSystemOptions);
if (shortMonthNames != null) {
final StringBuilder shortMonthNamesStr = new StringBuilder(BUFSZ);
for (final String shortMonthName : shortMonthNames) {
if (shortMonthNamesStr.length() > 0) {
shortMonthNamesStr.append("|");
}
shortMonthNamesStr.append(shortMonthName);
}
config.setShortMonthNames(shortMonthNamesStr.toString());
}
client.configure(config);
}
}
}
}