com.cloudbees.jenkins.plugins.sshcredentials

Interface SSHUserPrivateKey

All Superinterfaces:

com.cloudbees.plugins.credentials.Credentials, hudson.model.Describable<com.cloudbees.plugins.credentials.Credentials>, hudson.ExtensionPoint, com.cloudbees.plugins.credentials.common.IdCredentials, Serializable, SSHUser, com.cloudbees.plugins.credentials.common.StandardCredentials, com.cloudbees.plugins.credentials.common.StandardUsernameCredentials, com.cloudbees.plugins.credentials.common.UsernameCredentials

All Known Implementing Classes:

BasicSSHUserPrivateKey

public interface SSHUserPrivateKey
extends SSHUser

Details of a SSH user with a private key.

Nested Class Summary

Nested classes/interfaces inherited from interface com.cloudbees.plugins.credentials.common.StandardUsernameCredentials

com.cloudbees.plugins.credentials.common.StandardUsernameCredentials.NameProvider

Nested classes/interfaces inherited from interface com.cloudbees.plugins.credentials.common.IdCredentials

com.cloudbees.plugins.credentials.common.IdCredentials.Helpers

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Method Summary

Modifier and Type	Method and Description
hudson.util.Secret	getPassphrase() Gets the passphrase for the private keys or null if the private keys are not protected by a passphase.
String	getPrivateKey() Deprecated. use getPrivateKeys()
List<String>	getPrivateKeys() Returns a collection of keys to try in order for authentication.

Methods inherited from interface com.cloudbees.plugins.credentials.common.StandardCredentials

getDescription

Methods inherited from interface com.cloudbees.plugins.credentials.common.IdCredentials

getId

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

getDescriptor, getScope

Methods inherited from interface com.cloudbees.plugins.credentials.common.UsernameCredentials

getUsername

Method Detail

getPrivateKey

@Deprecated
 @NonNull
String getPrivateKey()

Deprecated. use getPrivateKeys()

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

Returns:

This is the actual content of the first private key and not the path to the private key.

getPassphrase

@CheckForNull
hudson.util.Secret getPassphrase()

Gets the passphrase for the private keys or null if the private keys are not protected by a passphase.

Returns:

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

getPrivateKeys

@NonNull
List<String> getPrivateKeys()

Returns a collection of keys to try in order for authentication.

Returns:

a collection of keys to try in order for authentication.

Since:

0.5

See Also:

SSHAuthenticator.getPrivateKeys(com.cloudbees.jenkins.plugins.sshcredentials.SSHUserPrivateKey)