SSHFTPAlgorithm (edtFTPj/PRO by Enterprise Distributed Technologies Ltd)

java.lang.Object
- com.enterprisedt.net.ftp.ssh.SSHFTPAlgorithm

```
public class SSHFTPAlgorithm
extends java.lang.Object
```
Each instance of SSHFTPAlgorithm corresponds to one particular algorithm. Each algorithm is of one type. There are five types of algorithms:

Cipher (CIPHER)
Used for encrypting data.
Compression (COMPRESSION)
Used for compressing data.
Key-exchange (KEY_EXCHANGE)
Used for exchanding keys.
Key-pair (KEY_PAID)
Used for generating key-pairs.
MAC (MAC)
Used for generating/verifying Message Authentication Codes.
SSHFTPAlgorithm has a static integer for each algorithm-type. Instances of SSHFTPAlgorithm cannot be created, instead a static member variable for each supported algorithm is provided. Methods are also provided for obtaining a list of supported algorithms.

Version:

$Revision: 1.20 $

Author:

Hans Andersen

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CIPHER` Integer defining the algorithm-type, cipher.
`static SSHFTPAlgorithm`	`CIPHER_3DES_CBC` Instance of `SSHFTPAlgorithm` corresponding to the 3DES cipher algorithm.
`static SSHFTPAlgorithm`	`CIPHER_AES128_CBC` Instance of `SSHFTPAlgorithm` corresponding to the Rijndael-128 cipher algorithm.
`static SSHFTPAlgorithm`	`CIPHER_AES128_CTR` Instance of `SSHFTPAlgorithm` corresponding to the AES-128 cipher algorithm in CTR mode
`static SSHFTPAlgorithm`	`CIPHER_AES192_CBC` Instance of `SSHFTPAlgorithm` corresponding to the AES-192 cipher algorithm.
`static SSHFTPAlgorithm`	`CIPHER_AES192_CTR` Instance of `SSHFTPAlgorithm` corresponding to the AES-192 cipher algorithm in CTR mode
`static SSHFTPAlgorithm`	`CIPHER_AES256_CBC` Instance of `SSHFTPAlgorithm` corresponding to the AES-256 cipher algorithm.
`static SSHFTPAlgorithm`	`CIPHER_AES256_CTR` Instance of `SSHFTPAlgorithm` corresponding to the AES-256 cipher algorithm in CTR mode
`static SSHFTPAlgorithm`	`CIPHER_ARCFOUR` Instance of `SSHFTPAlgorithm` corresponding to the ARCFour cipher algorithm.
`static SSHFTPAlgorithm`	`CIPHER_BLOWFISH_CBC` Instance of `SSHFTPAlgorithm` corresponding to the Blowfish cipher algorithm.
`static int`	`COMPRESSION` Integer defining the algorithm-type, compression.
`static SSHFTPAlgorithm`	`COMPRESSION_NONE` Instance of `SSHFTPAlgorithm` corresponding to the null compression algorithm.
`static SSHFTPAlgorithm`	`COMPRESSION_ZLIB` Instance of `SSHFTPAlgorithm` corresponding to the zlib compression algorithm.
`static SSHFTPAlgorithm`	`COMPRESSION_ZLIB_DELAYED` Instance of `SSHFTPAlgorithm` corresponding to the delayed zlib compression algorithm.
`static SSHFTPAlgorithm`	`KEY_DSA` Instance of `SSHFTPAlgorithm` corresponding to the DSA key algorithm.
`static SSHFTPAlgorithm`	`KEY_ECDSA_SHA2_NISTP256` Instance of `SSHFTPAlgorithm` corresponding to the ECDSA key algorithm.
`static SSHFTPAlgorithm`	`KEY_ECDSA_SHA2_NISTP384` Instance of `SSHFTPAlgorithm` corresponding to the ECDSA key algorithm.
`static SSHFTPAlgorithm`	`KEY_ECDSA_SHA2_NISTP521` Instance of `SSHFTPAlgorithm` corresponding to the ECDSA key algorithm.
`static int`	`KEY_EXCHANGE` Integer defining the algorithm-type, key-exchange.
`static SSHFTPAlgorithm`	`KEY_EXCHANGE_DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA1` Instance of `SSHFTPAlgorithm` corresponding to the DH group key exchange algorithm.
`static SSHFTPAlgorithm`	`KEY_EXCHANGE_DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA256` Instance of `SSHFTPAlgorithm` corresponding to the DH group key exchange algorithm.
`static SSHFTPAlgorithm`	`KEY_EXCHANGE_DIFFIE_HELLMAN_GROUP1_SHA1` Instance of `SSHFTPAlgorithm` corresponding to the DH group key exchange algorithm.
`static SSHFTPAlgorithm`	`KEY_EXCHANGE_DIFFIE_HELLMAN_GROUP14_SHA1` Instance of `SSHFTPAlgorithm` corresponding to the DH group key exchange algorithm.
`static SSHFTPAlgorithm`	`KEY_EXCHANGE_DIFFIE_HELLMAN_GROUP14_SHA256` Instance of `SSHFTPAlgorithm` corresponding to the DH group key exchange algorithm.
`static SSHFTPAlgorithm`	`KEY_EXCHANGE_ECDH_SHA2_NISTP256` Instance of `SSHFTPAlgorithm` corresponding to the ECDH_SHA2_NISTP256 group key exchange algorithm.
`static SSHFTPAlgorithm`	`KEY_EXCHANGE_ECDH_SHA2_NISTP384` Instance of `SSHFTPAlgorithm` corresponding to the ECDH_SHA2_NISTP384 group key exchange algorithm.
`static SSHFTPAlgorithm`	`KEY_EXCHANGE_ECDH_SHA2_NISTP521` Instance of `SSHFTPAlgorithm` corresponding to the ECDH_SHA2_NISTP521 group key exchange algorithm.
`static int`	`KEY_PAIR` Integer defining the algorithm-type, key-pair.
`static SSHFTPAlgorithm`	`KEY_RSA` Instance of `SSHFTPAlgorithm` corresponding to the RSA key algorithm.
`static SSHFTPAlgorithm`	`KEY_RSA_SHA2_256` Instance of `SSHFTPAlgorithm` corresponding to the RSA key algorithm with SHA256
`static SSHFTPAlgorithm`	`KEY_RSA_SHA2_512` Instance of `SSHFTPAlgorithm` corresponding to the RSA key algorithm with SHA512
`static int`	`MAC` Integer defining the algorithm-type, MAC.
`static SSHFTPAlgorithm`	`MAC_MD5` Instance of `SSHFTPAlgorithm` corresponding to the MD5 MAC algorithm.
`static SSHFTPAlgorithm`	`MAC_MD5_96` Instance of `SSHFTPAlgorithm` corresponding to the MD5-96 MAC algorithm.
`static SSHFTPAlgorithm`	`MAC_SHA_256` Instance of `SSHFTPAlgorithm` corresponding to the SHA2-256 MAC algorithm.
`static SSHFTPAlgorithm`	`MAC_SHA_512` Instance of `SSHFTPAlgorithm` corresponding to the SHA2-512 MAC algorithm.
`static SSHFTPAlgorithm`	`MAC_SHA1` Instance of `SSHFTPAlgorithm` corresponding to the SHA1 MAC algorithm.
`static SSHFTPAlgorithm`	`MAC_SHA1_96` Instance of `SSHFTPAlgorithm` corresponding to the SHA1-96 MAC algorithm.
`static SSHFTPAlgorithm`	`MAC_SHA2_256` Instance of `SSHFTPAlgorithm` corresponding to the SHA2-256 MAC algorithm.
`static SSHFTPAlgorithm`	`MAC_SHA2_512` Instance of `SSHFTPAlgorithm` corresponding to the SHA2-512 MAC algorithm.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SSHFTPAlgorithm`	`getAlgorithm(java.lang.String code)` Returns the algorithm with the given code.
`static SSHFTPAlgorithm[]`	`getAlgorithms()` Returns an array of all supported algorithms.
`static SSHFTPAlgorithm[]`	`getAlgorithms(int algorithmType)` Returns an array of all supported algorithms of the specified type.
`java.lang.String`	`getCode()` Returns the code of the algorithm.
`int`	`getType()` Returns the type of the algorithm.
`java.lang.String`	`toString()` Returns a string representation of the algorithm.

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

- Field Detail
  - CIPHER
```
public static final int CIPHER
```
    Integer defining the algorithm-type, cipher.
    
    See Also:
    
    Constant Field Values
  - COMPRESSION
```
public static final int COMPRESSION
```
    Integer defining the algorithm-type, compression.
    
    See Also:
    
    Constant Field Values
  - KEY_EXCHANGE
```
public static final int KEY_EXCHANGE
```
    Integer defining the algorithm-type, key-exchange.
    
    See Also:
    
    Constant Field Values
  - KEY_PAIR
```
public static final int KEY_PAIR
```
    Integer defining the algorithm-type, key-pair.
    
    See Also:
    
    Constant Field Values
  - MAC
```
public static final int MAC
```
    Integer defining the algorithm-type, MAC.
    
    See Also:
    
    Constant Field Values
  - CIPHER_3DES_CBC
```
public static final SSHFTPAlgorithm CIPHER_3DES_CBC
```
    Instance of SSHFTPAlgorithm corresponding to the 3DES cipher algorithm.
  - CIPHER_BLOWFISH_CBC
```
public static final SSHFTPAlgorithm CIPHER_BLOWFISH_CBC
```
    Instance of SSHFTPAlgorithm corresponding to the Blowfish cipher algorithm.
  - CIPHER_AES128_CBC
```
public static final SSHFTPAlgorithm CIPHER_AES128_CBC
```
    Instance of SSHFTPAlgorithm corresponding to the Rijndael-128 cipher algorithm.
  - CIPHER_AES192_CBC
```
public static final SSHFTPAlgorithm CIPHER_AES192_CBC
```
    Instance of SSHFTPAlgorithm corresponding to the AES-192 cipher algorithm.
  - CIPHER_AES256_CBC
```
public static final SSHFTPAlgorithm CIPHER_AES256_CBC
```
    Instance of SSHFTPAlgorithm corresponding to the AES-256 cipher algorithm.
  - CIPHER_AES128_CTR
```
public static final SSHFTPAlgorithm CIPHER_AES128_CTR
```
    Instance of SSHFTPAlgorithm corresponding to the AES-128 cipher algorithm in CTR mode
  - CIPHER_AES192_CTR
```
public static final SSHFTPAlgorithm CIPHER_AES192_CTR
```
    Instance of SSHFTPAlgorithm corresponding to the AES-192 cipher algorithm in CTR mode
  - CIPHER_AES256_CTR
```
public static final SSHFTPAlgorithm CIPHER_AES256_CTR
```
    Instance of SSHFTPAlgorithm corresponding to the AES-256 cipher algorithm in CTR mode
  - CIPHER_ARCFOUR
```
public static final SSHFTPAlgorithm CIPHER_ARCFOUR
```
    Instance of SSHFTPAlgorithm corresponding to the ARCFour cipher algorithm.
  - COMPRESSION_NONE
```
public static final SSHFTPAlgorithm COMPRESSION_NONE
```
    Instance of SSHFTPAlgorithm corresponding to the null compression algorithm.
  - COMPRESSION_ZLIB
```
public static final SSHFTPAlgorithm COMPRESSION_ZLIB
```
    Instance of SSHFTPAlgorithm corresponding to the zlib compression algorithm.
  - COMPRESSION_ZLIB_DELAYED
```
public static final SSHFTPAlgorithm COMPRESSION_ZLIB_DELAYED
```
    Instance of SSHFTPAlgorithm corresponding to the delayed zlib compression algorithm.
  - KEY_EXCHANGE_ECDH_SHA2_NISTP256
```
public static final SSHFTPAlgorithm KEY_EXCHANGE_ECDH_SHA2_NISTP256
```
    Instance of SSHFTPAlgorithm corresponding to the ECDH_SHA2_NISTP256 group key exchange algorithm.
  - KEY_EXCHANGE_ECDH_SHA2_NISTP384
```
public static final SSHFTPAlgorithm KEY_EXCHANGE_ECDH_SHA2_NISTP384
```
    Instance of SSHFTPAlgorithm corresponding to the ECDH_SHA2_NISTP384 group key exchange algorithm.
  - KEY_EXCHANGE_ECDH_SHA2_NISTP521
```
public static final SSHFTPAlgorithm KEY_EXCHANGE_ECDH_SHA2_NISTP521
```
    Instance of SSHFTPAlgorithm corresponding to the ECDH_SHA2_NISTP521 group key exchange algorithm.
  - KEY_EXCHANGE_DIFFIE_HELLMAN_GROUP1_SHA1
```
public static final SSHFTPAlgorithm KEY_EXCHANGE_DIFFIE_HELLMAN_GROUP1_SHA1
```
    Instance of SSHFTPAlgorithm corresponding to the DH group key exchange algorithm.
  - KEY_EXCHANGE_DIFFIE_HELLMAN_GROUP14_SHA1
```
public static final SSHFTPAlgorithm KEY_EXCHANGE_DIFFIE_HELLMAN_GROUP14_SHA1
```
    Instance of SSHFTPAlgorithm corresponding to the DH group key exchange algorithm.
  - KEY_EXCHANGE_DIFFIE_HELLMAN_GROUP14_SHA256
```
public static final SSHFTPAlgorithm KEY_EXCHANGE_DIFFIE_HELLMAN_GROUP14_SHA256
```
    Instance of SSHFTPAlgorithm corresponding to the DH group key exchange algorithm.
  - KEY_EXCHANGE_DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA1
```
public static final SSHFTPAlgorithm KEY_EXCHANGE_DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA1
```
    Instance of SSHFTPAlgorithm corresponding to the DH group key exchange algorithm.
  - KEY_EXCHANGE_DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA256
```
public static final SSHFTPAlgorithm KEY_EXCHANGE_DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA256
```
    Instance of SSHFTPAlgorithm corresponding to the DH group key exchange algorithm.
  - KEY_RSA
```
public static final SSHFTPAlgorithm KEY_RSA
```
    Instance of SSHFTPAlgorithm corresponding to the RSA key algorithm.
  - KEY_RSA_SHA2_256
```
public static final SSHFTPAlgorithm KEY_RSA_SHA2_256
```
    Instance of SSHFTPAlgorithm corresponding to the RSA key algorithm with SHA256
  - KEY_RSA_SHA2_512
```
public static final SSHFTPAlgorithm KEY_RSA_SHA2_512
```
    Instance of SSHFTPAlgorithm corresponding to the RSA key algorithm with SHA512
  - KEY_DSA
```
public static final SSHFTPAlgorithm KEY_DSA
```
    Instance of SSHFTPAlgorithm corresponding to the DSA key algorithm.
  - KEY_ECDSA_SHA2_NISTP256
```
public static final SSHFTPAlgorithm KEY_ECDSA_SHA2_NISTP256
```
    Instance of SSHFTPAlgorithm corresponding to the ECDSA key algorithm.
  - KEY_ECDSA_SHA2_NISTP384
```
public static final SSHFTPAlgorithm KEY_ECDSA_SHA2_NISTP384
```
    Instance of SSHFTPAlgorithm corresponding to the ECDSA key algorithm.
  - KEY_ECDSA_SHA2_NISTP521
```
public static final SSHFTPAlgorithm KEY_ECDSA_SHA2_NISTP521
```
    Instance of SSHFTPAlgorithm corresponding to the ECDSA key algorithm.
  - MAC_MD5_96
```
public static final SSHFTPAlgorithm MAC_MD5_96
```
    Instance of SSHFTPAlgorithm corresponding to the MD5-96 MAC algorithm.
  - MAC_MD5
```
public static final SSHFTPAlgorithm MAC_MD5
```
    Instance of SSHFTPAlgorithm corresponding to the MD5 MAC algorithm.
  - MAC_SHA1_96
```
public static final SSHFTPAlgorithm MAC_SHA1_96
```
    Instance of SSHFTPAlgorithm corresponding to the SHA1-96 MAC algorithm.
  - MAC_SHA1
```
public static final SSHFTPAlgorithm MAC_SHA1
```
    Instance of SSHFTPAlgorithm corresponding to the SHA1 MAC algorithm.
  - MAC_SHA2_256
```
public static final SSHFTPAlgorithm MAC_SHA2_256
```
    Instance of SSHFTPAlgorithm corresponding to the SHA2-256 MAC algorithm.
  - MAC_SHA_256
```
public static final SSHFTPAlgorithm MAC_SHA_256
```
    Instance of SSHFTPAlgorithm corresponding to the SHA2-256 MAC algorithm.
  - MAC_SHA2_512
```
public static final SSHFTPAlgorithm MAC_SHA2_512
```
    Instance of SSHFTPAlgorithm corresponding to the SHA2-512 MAC algorithm.
  - MAC_SHA_512
```
public static final SSHFTPAlgorithm MAC_SHA_512
```
    Instance of SSHFTPAlgorithm corresponding to the SHA2-512 MAC algorithm.
- Method Detail
  - getAlgorithms
```
public static SSHFTPAlgorithm[] getAlgorithms()
```
    Returns an array of all supported algorithms.
  - getAlgorithms
```
public static SSHFTPAlgorithm[] getAlgorithms(int algorithmType)
                                       throws SSHFTPException
```
    Returns an array of all supported algorithms of the specified type.
    
    Throws:
    
    SSHFTPException - Thrown if the given algorithm-type is invalid.
  - getAlgorithm
```
public static SSHFTPAlgorithm getAlgorithm(java.lang.String code)
```
    Returns the algorithm with the given code.
  - getCode
```
public java.lang.String getCode()
```
    Returns the code of the algorithm.
    
    Returns:
    
    The code of the algorithm.
  - getType
```
public int getType()
```
    Returns the type of the algorithm.
    
    Returns:
    
    The type of the algorithm.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of the algorithm.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of the algorithm.

Class SSHFTPAlgorithm

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CIPHER

COMPRESSION

KEY_EXCHANGE

KEY_PAIR

MAC

CIPHER_3DES_CBC

CIPHER_BLOWFISH_CBC

CIPHER_AES128_CBC

CIPHER_AES192_CBC

CIPHER_AES256_CBC

CIPHER_AES128_CTR

CIPHER_AES192_CTR

CIPHER_AES256_CTR

CIPHER_ARCFOUR

COMPRESSION_NONE

COMPRESSION_ZLIB

COMPRESSION_ZLIB_DELAYED

KEY_EXCHANGE_ECDH_SHA2_NISTP256

KEY_EXCHANGE_ECDH_SHA2_NISTP384

KEY_EXCHANGE_ECDH_SHA2_NISTP521

KEY_EXCHANGE_DIFFIE_HELLMAN_GROUP1_SHA1

KEY_EXCHANGE_DIFFIE_HELLMAN_GROUP14_SHA1

KEY_EXCHANGE_DIFFIE_HELLMAN_GROUP14_SHA256

KEY_EXCHANGE_DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA1

KEY_EXCHANGE_DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA256

KEY_RSA

KEY_RSA_SHA2_256

KEY_RSA_SHA2_512

KEY_DSA

KEY_ECDSA_SHA2_NISTP256

KEY_ECDSA_SHA2_NISTP384

KEY_ECDSA_SHA2_NISTP521

MAC_MD5_96

MAC_MD5

MAC_SHA1_96

MAC_SHA1

MAC_SHA2_256

MAC_SHA_256

MAC_SHA2_512

MAC_SHA_512

Method Detail

getAlgorithms

getAlgorithms

getAlgorithm

getCode

getType

toString