Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

gnu.javax.crypto.sasl
Interface IAuthInfoProvider  view IAuthInfoProvider download IAuthInfoProvider.java


public interface IAuthInfoProvider

The visible methods of any authentication information provider.


Method Summary
 void activate(java.util.Map context)
          Activates (initialises) this provider instance.
 boolean contains(java.lang.String userName)
          Checks if a user with a designated name is known to this provider.
 java.util.Map getConfiguration(java.lang.String mode)
          A provider may operate in more than mode; e.g.
 java.util.Map lookup(java.util.Map userID)
          Returns a collection of information about a designated user.
 void passivate()
          Passivates (releases) this provider instance.
 void update(java.util.Map userCredentials)
          Updates the credentials of a designated user.
 

Method Detail

activate

public void activate(java.util.Map context)
              throws javax.security.sasl.AuthenticationException
Activates (initialises) this provider instance. SHOULD be the first method invoked on the provider.


passivate

public void passivate()
               throws javax.security.sasl.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.


contains

public boolean contains(java.lang.String userName)
                 throws javax.security.sasl.AuthenticationException
Checks if a user with a designated name is known to this provider.


lookup

public java.util.Map lookup(java.util.Map userID)
                     throws javax.security.sasl.AuthenticationException
Returns a collection of information about a designated user. The contents of the returned map is provider-specific of name-to-value mappings.


update

public void update(java.util.Map userCredentials)
            throws javax.security.sasl.AuthenticationException
Updates the credentials of a designated user.


getConfiguration

public java.util.Map getConfiguration(java.lang.String mode)
                               throws javax.security.sasl.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.