source/ch/cyberduck/core/LoginCallback.java

   1 package ch.cyberduck.core;
   2
   3 /*
   4  * Copyright (c) 2002-2014 David Kocher. All rights reserved.
   5  * http://cyberduck.ch/
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * Bug fixes, suggestions and comments should be sent to:
  18  * feedback@cyberduck.ch
  19  */
  20
  21 import ch.cyberduck.core.exception.LoginCanceledException;
  22
  23 public interface LoginCallback extends ConnectionCallback {
  24
  25     /**
  26      * Call this to allow the user to reenter the new login credentials.
  27      * A concrete subclass should display a login prompt.
  28      *
  29      * @param bookmark    Used to determine login prompt options.
  30      * @param credentials The credentials to obtain.
  31      * @param title       The title for the login prompt
  32      * @param reason      The detail message for the login prompt. Any additional information why the login failed.
  33      * @param options     Enable checkbox to save password in keychain. Enable public key authentication checkbox. Enable anynomous login option checkbox
  34      * @throws LoginCanceledException When login is canceled and the prompt dismissed
  35      */
  36     void prompt(Host bookmark, Credentials credentials,
  37                 String title, String reason,
  38                 LoginOptions options) throws LoginCanceledException;
  39
  40     /**
  41      * Prompt to open file for reading.
  42      *
  43      * @param identity File
  44      * @return Selected file or null
  45      */
  46     Local select(final Local identity) throws LoginCanceledException;
  47 }