org.eclipse.swt.browser.AuthenticationListener Maven / Gradle / Ivy

/*******************************************************************************
 * Copyright (c) 2003, 2016 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.swt.browser;

import org.eclipse.swt.internal.*;

/**
 * This listener interface may be implemented in order to receive
 * an {@link AuthenticationEvent} notification when the {@link Browser}
 * encounters a page that requires authentication.
 *
 * @see Browser#addAuthenticationListener(AuthenticationListener)
 * @see Browser#removeAuthenticationListener(AuthenticationListener)
 *
 * @since 3.5
 */
@FunctionalInterface
public interface AuthenticationListener extends SWTEventListener {

/**
 * This method is called when a page is navigated to that requires
 * authentication.
 * 
 * Setting both the event's user and password
 * fields causes these values to be used as credentials for authentication.
 * Leaving one or both of these fields as null indicates
 * that credentials are not known, so an authentication prompter should
 * be shown to the user.  Otherwise, setting the event's doit
 * field to false cancels the authentication challenge, and
 * the page will not be loaded.
 * 

 *
 * 
The following fields in the AuthenticationEvent apply:
 * 

 * (in) widget the Browser that is attempting to show the
 * page that requires authentication
 * 
(in) location the location issuing the authentication challenge
 * 
(in/out) doit can be set to false to cancel the
 * authentication challenge
 * 
(out) user the user name to authenticate with
 * 
(out) password the password to authenticate with
 * 
 *
 * @param event the AuthenticationEvent that can be used to
 * either supply authentication credentials, defer credential input to
 * an authentication prompter, or cancel an authentication challenge.
 */
public void authenticate(AuthenticationEvent event);
}