gnu.javax.crypto.sasl
Interface IAuthInfoProvider
- CramMD5AuthInfoProvider, PlainAuthInfoProvider, SRPAuthInfoProvider
The visible methods of any authentication information provider.
activate
public void activate(Map<K,V> context)
throws AuthenticationException Activates (initialises) this provider instance. SHOULD be the first method
invoked on the provider.
context - a collection of name-value bindings describing the
activation context.
contains
public boolean contains(String userName)
throws AuthenticationException Checks if a user with a designated name is known to this provider.
userName - the name of a user to check.
true if the user with the designated name is known
to this provider; false otherwise.
getConfiguration
public Map<K,V> getConfiguration(String mode)
throws AuthenticationException A provider may operate in more than mode; e.g. SRP-II caters for user
credentials computed in more than one message digest algorithm. This method
returns the set of name-to-value bindings describing the mode of the
provider.
mode - a unique identifier describing the operational mode.
- a collection of name-to-value bindings describing the designated
mode.
lookup
public Map<K,V> lookup(Map<K,V> userID)
throws AuthenticationException Returns a collection of information about a designated user. The contents
of the returned map is provider-specific of name-to-value mappings.
userID - a map of name-to-value bindings that fully describe a user.
- a collection of information about the designated user.
passivate
public void passivate()
throws AuthenticationException Passivates (releases) this provider instance. SHOULD be the last method
invoked on the provider. Once it is done, no other method may be invoked on
the same instance before it is activated agains.
update
public void update(Map<K,V> userCredentials)
throws AuthenticationException Updates the credentials of a designated user.
userCredentials - a map of name-to-value bindings that fully describe
a user, including per new credentials.
IAuthInfoProvider.java --
Copyright (C) 2003, 2006 Free Software Foundation, Inc.
This file is a part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at
your option) any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
USA
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module. An independent module is a module which is not derived from
or based on this library. If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so. If you do not wish to do so, delete this
exception statement from your version.