1 |
769 |
jeremybenn |
/* IAuthInfoProvider.java --
|
2 |
|
|
Copyright (C) 2003, 2006 Free Software Foundation, Inc.
|
3 |
|
|
|
4 |
|
|
This file is a part of GNU Classpath.
|
5 |
|
|
|
6 |
|
|
GNU Classpath is free software; you can redistribute it and/or modify
|
7 |
|
|
it under the terms of the GNU General Public License as published by
|
8 |
|
|
the Free Software Foundation; either version 2 of the License, or (at
|
9 |
|
|
your option) any later version.
|
10 |
|
|
|
11 |
|
|
GNU Classpath is distributed in the hope that it will be useful, but
|
12 |
|
|
WITHOUT ANY WARRANTY; without even the implied warranty of
|
13 |
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
14 |
|
|
General Public License for more details.
|
15 |
|
|
|
16 |
|
|
You should have received a copy of the GNU General Public License
|
17 |
|
|
along with GNU Classpath; if not, write to the Free Software
|
18 |
|
|
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
|
19 |
|
|
USA
|
20 |
|
|
|
21 |
|
|
Linking this library statically or dynamically with other modules is
|
22 |
|
|
making a combined work based on this library. Thus, the terms and
|
23 |
|
|
conditions of the GNU General Public License cover the whole
|
24 |
|
|
combination.
|
25 |
|
|
|
26 |
|
|
As a special exception, the copyright holders of this library give you
|
27 |
|
|
permission to link this library with independent modules to produce an
|
28 |
|
|
executable, regardless of the license terms of these independent
|
29 |
|
|
modules, and to copy and distribute the resulting executable under
|
30 |
|
|
terms of your choice, provided that you also meet, for each linked
|
31 |
|
|
independent module, the terms and conditions of the license of that
|
32 |
|
|
module. An independent module is a module which is not derived from
|
33 |
|
|
or based on this library. If you modify this library, you may extend
|
34 |
|
|
this exception to your version of the library, but you are not
|
35 |
|
|
obligated to do so. If you do not wish to do so, delete this
|
36 |
|
|
exception statement from your version. */
|
37 |
|
|
|
38 |
|
|
|
39 |
|
|
package gnu.javax.crypto.sasl;
|
40 |
|
|
|
41 |
|
|
import java.util.Map;
|
42 |
|
|
|
43 |
|
|
import javax.security.sasl.AuthenticationException;
|
44 |
|
|
|
45 |
|
|
/**
|
46 |
|
|
* The visible methods of any authentication information provider.
|
47 |
|
|
*/
|
48 |
|
|
public interface IAuthInfoProvider
|
49 |
|
|
{
|
50 |
|
|
/**
|
51 |
|
|
* Activates (initialises) this provider instance. SHOULD be the first method
|
52 |
|
|
* invoked on the provider.
|
53 |
|
|
*
|
54 |
|
|
* @param context a collection of name-value bindings describing the
|
55 |
|
|
* activation context.
|
56 |
|
|
* @throws AuthenticationException if an exception occurs during the
|
57 |
|
|
* operation.
|
58 |
|
|
*/
|
59 |
|
|
void activate(Map context) throws AuthenticationException;
|
60 |
|
|
|
61 |
|
|
/**
|
62 |
|
|
* Passivates (releases) this provider instance. SHOULD be the last method
|
63 |
|
|
* invoked on the provider. Once it is done, no other method may be invoked on
|
64 |
|
|
* the same instance before it is <i>activated</i> agains.
|
65 |
|
|
*
|
66 |
|
|
* @throws AuthenticationException if an exception occurs during the
|
67 |
|
|
* operation.
|
68 |
|
|
*/
|
69 |
|
|
void passivate() throws AuthenticationException;
|
70 |
|
|
|
71 |
|
|
/**
|
72 |
|
|
* Checks if a user with a designated name is known to this provider.
|
73 |
|
|
*
|
74 |
|
|
* @param userName the name of a user to check.
|
75 |
|
|
* @return <code>true</code> if the user with the designated name is known
|
76 |
|
|
* to this provider; <code>false</code> otherwise.
|
77 |
|
|
* @throws AuthenticationException if an exception occurs during the
|
78 |
|
|
* operation.
|
79 |
|
|
*/
|
80 |
|
|
boolean contains(String userName) throws AuthenticationException;
|
81 |
|
|
|
82 |
|
|
/**
|
83 |
|
|
* Returns a collection of information about a designated user. The contents
|
84 |
|
|
* of the returned map is provider-specific of name-to-value mappings.
|
85 |
|
|
*
|
86 |
|
|
* @param userID a map of name-to-value bindings that fully describe a user.
|
87 |
|
|
* @return a collection of information about the designated user.
|
88 |
|
|
* @throws AuthenticationException if an exception occurs during the
|
89 |
|
|
* operation.
|
90 |
|
|
*/
|
91 |
|
|
Map lookup(Map userID) throws AuthenticationException;
|
92 |
|
|
|
93 |
|
|
/**
|
94 |
|
|
* Updates the credentials of a designated user.
|
95 |
|
|
*
|
96 |
|
|
* @param userCredentials a map of name-to-value bindings that fully describe
|
97 |
|
|
* a user, including per new credentials.
|
98 |
|
|
* @throws AuthenticationException if an exception occurs during the
|
99 |
|
|
* operation.
|
100 |
|
|
*/
|
101 |
|
|
void update(Map userCredentials) throws AuthenticationException;
|
102 |
|
|
|
103 |
|
|
/**
|
104 |
|
|
* A provider may operate in more than mode; e.g. SRP-II caters for user
|
105 |
|
|
* credentials computed in more than one message digest algorithm. This method
|
106 |
|
|
* returns the set of name-to-value bindings describing the mode of the
|
107 |
|
|
* provider.
|
108 |
|
|
*
|
109 |
|
|
* @param mode a unique identifier describing the operational mode.
|
110 |
|
|
* @return a collection of name-to-value bindings describing the designated
|
111 |
|
|
* mode.
|
112 |
|
|
* @throws AuthenticationException if an exception occurs during the
|
113 |
|
|
* operation.
|
114 |
|
|
*/
|
115 |
|
|
Map getConfiguration(String mode) throws AuthenticationException;
|
116 |
|
|
}
|