org.apache.sshd.client.auth

Interface UserAuth

All Superinterfaces:

ClientSessionHolder, NamedResource, UserAuthInstance<ClientSession>

All Known Implementing Classes:

AbstractUserAuth, UserAuthHostBased, UserAuthKeyboardInteractive, UserAuthPassword, UserAuthPublicKey

public interface UserAuth
extends ClientSessionHolder, UserAuthInstance<ClientSession>

Represents a user authentication mechanism

Author:

Apache MINA SSHD Project

Field Summary

Fields inherited from interface org.apache.sshd.common.NamedResource

BY_NAME_COMPARATOR, NAME_EXTRACTOR

Method Summary

Modifier and Type	Method and Description
void	destroy() Called to release any allocated resources
void	init(ClientSession session, String service)
boolean	process(Buffer buffer)

Methods inherited from interface org.apache.sshd.client.session.ClientSessionHolder

getClientSession

Methods inherited from interface org.apache.sshd.common.auth.UserAuthInstance

getSession

Methods inherited from interface org.apache.sshd.common.NamedResource

findByName, getName, getNameList, getNames, removeByName

Method Detail

init

void init(ClientSession session,
          String service)
   throws Exception

Parameters:

session - The ClientSession

service - The requesting service name

Throws:

Exception - If failed to initialize the mechanism

process

boolean process(Buffer buffer)
         throws Exception

Parameters:

buffer - The Buffer to process - null if not a response buffer, i.e., the underlying authentication mechanism should initiate whatever challenge/response mechanism is required

Returns:

true if request handled - false if the next authentication mechanism should be used

Throws:

Exception - If failed to process the request

destroy

void destroy()

Called to release any allocated resources