com.cloudbees.jenkins.plugins.sshcredentials.impl
Class BaseSSHUser

java.lang.Object
  com.cloudbees.plugins.credentials.BaseCredentials
      com.cloudbees.jenkins.plugins.sshcredentials.impl.BaseSSHUser

All Implemented Interfaces:

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

Direct Known Subclasses:

BasicSSHUserPassword, BasicSSHUserPrivateKey

public class BaseSSHUser
extends com.cloudbees.plugins.credentials.BaseCredentials
implements SSHUser

Since:

28/02/2012 13:44

Author:

stephenc

See Also:

Serialized Form

Field Summary

protected java.lang.String	description The description.
protected java.lang.String	id The id.
protected java.lang.String	username The username.

Constructor Summary

BaseSSHUser(com.cloudbees.plugins.credentials.CredentialsScope scope, java.lang.String id, java.lang.String username, java.lang.String description)

Method Summary

java.lang.String	getDescription() The display description of this credential (e.g.
java.lang.String	getId() Returns a unique Id that can be used to find this user record again.
java.lang.String	getUsername() The SSH username

Methods inherited from class com.cloudbees.plugins.credentials.BaseCredentials

getDescriptor, getScope

Methods inherited from class java.lang.Object

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

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

getDescriptor, getScope

Field Detail

id

protected final java.lang.String id

The id.

description

protected final java.lang.String description

The description.

username

protected final java.lang.String username

The username.

Constructor Detail

BaseSSHUser

public BaseSSHUser(com.cloudbees.plugins.credentials.CredentialsScope scope,
                   java.lang.String id,
                   java.lang.String username,
                   java.lang.String description)

Method Detail

getId

@NonNull
public java.lang.String getId()

Returns a unique Id that can be used to find this user record again. In the default implementations provided by this plugin, IDs are auto-generated.

Specified by:

getId in interface SSHUser

Returns:

a unique Id that can be used to find this user record again.

getUsername

@NonNull
public java.lang.String getUsername()

The SSH username

Specified by:

getUsername in interface SSHUser

Returns:

The SSH username

getDescription

@NonNull
public java.lang.String getDescription()

The display description of this credential (e.g. the host name / domain that the user details apply to)

Specified by:

getDescription in interface SSHUser

Returns:

The display description of this credential.