/*
* 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.oodt.cas.protocol.ftp;
//JDK imports
import java.io.File;
import java.io.IOException;
import java.util.List;
import java.util.Vector;
//Globus imports
import org.apache.oodt.cas.protocol.Protocol;
import org.apache.oodt.cas.protocol.ProtocolFile;
import org.apache.oodt.cas.protocol.auth.Authentication;
import org.apache.oodt.cas.protocol.exceptions.ProtocolException;
import org.apache.oodt.cas.protocol.util.ProtocolFileFilter;
import org.globus.ftp.FTPClient;
import org.globus.ftp.FileInfo;
import org.globus.ftp.HostPort;
import org.globus.ftp.exception.ClientException;
import org.globus.ftp.exception.ServerException;
/**
* FTP implementation of a {@link Protocol}
*
* @author bfoster
*/
public class CogJGlobusFtpProtocol implements Protocol {
private FTPClient ftp;
private boolean isConnected;
private int port;
private String homeDir;
public CogJGlobusFtpProtocol() {
this(21);
}
public CogJGlobusFtpProtocol(int port) {
this.port = port;
}
public void cd(ProtocolFile file) throws ProtocolException {
try {
ftp.changeDir(file.getPath());
} catch (Exception e) {
throw new ProtocolException("Failed to cd to " + file + " : "
+ e.getMessage());
}
}
public void cdRoot() throws ProtocolException {
cd(new ProtocolFile(ProtocolFile.SEPARATOR, true));
}
public void cdHome() throws ProtocolException {
cd(new ProtocolFile(homeDir, true));
}
public void connect(String host, Authentication auth) throws ProtocolException {
try {
ftp = new FTPClient(host, port);
} catch (Exception e) {
throw new ProtocolException("Failed to connect to: " + host + " : "
+ e.getMessage(), e);
}
isConnected = true;
try {
ftp.authorize(auth.getUser(), auth.getPass());
ftp.setActive(ftp.setLocalPassive());
homeDir = ftp.getCurrentDir();
} catch (Exception e) {
throw new ProtocolException("Failed to login to: " + host + " : "
+ e.getMessage(), e);
}
}
public void close() throws ProtocolException {
try {
ftp.close();
isConnected = false;
} catch (Exception e) {
throw new ProtocolException("Error disconnecting from "
+ ftp.getHost() + " : " + e.getMessage());
}
}
public void get(ProtocolFile fromFile, File toFile)
throws ProtocolException {
try {
ftp.setActive(ftp.setLocalPassive());
ftp.get(fromFile.getPath(), toFile);
} catch (Exception e) {
throw new ProtocolException("Failed to download: " + fromFile.getName()
+ " : " + e.getMessage());
}
}
public void put(File fromFile, ProtocolFile toFile) throws ProtocolException {
try {
ftp.put(fromFile, toFile.getPath(), false);
}catch (Exception e) {
throw new ProtocolException("Failed to put file '" + fromFile + "' : " + e.getMessage(), e);
}
}
/**
* SetActive
* Sets the FTP Active Protocol
* Package protected so we can test the non FTP server parts of the codebase.
* @throws ProtocolException
*/
protected void setActive() throws ProtocolException {
try {
ftp.setActive(ftp.setLocalPassive());
} catch (Exception e) {
throw new ProtocolException("Failed to set ftp active : "
+ e.getMessage());
}
}
/**
* ftpList
* Gets a file list from the FTP Server
* Package protected so we can test the non server portion of the code.
* @param filter
* @param modifier
* @return
*/
protected Vector ftpList(String filter, String modifier) throws ProtocolException {
try {
return ftp.list(filter, modifier);
} catch (Exception e) {
throw new ProtocolException("Failed to get list of files : "
+ e.getMessage());
}
}
public List<ProtocolFile> ls() throws ProtocolException {
try {
setActive();
@SuppressWarnings("unchecked")
Vector<FileInfo> fileList = (Vector<FileInfo>) ftpList("*", null);
Vector<ProtocolFile> returnList = new Vector<ProtocolFile>();
for (FileInfo file : fileList) {
returnList.add(new ProtocolFile(this.pwd(), file.getName(), file.isDirectory()));
}
return returnList;
} catch (Exception e) {
throw new ProtocolException("Failed to get list of files : "
+ e.getMessage());
}
}
public List<ProtocolFile> ls(ProtocolFileFilter filter) throws ProtocolException {
try {
ftp.setActive(ftp.setLocalPassive());
@SuppressWarnings("unchecked")
Vector<FileInfo> fileList = (Vector<FileInfo>) ftp.list("*", null);
Vector<ProtocolFile> returnList = new Vector<ProtocolFile>();
for (FileInfo file : fileList) {
ProtocolFile pFile = new ProtocolFile(this.pwd(), file.getName(), file.isDirectory());
if (filter.accept(pFile)) {
returnList.add(pFile);
}
}
return returnList;
} catch (Exception e) {
throw new ProtocolException("Failed to get list of files : "
+ e.getMessage());
}
}
/**
* Returns the current Directory.
* Package protected so we can test the non ftp parts of the codebase.
* @return
* @throws ProtocolException
*/
protected String getCurentDir() throws ProtocolException {
try {
return ftp.getCurrentDir();
} catch (Exception e) {
throw new ProtocolException("Failed to get current directory : "
+ e.getMessage());
}
}
public ProtocolFile pwd() throws ProtocolException {
try {
return new ProtocolFile(getCurentDir(), true);
} catch (Exception e) {
throw new ProtocolException("Failed to pwd : " + e.getMessage());
}
}
public boolean connected() {
return isConnected;
}
public void delete(ProtocolFile file) throws ProtocolException {
try {
ftp.deleteFile(file.getPath());
} catch (Exception e) {
throw new ProtocolException("Failed to download file '"
+ file.getPath() + "' : " + e.getMessage(), e);
}
}
}