content: /*
   * Copyright (C) 2013 Glyptodon LLC
   * 
   * Permission is hereby granted, free of charge, to any person obtaining a copy
   * of this software and associated documentation files (the "Software"), to deal
   * in the Software without restriction, including without limitation the rights
   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   * copies of the Software, and to permit persons to whom the Software is
   * furnished to do so, subject to the following conditions:
   * 
   * The above copyright notice and this permission notice shall be included in
   * all copies or substantial portions of the Software.
   * 
   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   * THE SOFTWARE.
   */
  
  package org.glyptodon.guacamole.net.event.listener;
  
  import org.glyptodon.guacamole.GuacamoleException;
  import org.glyptodon.guacamole.net.event.AuthenticationSuccessEvent;
  
  /**
   * A listener whose hooks will fire immediately before and after a user's
   * authentication attempt succeeds. If a user successfully authenticates,
   * the authenticationSucceeded() hook has the opportunity to cancel the
   * authentication and force it to fail.
   *
   * @author Michael Jumper
   */
  public interface AuthenticationSuccessListener {
  
      /**
       * Event hook which fires immediately after a user's authentication attempt
       * succeeds. The return value of this hook dictates whether the
       * successful authentication attempt is canceled.
       *
       * @param e The AuthenticationFailureEvent describing the authentication
       *          failure that just occurred.
       * @return true if the successful authentication attempt should be
       *         allowed, or false if the attempt should be denied, causing
       *         the attempt to effectively fail.
       * @throws GuacamoleException If an error occurs while handling the
       *                            authentication success event. Throwing an
       *                            exception will also cancel the authentication
       *                            success.
       */
      boolean authenticationSucceeded(AuthenticationSuccessEvent e)
              throws GuacamoleException;
  
  }
  