public interface

AuthMethod

implements SSHPacketHandler
net.schmizz.sshj.userauth.method.AuthMethod
Known Indirect Subclasses

Class Overview

An authentication method of the SSH Authentication Protocol.

Summary

Public Methods
abstract String getName()
abstract void init(AuthParams params)
This method must be called before requesting authentication with this method.
abstract void request()
abstract boolean shouldRetry()
[Expand]
Inherited Methods
From interface net.schmizz.sshj.common.SSHPacketHandler

Public Methods

public abstract String getName ()

Returns
  • assigned name of this authentication method

public abstract void init (AuthParams params)

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

Parameters
params Parameters needed for authentication

public abstract void request ()

Throws
UserAuthException if there is an error with the request
TransportException if there is a transport-related error

public abstract boolean shouldRetry ()

Returns
  • whether authentication should be reattempted if it failed.