com.cloudbees.jenkins.plugins.sshcredentials
Interface SSHUserPrivateKey

All Superinterfaces:

com.cloudbees.plugins.credentials.Credentials, hudson.model.Describable<com.cloudbees.plugins.credentials.Credentials>, java.io.Serializable, SSHUser

All Known Implementing Classes:

BasicSSHUserPrivateKey

public interface SSHUserPrivateKey
extends SSHUser

Details of a SSH user with a private key.

Method Summary

hudson.util.Secret	getPassphrase() Gets the passphrase for the private key or null if the private key is not protected by a passphase.
java.lang.String	getPrivateKey() Returns the private key.

Methods inherited from interface com.cloudbees.jenkins.plugins.sshcredentials.SSHUser

getDescription, getId, getUsername

Methods inherited from interface com.cloudbees.plugins.credentials.Credentials

getDescriptor, getScope

Method Detail

getPrivateKey

@NonNull
java.lang.String getPrivateKey()

Returns the private key. This should be in OpenSSH format.

Returns:

the private key in OpenSSH format.

getPassphrase

@CheckForNull
hudson.util.Secret getPassphrase()

Gets the passphrase for the private key or null if the private key is not protected by a passphase.

Returns:

the passphrase for the private key or null if the private key is not protected by a passphase.