Jive Messenger 2.2.2 Javadoc

org.jivesoftware.messenger.auth
Class DefaultAuthProvider

java.lang.Object
  extended by org.jivesoftware.messenger.auth.DefaultAuthProvider
All Implemented Interfaces:
AuthProvider

public class DefaultAuthProvider
extends Object
implements AuthProvider

Default AuthProvider implementation. It authenticates against the jiveUser database table and supports plain text and digest authentication. Because each call to authenticate() makes a database connection, the results of authentication should be cached whenever possible.

Author:
Matt Tucker

Constructor Summary
DefaultAuthProvider()
           
 
Method Summary
 void authenticate(String username, String password)
          Returns if the username and password are valid; otherwise this method throws an UnauthorizedException.
 void authenticate(String username, String token, String digest)
          Returns if the username, token, and digest are valid; otherwise this method throws an UnauthorizedException.
 boolean isDigestSupported()
          Returns true if this AuthProvider supports digest authentication according to JEP-0078.
 boolean isPlainSupported()
          Returns true if this AuthProvider supports authentication using plain-text passwords according to JEP--0078.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultAuthProvider

public DefaultAuthProvider()
Method Detail

authenticate

public void authenticate(String username,
                         String password)
                  throws UnauthorizedException
Description copied from interface: AuthProvider
Returns if the username and password are valid; otherwise this method throws an UnauthorizedException.

If AuthProvider.isPlainSupported() returns false, this method should throw an UnsupportedOperationException.

Specified by:
authenticate in interface AuthProvider
Parameters:
username - the username.
password - the passwordl
Throws:
UnauthorizedException - if the username and password do not match any existing user.

authenticate

public void authenticate(String username,
                         String token,
                         String digest)
                  throws UnauthorizedException
Description copied from interface: AuthProvider
Returns if the username, token, and digest are valid; otherwise this method throws an UnauthorizedException.

If AuthProvider.isDigestSupported() returns false, this method should throw an UnsupportedOperationException.

Specified by:
authenticate in interface AuthProvider
Parameters:
username - the username.
token - the token that was used with plain-text password to generate the digest.
digest - the digest generated from plain-text password and unique token.
Throws:
UnauthorizedException - if the username and password do not match any existing user.

isPlainSupported

public boolean isPlainSupported()
Description copied from interface: AuthProvider
Returns true if this AuthProvider supports authentication using plain-text passwords according to JEP--0078. Plain text authentication is not secure and should generally only be used for a TLS/SSL connection.

Specified by:
isPlainSupported in interface AuthProvider
Returns:
true if plain text password authentication is supported by this AuthProvider.

isDigestSupported

public boolean isDigestSupported()
Description copied from interface: AuthProvider
Returns true if this AuthProvider supports digest authentication according to JEP-0078.

Specified by:
isDigestSupported in interface AuthProvider
Returns:
true if digest authentication is supported by this AuthProvider.

Jive Messenger 2.2.2 Javadoc

Copyright © 1999-2004 Jive Software.