|
Wildfire 3.2.4 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jivesoftware.wildfire.auth.HybridAuthProvider
public class HybridAuthProvider
The hybrid auth provider allows up to three AuthProvider implementations to be strung together to do chained authentication checking. The algorithm is as follows:
<provider> <auth> <className>org.jivesoftware.wildfire.auth.HybridAuthProvider</className> </auth> </provider>The primary, secondary, and tertiary providers are configured as in the following example:
<hybridAuthProvider> <primaryProvider> <className>org.jivesoftware.wildfire.auth.DefaultAuthProvider<className> </primaryProvider> <secondaryProvider> <className>org.jivesoftware.wildfire.auth.NativeAuthProvider</className> </secondaryProvider> </hybridAuthProvider>Each of the chained providers can have a list of override users. If a user is in an override list, authentication will only be attempted with the associated provider (bypassing the chaining logic).
The full list of properties:
Constructor Summary | |
---|---|
HybridAuthProvider()
|
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. |
String |
getPassword(String username)
Returns the user's password. |
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. |
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public HybridAuthProvider()
Method Detail |
---|
public boolean isPlainSupported()
AuthProvider
isPlainSupported
in interface AuthProvider
public boolean isDigestSupported()
AuthProvider
isDigestSupported
in interface AuthProvider
public void authenticate(String username, String password) throws UnauthorizedException
AuthProvider
If AuthProvider.isPlainSupported()
returns false, this method should
throw an UnsupportedOperationException.
authenticate
in interface AuthProvider
username
- the username.password
- the passwordl
UnauthorizedException
- if the username and password do
not match any existing user.public void authenticate(String username, String token, String digest) throws UnauthorizedException
AuthProvider
If AuthProvider.isDigestSupported()
returns false, this method should
throw an UnsupportedOperationException.
authenticate
in interface AuthProvider
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.
UnauthorizedException
- if the username and password
do not match any existing user.public String getPassword(String username) throws UserNotFoundException, UnsupportedOperationException
AuthProvider
getPassword
in interface AuthProvider
username
- the username of the user.
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).public void setPassword(String username, String password) throws UserNotFoundException, UnsupportedOperationException
AuthProvider
setPassword
in interface AuthProvider
username
- the username of the user.password
- the new plaintext password for the user.
UserNotFoundException
- if the given user could not be loaded.
UnsupportedOperationException
- if the provider does not
support the operation (this is an optional operation).public boolean supportsPasswordRetrieval()
AuthProvider
AuthProvider.getPassword(String)
will throw an UnsupportedOperationException
if invoked.
supportsPasswordRetrieval
in interface AuthProvider
|
Wildfire 3.2.4 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |