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
  • Field Details

    • passPhrase

      private final byte[] passPhrase
    • privateKey

      private final File privateKey
    • publicKey

      private final File publicKey
  • Constructor Details

    • 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 Details

    • addIdentity

      public void addIdentity(com.jcraft.jsch.JSch jsch) throws com.jcraft.jsch.JSchException
      Specified by:
      addIdentity in interface IdentityProvider
      Throws:
      com.jcraft.jsch.JSchException
      Since:
      2.4
    • getAbsolutePath

      private String getAbsolutePath(File file)
    • getPassPhrase

      public byte[] getPassPhrase()
      Get the passphrase of the private key.
      Returns:
      the passphrase
      Since:
      2.1
    • getPrivateKey

      public File getPrivateKey()
      Get the file with the private key.
      Returns:
      the file
      Since:
      2.1
    • getPublicKey

      public File getPublicKey()
      Get the file with the public key.
      Returns:
      the file
      Since:
      2.1