← Back to branch summary

~ubuntu-branches/ubuntu/karmic/libgnuinet-java/karmic

« back to all changes in this revision

Viewing changes to source/gnu/inet/ftp/DTP.java

  • Committer: Bazaar Package Importer
  • Author(s): Arnaud Vandyck
  • Date: 2004-04-14 12:42:10 UTC
  • Revision ID: james.westby@ubuntu.com-20040414124210-osc3q0wzthgme27p
Tags: upstream-0.0.cvs20031116
Import upstream version 0.0.cvs20031116

Show diffs side-by-side

added added

removed removed

Lines of Context:
source/gnu/inet/ftp/DTP.java
 
1
/*
 
2
 * $Id: DTP.java,v 1.2 2003/10/19 16:16:49 dog Exp $
 
3
 * Copyright (C) 2003 The Free Software Foundation
 
4
 * 
 
5
 * This file is part of GNU inetlib, a library.
 
6
 * 
 
7
 * GNU inetlib is free software; you can redistribute it and/or modify
 
8
 * it under the terms of the GNU General Public License as published by
 
9
 * the Free Software Foundation; either version 2 of the License, or
 
10
 * (at your option) any later version.
 
11
 * 
 
12
 * GNU inetlib is distributed in the hope that it will be useful,
 
13
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
14
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
15
 * GNU General Public License for more details.
 
16
 * 
 
17
 * You should have received a copy of the GNU General Public License
 
18
 * along with this library; if not, write to the Free Software
 
19
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
20
 * 
 
21
 * As a special exception, if you link this library with other files to
 
22
 * produce an executable, this library does not by itself cause the
 
23
 * resulting executable to be covered by the GNU General Public License.
 
24
 * This exception does not however invalidate any other reasons why the
 
25
 * executable file might be covered by the GNU General Public License.
 
26
 */
 
27
 
 
28
package gnu.inet.ftp;
 
29
 
 
30
import java.io.InputStream;
 
31
import java.io.IOException;
 
32
import java.io.OutputStream;
 
33
 
 
34
/**
 
35
 * An FTP data transfer process.
 
36
 *
 
37
 * @author <a href='mailto:dog@gnu.org'>Chris Burdess</a>
 
38
 * @version $Revision: 1.2 $ $Date: 2003/10/19 16:16:49 $
 
39
 */
 
40
interface DTP
 
41
{
 
42
 
 
43
        /**
 
44
         * Returns an input stream from which a remote file can be read.
 
45
         */
 
46
  InputStream getInputStream() throws IOException;
 
47
 
 
48
        /**
 
49
         * Returns an output stream to which a local file can be written for
 
50
         * upload.
 
51
         */
 
52
  OutputStream getOutputStream() throws IOException;
 
53
 
 
54
        /**
 
55
         * Sets the transfer mode to be used with this DTP.
 
56
         */
 
57
  void setTransferMode(int mode);
 
58
 
 
59
        /**
 
60
         * Marks this DTP completed.
 
61
         * When the current transfer has finished, any resources will be released.
 
62
         */
 
63
  void complete();
 
64
 
 
65
        /**
 
66
         * Aborts any current transfer and releases all resources held by this
 
67
         * DTP.
 
68
         * @return true if a transfer was interrupted, false otherwise
 
69
         */
 
70
  boolean abort();
 
71
 
 
72
        /**
 
73
         * Used to notify the DTP that its current transfer is complete.
 
74
         * This occurs either when end-of-stream is reached or a 226 response is
 
75
         * received.
 
76
         */
 
77
  void transferComplete();
 
78
 
 
79
}