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

Field Summary
- Fields inherited from interface org.apache.sshd.common.NamedResource
  BY_NAME_COMPARATOR, NAME_EXTRACTOR

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`destroy()`	Called to release any allocated resources
`void`	`init(ClientSession session, java.lang.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.NamedResource
getName

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

- Method Detail
  - init
```
void init(ClientSession session,
          java.lang.String service)
   throws java.lang.Exception
```
    Parameters:
    
    session - The ClientSession
    
    service - The requesting service name
    
    Throws:
    
    java.lang.Exception - If failed to initialize the mechanism
  - process
```
boolean process(Buffer buffer)
         throws java.lang.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:
    
    java.lang.Exception - If failed to process the request
  - destroy
```
void destroy()
```
    Called to release any allocated resources