001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.vfs2.provider.ftp;
018
019import java.io.IOException;
020import java.io.InputStream;
021import java.io.OutputStream;
022
023import org.apache.commons.net.ftp.FTPFile;
024import org.apache.commons.vfs2.FileSystemException;
025
026/**
027 * What VFS expects from an ftp client to provide.
028 */
029public interface FtpClient
030{
031    boolean isConnected() throws FileSystemException;
032
033    void disconnect() throws IOException;
034
035    FTPFile[] listFiles(String relPath) throws IOException;
036
037    boolean removeDirectory(String relPath) throws IOException;
038
039    boolean deleteFile(String relPath) throws IOException;
040
041    boolean rename(String oldName, String newName) throws IOException;
042
043    boolean makeDirectory(String relPath) throws IOException;
044
045    boolean completePendingCommand() throws IOException;
046
047    InputStream retrieveFileStream(String relPath) throws IOException;
048
049    InputStream retrieveFileStream(String relPath, long restartOffset) throws IOException;
050
051    OutputStream appendFileStream(String relPath) throws IOException;
052
053    OutputStream storeFileStream(String relPath) throws IOException;
054
055    boolean abort() throws IOException;
056
057    String getReplyString() throws IOException;
058}