gnu.inet.ftp.DTP Maven / Gradle / Ivy

/*
 * DTP.java
 * Copyright (C) 2003 The Free Software Foundation
 * 
 * This file is part of GNU inetlib, a library.
 * 
 * GNU inetlib is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * GNU inetlib is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 * 
 * Linking this library statically or dynamically with other modules is
 * making a combined work based on this library.  Thus, the terms and
 * conditions of the GNU General Public License cover the whole
 * combination.
 *
 * As a special exception, the copyright holders of this library give you
 * permission to link this library with independent modules to produce an
 * executable, regardless of the license terms of these independent
 * modules, and to copy and distribute the resulting executable under
 * terms of your choice, provided that you also meet, for each linked
 * independent module, the terms and conditions of the license of that
 * module.  An independent module is a module which is not derived from
 * or based on this library.  If you modify this library, you may extend
 * this exception to your version of the library, but you are not
 * obliged to do so.  If you do not wish to do so, delete this
 * exception statement from your version.
 */

package gnu.inet.ftp;

import java.io.InputStream;
import java.io.IOException;
import java.io.OutputStream;

/**
 * An FTP data transfer process.
 *
 * @author Chris Burdess
 */
interface DTP
{

  /**
   * Returns an input stream from which a remote file can be read.
   */
  InputStream getInputStream()
    throws IOException;

  /**
   * Returns an output stream to which a local file can be written for
   * upload.
   */
  OutputStream getOutputStream()
    throws IOException;

  /**
   * Sets the transfer mode to be used with this DTP.
   */
  void setTransferMode(int mode);

  /**
   * Marks this DTP completed.
   * When the current transfer has finished, any resources will be released.
   */
  void complete();

  /**
   * Aborts any current transfer and releases all resources held by this
   * DTP.
   * @return true if a transfer was interrupted, false otherwise
   */
  boolean abort();

  /**
   * Used to notify the DTP that its current transfer is complete.
   * This occurs either when end-of-stream is reached or a 226 response is
   * received.
   */
  void transferComplete();

}