public interface UserAuth
Modifier and Type | Method and Description |
---|---|
boolean |
authenticate(java.lang.String username,
Service nextService,
AuthMethod methods,
int timeoutMs)
Attempt to authenticate
username using each of methods in order. |
java.lang.Iterable<java.lang.String> |
getAllowedMethods()
The available authentication methods.
|
java.lang.String |
getBanner()
Returns the authentication banner (if any).
|
boolean |
hadPartialSuccess() |
boolean authenticate(java.lang.String username, Service nextService, AuthMethod methods, int timeoutMs) throws UserAuthException, TransportException
username
using each of methods
in order. nextService
is the
Service
that will be enabled on successful authentication.
Authentication fails if there are no method available, i.e. if all the method failed or there were method
available but could not be attempted because the server did not allow them.
Further attempts may also be made by catching UserAuthException
and retrying with this method.username
- the user to authenticatenextService
- the service to set on successful authenticationmethods
- the AuthMethod
's to tryUserAuthException
- in case of authentication failureTransportException
- if there was a transport-layer errorjava.lang.String getBanner()
boolean hadPartialSuccess()
true
if at least one of the method supplied succeeded.java.lang.Iterable<java.lang.String> getAllowedMethods()