org.ow2.petals.bc.sftp.authentication
Class SshPasswordAuthentication

java.lang.Object
  org.ow2.petals.bc.sftp.authentication.SshAuthentication
      org.ow2.petals.bc.sftp.authentication.SshPasswordAuthentication

public final class SshPasswordAuthentication
extends SshAuthentication

Utility class that holds the informations used by the component to perform a user / password authentication onto the SSH server.

Author:

Charles Casadei - eBM WebSourcing

Constructor Summary

SshPasswordAuthentication(java.lang.String user, java.lang.String password)
Default constructor.

Method Summary

com.sshtools.j2ssh.authentication.SshAuthenticationClient	getAuthenticationClient() Builds the object used by the SFTPClientPool to perform the authentication on the SSH server.
java.lang.String	getKey() Builds & returns a portion of the key used by the SFTPClientPool to identify a SSH session.
java.lang.String	getPassword() Accessor on the password used for SSH user / password authentication.
java.lang.String	toString() Return the object content as String (Overrides the toString method).

Methods inherited from class org.ow2.petals.bc.sftp.authentication.SshAuthentication

getUser

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SshPasswordAuthentication

public SshPasswordAuthentication(java.lang.String user,
                                 java.lang.String password)
                          throws ConfigurationException

Default constructor. Initialize the user and the password holded by an instance of this class with the given values

Parameters:

user - the username used for SSH user / password authentication

password - the password used for SSH user / password authentication

Throws:

ConfigurationException - if the configuration is not valid

Method Detail

getPassword

public final java.lang.String getPassword()

Accessor on the password used for SSH user / password authentication.

Returns:

the password used for SSH user / password authentication

getAuthenticationClient

public final com.sshtools.j2ssh.authentication.SshAuthenticationClient getAuthenticationClient()

Builds the object used by the SFTPClientPool to perform the authentication on the SSH server.

Specified by:

getAuthenticationClient in class SshAuthentication

Returns:

an object used by the SFTPClientPool to perform the authentication

getKey

public final java.lang.String getKey()

Builds & returns a portion of the key used by the SFTPClientPool to identify a SSH session.

Specified by:

getKey in class SshAuthentication

Returns:

a portion of the key used by the SFTPClientPool

toString

public final java.lang.String toString()

Return the object content as String (Overrides the toString method).

Overrides:

toString in class SshAuthentication

Returns:

the object content as String