-
Notifications
You must be signed in to change notification settings - Fork 103
Expand file tree
/
Copy pathAuthProvider.java
More file actions
128 lines (120 loc) · 4.28 KB
/
AuthProvider.java
File metadata and controls
128 lines (120 loc) · 4.28 KB
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
/*
* Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
* ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*/
package java.security;
import javax.security.auth.Subject;
import javax.security.auth.login.LoginException;
import javax.security.auth.callback.CallbackHandler;
/**
* This class defines login and logout methods for a provider.
*
* <p> While callers may invoke {@code login} directly,
* the provider may also invoke {@code login} on behalf of callers
* if it determines that a login must be performed
* prior to certain operations.
*
* @since 1.5
*/
public abstract class AuthProvider extends Provider {
private static final long serialVersionUID = 4197859053084546461L;
/**
* Constructs a provider with the specified name, version number,
* and information.
*
* @param name the provider name.
* @param version the provider version number.
* @param info a description of the provider and its services.
*/
protected AuthProvider(String name, double version, String info) {
super(name, version, info);
}
/**
* Log in to this provider.
*
* <p> The provider relies on a {@code CallbackHandler}
* to obtain authentication information from the caller
* (a PIN, for example). If the caller passes a {@code null}
* handler to this method, the provider uses the handler set in the
* {@code setCallbackHandler} method.
* If no handler was set in that method, the provider queries the
* <i>auth.login.defaultCallbackHandler</i> security property
* for the fully qualified class name of a default handler implementation.
* If the security property is not set,
* the provider is assumed to have alternative means
* for obtaining authentication information.
*
* @param subject the {@code Subject} which may contain
* principals/credentials used for authentication,
* or may be populated with additional principals/credentials
* after successful authentication has completed.
* This parameter may be {@code null}.
* @param handler the {@code CallbackHandler} used by
* this provider to obtain authentication information
* from the caller, which may be {@code null}
*
* @exception LoginException if the login operation fails
* @exception SecurityException if the caller does not pass a
* security check for
* {@code SecurityPermission("authProvider.name")},
* where {@code name} is the value returned by
* this provider's {@code getName} method
*/
public abstract void login(Subject subject, CallbackHandler handler)
throws LoginException;
/**
* Log out from this provider.
*
* @exception LoginException if the logout operation fails
* @exception SecurityException if the caller does not pass a
* security check for
* {@code SecurityPermission("authProvider.name")},
* where {@code name} is the value returned by
* this provider's {@code getName} method
*/
public abstract void logout() throws LoginException;
/**
* Set a {@code CallbackHandler}.
*
* <p> The provider uses this handler if one is not passed to the
* {@code login} method. The provider also uses this handler
* if it invokes {@code login} on behalf of callers.
* In either case if a handler is not set via this method,
* the provider queries the
* <i>auth.login.defaultCallbackHandler</i> security property
* for the fully qualified class name of a default handler implementation.
* If the security property is not set,
* the provider is assumed to have alternative means
* for obtaining authentication information.
*
* @param handler a {@code CallbackHandler} for obtaining
* authentication information, which may be {@code null}
*
* @exception SecurityException if the caller does not pass a
* security check for
* {@code SecurityPermission("authProvider.name")},
* where {@code name} is the value returned by
* this provider's {@code getName} method
*/
public abstract void setCallbackHandler(CallbackHandler handler);
}