Package org.apache.commons.vfs2.provider.sftp

Class BytesIdentityInfo

java.lang.Object

org.apache.commons.vfs2.provider.sftp.BytesIdentityInfo

All Implemented Interfaces:

IdentityProvider

public class BytesIdentityInfo
extends Object
implements IdentityProvider

Structure for an identity based on byte arrays.

Since:

2.4

Field Summary

Fields

Modifier and Type	Field	Description
private final byte[]	passphrase
private final byte[]	privateKey
private final byte[]	publicKey

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

passphrase

private final byte[] passphrase

privateKey

private final byte[] privateKey

publicKey

private final byte[] publicKey

Constructor Details

BytesIdentityInfo

public BytesIdentityInfo(byte[] privateKey,
 byte[] passphrase)

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

Parameters:

privateKey - Private key bytes

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

BytesIdentityInfo

public BytesIdentityInfo(byte[] privateKey,
 byte[] publicKey,
 byte[] passphrase)

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

Parameters:

privateKey - Private key bytes

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)

Method Details

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.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getPassphrase

public byte[] getPassphrase()

Gets the passphrase.

Returns:

the passphrase.

Since:

2.10.0

getPassPhrase

@Deprecated
public byte[] getPassPhrase()

Deprecated.

Use getPassphrase().

Gets the passphrase.

Returns:

the passphrase.

getPrivateKeyBytes

public byte[] getPrivateKeyBytes()

Gets the private key.

Returns:

the private key.

getPublicKeyBytes

public byte[] getPublicKeyBytes()

Gets the public key.

Returns:

the public key.

hashCode

public int hashCode()

Overrides:

hashCode in class Object