|
Jive Messenger 2.2.2 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jivesoftware.messenger.auth.POP3AuthProvider
public class POP3AuthProvider
An AuthProvider that authenticates using a POP3 server. It will automatically create local user accounts as needed. To enable this provider, edit the XML config file file and set:
<provider> <auth> <className>org.jivesoftware.messenger.auth.POP3AuthProvider</className> </auth> <user> <className>org.jivesoftware.messenger.user.POP3UserProvider</className> </user> </provider>The properties to configure the provider are as follows:
Constructor Summary | |
---|---|
POP3AuthProvider()
Initialiazes the POP3AuthProvider with values from the global config file. |
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 |
---|
public POP3AuthProvider()
Method Detail |
---|
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 boolean isPlainSupported()
AuthProvider
isPlainSupported
in interface AuthProvider
public boolean isDigestSupported()
AuthProvider
isDigestSupported
in interface AuthProvider
|
Jive Messenger 2.2.2 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |