View Javadoc

1   /**
2    * This file is part of Waarp Project.
3    * 
4    * Copyright 2009, Frederic Bregier, and individual contributors by the @author tags. See the
5    * COPYRIGHT.txt in the distribution for a full listing of individual contributors.
6    * 
7    * All Waarp Project is free software: you can redistribute it and/or modify it under the terms of
8    * the GNU General Public License as published by the Free Software Foundation, either version 3 of
9    * the License, or (at your option) any later version.
10   * 
11   * Waarp is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
12   * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
13   * Public License for more details.
14   * 
15   * You should have received a copy of the GNU General Public License along with Waarp . If not, see
16   * <http://www.gnu.org/licenses/>.
17   */
18  package org.waarp.ftp.core.file;
19  
20  import org.waarp.common.command.NextCommandReply;
21  import org.waarp.common.command.exception.Reply421Exception;
22  import org.waarp.common.command.exception.Reply502Exception;
23  import org.waarp.common.command.exception.Reply530Exception;
24  import org.waarp.common.file.AuthInterface;
25  
26  /**
27   * @author Frederic Bregier
28   * 
29   */
30  public interface FtpAuth extends AuthInterface {
31  
32      /**
33       * @return the account
34       */
35      public String getAccount();
36  
37      /**
38       * @param account
39       *            the account to set
40       * @return (NOOP,230) if the Account is OK, else return the following command that must follow
41       *         and the associated reply
42       * @throws Reply421Exception
43       *             if there is a problem during the authentication
44       * @throws Reply530Exception
45       *             if there is a problem during the authentication
46       * @throws Reply502Exception
47       */
48      public NextCommandReply setAccount(String account)
49              throws Reply421Exception, Reply530Exception, Reply502Exception;
50  
51  }