org.apache.commons.vfs2.provider.sftp

Class IdentityInfo

java.lang.Object

org.apache.commons.vfs2.provider.sftp.IdentityInfo

All Implemented Interfaces:

IdentityProvider

public class IdentityInfo
extends Object
implements IdentityProvider

Structure for an identity based on Files.

Since:

2.1

Constructor Summary

Constructors

Constructor and Description
IdentityInfo(File privateKey) Constructs an identity info with private key.
IdentityInfo(File privateKey, byte[] passphrase) Constructs an identity info with private key and its passphrase.
IdentityInfo(File privateKey, File publicKey, byte[] passphrase) Constructs an identity info with private and public key and passphrase for the private key.

Method Summary

Modifier and Type	Method and Description
void	addIdentity(com.jcraft.jsch.JSch jsch) Add this identity to the given JSch.
boolean	equals(Object obj)
byte[]	getPassphrase() Gets the passphrase of the private key.
byte[]	getPassPhrase() Deprecated. Use getPassphrase().
File	getPrivateKey() Gets the file with the private key.
File	getPublicKey() Gets the file with the public key.
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IdentityInfo

public IdentityInfo(File privateKey)

Constructs an identity info with private key.

The key is not passphrase protected.

We use java.io.File because JSch cannot deal with VFS FileObjects.

Parameters:

privateKey - The file with the private key

Since:

2.1

IdentityInfo

public IdentityInfo(File privateKey,
                    byte[] passphrase)

Constructs an identity info with private key and its passphrase.

We use java.io.File because JSch cannot deal with VFS FileObjects.

Parameters:

privateKey - The file with the private key

passphrase - The passphrase to decrypt the private key (can be null if no passphrase is used)

Since:

2.1

IdentityInfo

public IdentityInfo(File privateKey,
                    File publicKey,
                    byte[] passphrase)

Constructs an identity info with private and public key and passphrase for the private key.

We use java.io.File because JSch cannot deal with VFS FileObjects.

Parameters:

privateKey - The file with the private key

publicKey - The public key part used for connections with exchange of certificates (can be null)

passphrase - The passphrase to decrypt the private key (can be null if no passphrase is used)

Since:

2.1

Method Detail

addIdentity

public void addIdentity(com.jcraft.jsch.JSch jsch)
                 throws com.jcraft.jsch.JSchException

Description copied from interface: IdentityProvider

Add this identity to the given JSch.

Specified by:

addIdentity in interface IdentityProvider

Parameters:

jsch - Target JSch.

Throws:

com.jcraft.jsch.JSchException - If I/O error occurs.

Since:

2.4

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getPassphrase

public byte[] getPassphrase()

Gets the passphrase of the private key.

Returns:

the passphrase

Since:

2.10.0

getPassPhrase

@Deprecated
public byte[] getPassPhrase()

Deprecated. Use getPassphrase().

Gets the passphrase of the private key.

Returns:

the passphrase

Since:

2.1

getPrivateKey

public File getPrivateKey()

Gets the file with the private key.

Returns:

the file

Since:

2.1

getPublicKey

public File getPublicKey()

Gets the file with the public key.

Returns:

the file

Since:

2.1

hashCode

public int hashCode()

Overrides:

hashCode in class Object