forked from eclipse-platform/eclipse.platform.swt
-
Notifications
You must be signed in to change notification settings - Fork 0
/
AuthenticationListener.java
60 lines (57 loc) · 2.33 KB
/
AuthenticationListener.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
/*******************************************************************************
* 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 java.util.*;
/**
* 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 EventListener {
/**
* This method is called when a page is navigated to that requires
* authentication.
* <p>
* Setting both the event's <code>user</code> and <code>password</code>
* fields causes these values to be used as credentials for authentication.
* Leaving one or both of these fields as <code>null</code> indicates
* that credentials are not known, so an authentication prompter should
* be shown to the user. Otherwise, setting the event's <code>doit</code>
* field to <code>false</code> cancels the authentication challenge, and
* the page will not be loaded.
* </p>
*
* <p>The following fields in the <code>AuthenticationEvent</code> apply:</p>
* <ul>
* <li>(in) widget the <code>Browser</code> that is attempting to show the
* page that requires authentication
* <li>(in) location the location issuing the authentication challenge
* <li>(in/out) doit can be set to <code>false</code> to cancel the
* authentication challenge
* <li>(out) user the user name to authenticate with
* <li>(out) password the password to authenticate with
* </ul>
*
* @param event the <code>AuthenticationEvent</code> 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);
}