com.jscape.inet.ssh.protocol.v2.authentication

## Interface ClientAuthentication

- All Known Implementing Classes:
    com.jscape.inet.ssh.protocol.v2.authentication.AbstractClientAuthentication, com.jscape.inet.ssh.protocol.v2.authentication.AbstractKeyboardInteractiveClientAuthentication, ComponentClientAuthentication, KeyboardInteractiveConsoleClientAuthentication, KeyboardInteractivePredefinedClientAuthentication, KeyboardInteractiveRegexClientAuthentication, NoneClientAuthentication, PasswordClientAuthentication, PublicKeyClientAuthentication

      public interface ClientAuthentication

  SSH client authentication operation.
  Author:
    Alex Usun

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Interface and Description
    --- | ---
    `static class` | `ClientAuthentication.InvalidCredentialsException` Represents invalid credentials error.
    `static class` | `ClientAuthentication.PartialSuccessException` Represents partial success state in case server requires multi-stage authentication.

  - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `applyTo(com.jscape.inet.ssh.protocol.v2.transport.TransportConnection connection, java.lang.String serviceName)` Performs actual client authentication.

- - ### Method Detail

    - #### applyTo

          void applyTo(com.jscape.inet.ssh.protocol.v2.transport.TransportConnection connection,
                       java.lang.String serviceName)
                throws java.lang.Exception

      Performs actual client authentication.
      Parameters:
        `connection` - SSH transport connection
        `serviceName` - target service name
      Throws:
        `java.lang.Exception` - if an error occurs

Copyright © JSCAPE LLC. 1999-2021. All Rights Reserved