com.offbytwo.jenkins.model.credentials

Class SSHKeyCredential

java.lang.Object

com.offbytwo.jenkins.model.BaseModel

com.offbytwo.jenkins.model.credentials.Credential

com.offbytwo.jenkins.model.credentials.SSHKeyCredential

public class SSHKeyCredential
extends Credential

SSH Key Credential type. Can be used with 1.x and 2.x versions of the credentials plugin.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SSHKeyCredential.PRIVATE_KEY_TYPES The type of the private key.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPENAME

Fields inherited from class com.offbytwo.jenkins.model.credentials.Credential

SCOPE_GLOBAL

Fields inherited from class com.offbytwo.jenkins.model.BaseModel

client

Constructor Summary

Constructors

Constructor and Description
SSHKeyCredential()

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	dataForCreate()
Map<String,Object>	dataForUpdate()
String	getPassphrase()
SSHKeyCredential.PRIVATE_KEY_TYPES	getPrivateKeyType()
String	getPrivateKeyValue()
String	getUsername()
void	setPassphrase(String passphrase) Set the passphrash of the ssh key
void	setPrivateKeyType(SSHKeyCredential.PRIVATE_KEY_TYPES privateKeyType) The source of the private key.
void	setPrivateKeyValue(String privateKeyValue) Set the value of the private key.
void	setUsername(String username) Set the username of the ssh key

Methods inherited from class com.offbytwo.jenkins.model.credentials.Credential

getDescription, getDisplayName, getFullName, getId, getScope, getTypeName, setDescription, setDisplayName, setFullName, setId, setScope, setTypeName, useMultipartForm

Methods inherited from class com.offbytwo.jenkins.model.BaseModel

get_class, getClient, setClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPENAME

public static final String TYPENAME

See Also:

Constant Field Values

Constructor Detail

SSHKeyCredential

public SSHKeyCredential()

Method Detail

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

Set the username of the ssh key

Parameters:

username -

getPassphrase

public String getPassphrase()

setPassphrase

public void setPassphrase(String passphrase)

Set the passphrash of the ssh key

Parameters:

passphrase -

getPrivateKeyValue

public String getPrivateKeyValue()

setPrivateKeyValue

public void setPrivateKeyValue(String privateKeyValue)

Set the value of the private key. Depending on the type of the private key, it should be either the content of the key, or the path of the private key file.

Parameters:

privateKeyValue -

getPrivateKeyType

public SSHKeyCredential.PRIVATE_KEY_TYPES getPrivateKeyType()

setPrivateKeyType

public void setPrivateKeyType(SSHKeyCredential.PRIVATE_KEY_TYPES privateKeyType)

The source of the private key.

Parameters:

privateKeyType -

dataForCreate

public Map<String,Object> dataForCreate()

Specified by:

dataForCreate in class Credential

dataForUpdate

public Map<String,Object> dataForUpdate()

Specified by:

dataForUpdate in class Credential