AuthMethod

All Superinterfaces:: SSHPacketHandler

All Known Implementing Classes:: AbstractAuthMethod, AuthGssApiWithMic, AuthHostbased, AuthKeyboardInteractive, AuthNone, AuthPassword, AuthPublickey, KeyedAuthMethod

public interface AuthMethod extends SSHPacketHandler

An authentication method of the SSH Authentication Protocol.

Method Summary

Modifier and Type

Method

Description

String

getName()

void

init(AuthParams params)

This method must be called before requesting authentication with this method.

void

request()

void

setLoggerFactory(LoggerFactory loggerFactory)

boolean

shouldRetry()

Methods inherited from interface net.schmizz.sshj.common.SSHPacketHandler
handle

Method Details
- getName
  
  String getName()
  
  Returns:
  
  assigned name of this authentication method
- init
  
  void init(AuthParams params)
  
  This method must be called before requesting authentication with this method.
  
  Parameters:
  
  params - parameters needed for authentication
- request
  
  void request() throws UserAuthException, TransportException
  
  Throws:
  
  UserAuthException - if there is an error with the request
  
  TransportException - if there is a transport-related error
- shouldRetry
  
  boolean shouldRetry()
  
  Returns:
  
  whether authentication should be reattempted if it failed.
- setLoggerFactory
  
  void setLoggerFactory(LoggerFactory loggerFactory)