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     */
017    package org.apache.commons.vfs2.provider.ftp;
018    
019    import java.io.IOException;
020    import java.io.InputStream;
021    import java.io.OutputStream;
022    
023    import org.apache.commons.net.ftp.FTPFile;
024    import org.apache.commons.vfs2.FileSystemException;
025    
026    /**
027     * What VFS expects from an ftp client to provide.
028     * @author <a href="http://commons.apache.org/vfs/team-list.html">Commons VFS team</a>
029     */
030    public interface FtpClient
031    {
032        boolean isConnected() throws FileSystemException;
033    
034        void disconnect() throws IOException;
035    
036        FTPFile[] listFiles(String relPath) throws IOException;
037    
038        boolean removeDirectory(String relPath) throws IOException;
039    
040        boolean deleteFile(String relPath) throws IOException;
041    
042        boolean rename(String oldName, String newName) throws IOException;
043    
044        boolean makeDirectory(String relPath) throws IOException;
045    
046        boolean completePendingCommand() throws IOException;
047    
048        InputStream retrieveFileStream(String relPath) throws IOException;
049    
050        InputStream retrieveFileStream(String relPath, long restartOffset) throws IOException;
051    
052        OutputStream appendFileStream(String relPath) throws IOException;
053    
054        OutputStream storeFileStream(String relPath) throws IOException;
055    
056        boolean abort() throws IOException;
057    
058        String getReplyString() throws IOException;
059    }