net.sf.sshapi.identity

Interface SshPublicKeyFile

public interface SshPublicKeyFile

Represent a persisted SshPublicKey. Provider implementations are capable of reading some known public key format, and presenting as an instance of this interface.

Field Summary

Fields

Modifier and Type	Field and Description
static int	OPENSSH_FORMAT OpenSSH
static int	SECSH_FORMAT SECSH
static int	SSH1_FORMAT SSH1
static int	SSHTOOLS_FORMAT SSHTools

Method Summary

Modifier and Type	Method and Description
java.lang.String	getComment() Get any comment stored with this key (if supported by provider / format).
int	getFormat() Get the format of this key.
byte[]	getFormattedKey() Format the key for storage.
java.lang.String	getOptions() Get any additional options stored with this key (if supported by provider / format)
SshPublicKey	getPublicKey() Get the actual public key.

Field Detail

OPENSSH_FORMAT

static final int OPENSSH_FORMAT

OpenSSH

See Also:

Constant Field Values

SECSH_FORMAT

static final int SECSH_FORMAT

SECSH

See Also:

Constant Field Values

SSH1_FORMAT

static final int SSH1_FORMAT

SSH1

See Also:

Constant Field Values

SSHTOOLS_FORMAT

static final int SSHTOOLS_FORMAT

SSHTools

See Also:

Constant Field Values

Method Detail

getFormat

int getFormat()

Get the format of this key. Will be one of the _FORMAT constants that are part of this interface.

Returns:

format

getPublicKey

SshPublicKey getPublicKey()
                   throws SshException

Get the actual public key.

Returns:

public key

Throws:

SshException

getComment

java.lang.String getComment()

Get any comment stored with this key (if supported by provider / format).

Returns:

comment

getFormattedKey

byte[] getFormattedKey()
                throws java.io.IOException

Format the key for storage.

Returns:

formatted key

Throws:

java.io.IOException

getOptions

java.lang.String getOptions()

Get any additional options stored with this key (if supported by provider / format)

Returns:

additional options