View Javadoc

1   /*
2    * ------------------------------------------------------------------------------
3    * Hermes FTP Server
4    * Copyright (c) 2005-2007 Lars Behnke
5    * ------------------------------------------------------------------------------
6    * 
7    * This file is part of Hermes FTP Server.
8    * 
9    * Hermes FTP Server is free software; you can redistribute it and/or modify
10   * it under the terms of the GNU General Public License as published by
11   * the Free Software Foundation; either version 2 of the License, or
12   * (at your option) any later version.
13   * 
14   * Hermes FTP Server is distributed in the hope that it will be useful,
15   * but WITHOUT ANY WARRANTY; without even the implied warranty of
16   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17   * GNU General Public License for more details.
18   * 
19   * You should have received a copy of the GNU General Public License
20   * along with Hermes FTP Server; if not, write to the Free Software
21   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22   * ------------------------------------------------------------------------------
23   */
24  
25  package net.sf.hermesftp.common;
26  
27  import java.io.File;
28  
29  /***
30   * <code>Eventlistener</code> that is implemented by classes that are to be informed by FTP
31   * command objects on certain events.
32   * 
33   * @author Lars Behnke
34   */
35  public interface FtpEventListener {
36  
37      /***
38       * The event is called after a file has been uploaded by a client.
39       * 
40       * @param file The uploaded file.
41       * @param clientId The unique ID of a client.
42       */
43      void uploadPerformed(String clientId, File file);
44  
45      /***
46       * The event is called after a file has been downloaded by a client.
47       * 
48       * @param file The downloaded file.
49       * @param clientId The unique ID of a client.
50       */
51      void downloadPerformed(String clientId, File file);
52  
53      /***
54       * Number of failed long attempts.
55       * 
56       * @param clientId The unique ID of a client.
57       * @param successful True, if the authentication was successful.
58       */
59      void loginPerformed(String clientId, boolean successful);
60  
61      /***
62       * Method is called after a client session has been opened.
63       * 
64       * @param sessionObj The closed session object.
65       */
66      void sessionOpened(Object sessionObj);
67  
68      /***
69       * Method is called after a client session has been closed.
70       * 
71       * @param sessionObj The closed session object.
72       */
73      void sessionClosed(Object sessionObj);
74  
75  }