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