HostbasedAuthenticationClient (J2SSH Javadocs)

java.lang.Object
- com.sshtools.j2ssh.authentication.SshAuthenticationClient
- - com.sshtools.j2ssh.authentication.HostbasedAuthenticationClient

public class HostbasedAuthenticationClient
extends SshAuthenticationClient

Version:: $Revision: 1.20 $
Author:: $author$

Field Summary

Fields
Modifier and Type Field and Description

protected SshPrivateKey key

Fields
Modifier and Type	Field and Description
`protected SshPrivateKey`	`key`

Constructor Summary

Constructors
Constructor and Description

HostbasedAuthenticationClient()
Creates a new HostbasedAuthenticationClient object.

Constructors
Constructor and Description
`HostbasedAuthenticationClient()` Creates a new HostbasedAuthenticationClient object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`authenticate(AuthenticationProtocolClient authentication, java.lang.String serviceToStart)`
`boolean`	`canAuthenticate()`
`java.lang.String`	`getMethodName()`
`java.util.Properties`	`getPersistableProperties()`
`void`	`reset()`
`void`	`setClientUsername(java.lang.String clientUser)`
`void`	`setKey(SshPrivateKey key)`
`void`	`setPersistableProperties(java.util.Properties properties)`

Methods inherited from class com.sshtools.j2ssh.authentication.SshAuthenticationClient
canPrompt, getAuthenticationPrompt, getUsername, setAuthenticationPrompt, setUsername

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - key
```
protected SshPrivateKey key
```
- Constructor Detail
  - HostbasedAuthenticationClient
```
public HostbasedAuthenticationClient()
```
    Creates a new HostbasedAuthenticationClient object.
- Method Detail
  - setKey
```
public void setKey(SshPrivateKey key)
```
    Parameters:
    
    key -
  - reset
```
public void reset()
```
    Specified by:
    
    reset in class SshAuthenticationClient
  - setClientUsername
```
public void setClientUsername(java.lang.String clientUser)
```
    Parameters:
    
    clientUser -
  - getMethodName
```
public java.lang.String getMethodName()
```
    Specified by:
    
    getMethodName in class SshAuthenticationClient
    
    Returns:
  - authenticate
```
public void authenticate(AuthenticationProtocolClient authentication,
                         java.lang.String serviceToStart)
                  throws java.io.IOException,
                         TerminatedStateException
```
    Specified by:
    
    authenticate in class SshAuthenticationClient
    
    Parameters:
    
    authentication -
    
    serviceToStart -
    
    Throws:
    
    java.io.IOException
    
    TerminatedStateException
    
    AuthenticationProtocolException
  - getPersistableProperties
```
public java.util.Properties getPersistableProperties()
```
    Specified by:
    
    getPersistableProperties in class SshAuthenticationClient
    
    Returns:
  - setPersistableProperties
```
public void setPersistableProperties(java.util.Properties properties)
```
    Specified by:
    
    setPersistableProperties in class SshAuthenticationClient
    
    Parameters:
    
    properties -
  - canAuthenticate
```
public boolean canAuthenticate()
```
    Specified by:
    
    canAuthenticate in class SshAuthenticationClient
    
    Returns:

Class HostbasedAuthenticationClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.sshtools.j2ssh.authentication.SshAuthenticationClient

Methods inherited from class java.lang.Object

Field Detail

key

Constructor Detail

HostbasedAuthenticationClient

Method Detail

setKey

reset

setClientUsername

getMethodName

authenticate

getPersistableProperties

setPersistableProperties

canAuthenticate