/******************************************************************************* * Copyright (c) 2003, 2016 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 * which accompanies this distribution, and is available at * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 * * 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:
Browser
that is attempting to show the
* page that requires authentication
* false
to cancel the
* authentication challenge
* 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);
}