Package org.jivesoftware.openfire.auth

Interface AuthProvider

All Known Implementing Classes:

CrowdAuthProvider, DefaultAuthProvider, HybridAuthProvider, JDBCAuthProvider, LdapAuthProvider, MappedAuthProvider, NativeAuthProvider, POP3AuthProvider

public interface AuthProvider

Provider interface for authentication. Users that wish to integrate with their own authentication system must implement this class and then register the implementation with Openfire in the openfire.xml file. An entry in that file would look like the following:

   <provider>
     <auth>
       <className>com.foo.auth.CustomAuthProvider</className>
     </auth>
   </provider>

Author:

Matt Tucker

Method Summary

Modifier and Type	Method	Description
void	authenticate(String username, String password)	Returns if the username and password are valid; otherwise this method throws an UnauthorizedException.
int	getIterations(String username)
String	getPassword(String username)	Returns the user's password.
String	getSalt(String username)
String	getServerKey(String username)
String	getStoredKey(String username)
boolean	isScramSupported()
void	setPassword(String username, String password)	Sets the users's password.
boolean	supportsPasswordRetrieval()	Returns true if this UserProvider is able to retrieve user passwords from the backend user store.

Method Detail

authenticate

void authenticate(String username,
                  String password)
           throws UnauthorizedException,
                  ConnectionException,
                  InternalUnauthenticatedException

Returns if the username and password are valid; otherwise this method throws an UnauthorizedException.

Parameters:

username - the username or full JID.

password - the password

Throws:

UnauthorizedException - if the username and password do not match any existing user.

ConnectionException - it there is a problem connecting to user and group system

InternalUnauthenticatedException - if there is a problem authentication Openfire itself into the user and group system

getPassword

String getPassword(String username)
            throws UserNotFoundException,
                   UnsupportedOperationException

Returns the user's password. This method should throw an UnsupportedOperationException if this operation is not supported by the backend user store.

Parameters:

username - the username of the user.

Returns:

the user's password.

Throws:

UserNotFoundException - if the given user's password could not be loaded.

UnsupportedOperationException - if the provider does not support the operation (this is an optional operation).

setPassword

void setPassword(String username,
                 String password)
          throws UserNotFoundException,
                 UnsupportedOperationException

Sets the users's password. This method should throw an UnsupportedOperationException if this operation is not supported by the backend user store.

Parameters:

username - the username of the user.

password - the new plaintext password for the user.

Throws:

UserNotFoundException - if the given user could not be loaded.

UnsupportedOperationException - if the provider does not support the operation (this is an optional operation).

supportsPasswordRetrieval

boolean supportsPasswordRetrieval()

Returns true if this UserProvider is able to retrieve user passwords from the backend user store. If this operation is not supported then getPassword(String) will throw an UnsupportedOperationException if invoked.

Returns:

true if this UserProvider is able to retrieve user passwords from the backend user store.

isScramSupported

boolean isScramSupported()

getSalt

String getSalt(String username)
        throws UnsupportedOperationException,
               UserNotFoundException

Throws:

UnsupportedOperationException

UserNotFoundException

getIterations

int getIterations(String username)
           throws UnsupportedOperationException,
                  UserNotFoundException

Throws:

UnsupportedOperationException

UserNotFoundException

getServerKey

String getServerKey(String username)
             throws UnsupportedOperationException,
                    UserNotFoundException

Throws:

UnsupportedOperationException

UserNotFoundException

getStoredKey

String getStoredKey(String username)
             throws UnsupportedOperationException,
                    UserNotFoundException

Throws:

UnsupportedOperationException

UserNotFoundException