View Javadoc

    1   /*
    2    * Licensed to the Apache Software Foundation (ASF) under one or more
    3    * contributor license agreements.  See the NOTICE file distributed with
    4    * this work for additional information regarding copyright ownership.
    5    * The ASF licenses this file to You under the Apache License, Version 2.0
    6    * (the "License"); you may not use this file except in compliance with
    7    * the License.  You may obtain a copy of the License at
    8    *
    9    *      http://www.apache.org/licenses/LICENSE-2.0
    10   *
    11   * Unless required by applicable law or agreed to in writing, software
    12   * distributed under the License is distributed on an "AS IS" BASIS,
    13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14   * See the License for the specific language governing permissions and
    15   * limitations under the License.
    16   */
    17  package org.apache.commons.vfs.provider.ftp;
    18
    19  import org.apache.commons.net.ftp.FTPFile;
    20  import org.apache.commons.vfs.FileSystemException;
    21
    22  import java.io.IOException;
    23  import java.io.InputStream;
    24  import java.io.OutputStream;
    25
    26  /***
    27   * What VFS expects from an ftp client to provide.
    28   */
    29  public interface FtpClient
    30  {
    31      boolean isConnected() throws FileSystemException;
    32
    33      void disconnect() throws IOException;
    34
    35      FTPFile[] listFiles(String relPath) throws IOException;
    36
    37      boolean removeDirectory(String relPath) throws IOException;
    38
    39      boolean deleteFile(String relPath) throws IOException;
    40
    41      boolean rename(String oldName, String newName) throws IOException;
    42
    43      boolean makeDirectory(String relPath) throws IOException;
    44
    45      boolean completePendingCommand() throws IOException;
    46
    47      InputStream retrieveFileStream(String relPath) throws IOException;
    48
    49      InputStream retrieveFileStream(String relPath, long restartOffset) throws IOException;
    50
    51      OutputStream appendFileStream(String relPath) throws IOException;
    52
    53      OutputStream storeFileStream(String relPath) throws IOException;
    54
    55      public boolean abort() throws IOException;
    56
    57      public String getReplyString() throws IOException;
    58  }