View Javadoc

1   //$Id: PooledClient.java,v 1.4 2006/02/20 05:00:25 sjardine Exp $
2   //
3   //Copyright 2005 Steven Jardine <steve@mjnservices.com>
4   //Copyright 2005 MJN Services, Inc - http://www.mjnservices.com
5   //
6   //for information on the HylaFAX FAX server see
7   //http://www.hylafax.org/
8   //
9   //This library is free software; you can redistribute it and/or
10  //modify it under the terms of the GNU Library General Public
11  //License as published by the Free Software Foundation; either
12  //version 2 of the License, or (at your option) any later version.
13  //
14  //This library 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 GNU
17  //Library General Public License for more details.
18  //
19  //You should have received a copy of the GNU Library General Public
20  //License along with this library; if not, write to the Free
21  //Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22  //
23  package gnu.hylafax.pool;
24  
25  import gnu.hylafax.Client;
26  import gnu.inet.ftp.ConnectionEventSource;
27  import gnu.inet.ftp.TransferEventSource;
28  
29  public interface PooledClient extends Client, TransferEventSource, ConnectionEventSource {
30  
31      /***
32       * Destroy the client. This makes the client unusable.
33       * @throws ClientPoolException
34       */
35      public void destroy() throws ClientPoolException;
36  
37      /***
38       * Checks to see if the client is currently valid. If the client is not valid it should be reopened or
39       * destroyed.
40       */
41      public boolean isValid();
42  
43  }