com.cloudbees.jenkins.plugins.sshcredentials

Class SSHUserListBoxModel

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<hudson.util.ListBoxModel.Option>

hudson.util.ListBoxModel

com.cloudbees.plugins.credentials.common.AbstractIdCredentialsListBoxModel<SSHUserListBoxModel,com.cloudbees.plugins.credentials.common.StandardUsernameCredentials>

com.cloudbees.jenkins.plugins.sshcredentials.SSHUserListBoxModel

All Implemented Interfaces:

Serializable, Cloneable, Iterable<hudson.util.ListBoxModel.Option>, Collection<hudson.util.ListBoxModel.Option>, List<hudson.util.ListBoxModel.Option>, RandomAccess, org.kohsuke.stapler.HttpResponse

public class SSHUserListBoxModel
extends com.cloudbees.plugins.credentials.common.AbstractIdCredentialsListBoxModel<SSHUserListBoxModel,com.cloudbees.plugins.credentials.common.StandardUsernameCredentials>

ListBoxModel with StandardUsernameCredentials support.

This class is convenient for providing the config.groovy/.jelly fragment for a collection of StandardUsernameCredentials objects.

If you want to let the user configure an StandardUsernameCredentials object, do the following:

First, create a field that stores the credential ID and defines a corresponding parameter in the constructor:

 private String credentialId;

 @DataBoundConstructor
 public MyModel( .... , String credentialId) {
     this.credentialId = credentialId;
     ...
 }
 

Your config.groovy should have the following entry to render a drop-down list box:

 f.entry(title:_("Credentials"), field:"credentialId") {
     f.select()
 }
 

Finally, your Descriptor implementation should have the doFillCredentialsIdItems method, which lists up the credentials available in this context:

 public SSHUserListBoxModel doFillCredentialsIdItems() {
     return new SSHUserListBoxModel()
             .addCollection(CredentialsProvider.lookupCredentials(SSHUser.class,...));
 }
 

Exactly which overloaded version of the CredentialsProvider.lookupCredentials(Class) depends on the context in which your model operates. Here are a few common examples:

System-level settings

If your model is a singleton in the whole Jenkins instance, things that belong to the root Jenkins (such as slaves), or do not have any ancestors serving as the context, then use addSystemScopeCredentials().

Job-level settings

If your model is a configuration fragment added to a Item (such as its major subtype Job), then use that Item as the context and call CredentialsProvider.lookupCredentials(Class, Item) See below:

 public SSHUserListBoxModel doFillCredentialsIdItems(@AncestorInPath AbstractProject context) {
     return new SSHUserListBoxModel().addCollection(
         CredentialsProvider.lookupCredentials(StandardUsernameCredentials.class, context, auth, domainRequirements)));
 }
 

Author:

Kohsuke Kawaguchi

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class hudson.util.ListBoxModel

hudson.util.ListBoxModel.Option

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
SSHUserListBoxModel()

Method Summary

Methods

Modifier and Type	Method and Description
SSHUserListBoxModel	add(com.cloudbees.plugins.credentials.common.StandardUsernameCredentials u) Deprecated. use AbstractIdCredentialsListBoxModel.with(com.cloudbees.plugins.credentials.common.IdCredentials)
SSHUserListBoxModel	addCollection(Collection<? extends com.cloudbees.plugins.credentials.common.StandardUsernameCredentials> col) Deprecated. use AbstractIdCredentialsListBoxModel.withMatching(CredentialsMatcher, Iterable) or AbstractIdCredentialsListBoxModel.withAll(Iterable)
SSHUserListBoxModel	addSystemScopeCredentials() Deprecated. use withSystemScopeCredentials()
protected String	describe(com.cloudbees.plugins.credentials.common.StandardUsernameCredentials c)
SSHUserListBoxModel	withSystemScopeCredentials() Adds all the system-scoped credentials (they will be filtered with SSHAuthenticator.matcher() implicitly).
SSHUserListBoxModel	withSystemScopeCredentials(com.cloudbees.plugins.credentials.CredentialsMatcher matcher, com.cloudbees.plugins.credentials.domains.DomainRequirement... domainRequirements) Adds all the system-scoped credentials.
SSHUserListBoxModel	withSystemScopeCredentials(com.cloudbees.plugins.credentials.CredentialsMatcher matcher, List<com.cloudbees.plugins.credentials.domains.DomainRequirement> domainRequirements) Adds all the system-scoped credentials.
SSHUserListBoxModel	withSystemScopeCredentials(com.cloudbees.plugins.credentials.domains.DomainRequirement... domainRequirements) Adds all the system-scoped credentials (they will be filtered with SSHAuthenticator.matcher() implicitly).
SSHUserListBoxModel	withSystemScopeCredentials(List<com.cloudbees.plugins.credentials.domains.DomainRequirement> domainRequirements) Adds all the system-scoped credentials (they will be filtered with SSHAuthenticator.matcher() implicitly).

Methods inherited from class com.cloudbees.plugins.credentials.common.AbstractIdCredentialsListBoxModel

with, withAll, withAll, withAll, withEmptySelection, withMatching, withMatching, withMatching

Methods inherited from class hudson.util.ListBoxModel

add, add, add, generateResponse, values, writeTo

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeRange, retainAll, set, size, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Constructor Detail

SSHUserListBoxModel

public SSHUserListBoxModel()

Method Detail

describe

@NonNull
protected String describe(@NonNull
                      com.cloudbees.plugins.credentials.common.StandardUsernameCredentials c)

Specified by:

describe in class com.cloudbees.plugins.credentials.common.AbstractIdCredentialsListBoxModel<SSHUserListBoxModel,com.cloudbees.plugins.credentials.common.StandardUsernameCredentials>

add

@Deprecated
public SSHUserListBoxModel add(com.cloudbees.plugins.credentials.common.StandardUsernameCredentials u)

Deprecated. use AbstractIdCredentialsListBoxModel.with(com.cloudbees.plugins.credentials.common.IdCredentials)

addCollection

@Deprecated
public SSHUserListBoxModel addCollection(Collection<? extends com.cloudbees.plugins.credentials.common.StandardUsernameCredentials> col)

Deprecated. use AbstractIdCredentialsListBoxModel.withMatching(CredentialsMatcher, Iterable) or AbstractIdCredentialsListBoxModel.withAll(Iterable)

Adds a collection of credentials (they will be filtered with SSHAuthenticator.matcher() implicitly).

Parameters:

col - the collection of credentials.

Returns:

this for method chaining.

addSystemScopeCredentials

@Deprecated
public SSHUserListBoxModel addSystemScopeCredentials()

Deprecated. use withSystemScopeCredentials()

Adds all the system-scoped credentials (they will be filtered with SSHAuthenticator.matcher() implicitly).

These credentials are meant to be used for system configuration and other things scoped to the Jenkins object, such as slaves.

Returns:

this for method chaining.

withSystemScopeCredentials

public SSHUserListBoxModel withSystemScopeCredentials()

Adds all the system-scoped credentials (they will be filtered with SSHAuthenticator.matcher() implicitly).

These credentials are meant to be used for system configuration and other things scoped to the Jenkins object, such as slaves.

Returns:

this for method chaining.

withSystemScopeCredentials

public SSHUserListBoxModel withSystemScopeCredentials(com.cloudbees.plugins.credentials.domains.DomainRequirement... domainRequirements)

Adds all the system-scoped credentials (they will be filtered with SSHAuthenticator.matcher() implicitly).

These credentials are meant to be used for system configuration and other things scoped to the Jenkins object, such as slaves.

Parameters:

domainRequirements - the domain requirements

Returns:

this for method chaining.

withSystemScopeCredentials

public SSHUserListBoxModel withSystemScopeCredentials(com.cloudbees.plugins.credentials.CredentialsMatcher matcher,
                                             com.cloudbees.plugins.credentials.domains.DomainRequirement... domainRequirements)

Adds all the system-scoped credentials.

These credentials are meant to be used for system configuration and other things scoped to the Jenkins object, such as slaves.

Parameters:

matcher - a matcher to filter the credentials

domainRequirements - the domain requirements

Returns:

this for method chaining.

withSystemScopeCredentials

public SSHUserListBoxModel withSystemScopeCredentials(List<com.cloudbees.plugins.credentials.domains.DomainRequirement> domainRequirements)

Adds all the system-scoped credentials (they will be filtered with SSHAuthenticator.matcher() implicitly).

These credentials are meant to be used for system configuration and other things scoped to the Jenkins object, such as slaves.

Parameters:

domainRequirements - the domain requirements

Returns:

this for method chaining.

withSystemScopeCredentials

public SSHUserListBoxModel withSystemScopeCredentials(com.cloudbees.plugins.credentials.CredentialsMatcher matcher,
                                             List<com.cloudbees.plugins.credentials.domains.DomainRequirement> domainRequirements)

Adds all the system-scoped credentials.

These credentials are meant to be used for system configuration and other things scoped to the Jenkins object, such as slaves.

Parameters:

matcher - a matcher to filter the credentials

domainRequirements - the domain requirements

Returns:

this for method chaining.