View Javadoc

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