public interface UserAuth extends ServerSessionHolder, UserAuthInstance<ServerSession>, UsernameHolder
BY_NAME_COMPARATOR, NAME_EXTRACTOR
Modifier and Type | Method and Description |
---|---|
Boolean |
auth(ServerSession session,
String username,
String service,
Buffer buffer)
Try to authenticate the user.
|
void |
destroy()
Free any system resources used by the module.
|
Boolean |
next(Buffer buffer)
Handle another step in the authentication process.
|
getServerSession
getSession
findByName, getName, getNameList, getNames, ofName, removeByName
getUsername
Boolean auth(ServerSession session, String username, String service, Buffer buffer) throws AsyncAuthException, Exception
null
value indicating if the authentication succeeded. If the authentication is
still ongoing, a null
value should be returned.session
- the current ServerSession
sessionusername
- the user trying to log inservice
- the requested service namebuffer
- the request buffer containing parameters specific to this requesttrue
if the authentication succeeded, false
if the authentication
failed and null
if not finished yetAsyncAuthException
- if the service is willing to perform an asynchronous authenticationException
- if the authentication failsBoolean next(Buffer buffer) throws AsyncAuthException, Exception
buffer
- the request buffer containing parameters specific to this requesttrue
if the authentication succeeded, false
if the authentication
failed and null
if not finished yetAsyncAuthException
- if the service is willing to perform an asynchronous authenticationException
- if the authentication failsvoid destroy()
Copyright © 2008–2022 The Apache Software Foundation. All rights reserved.