com.cloudbees.plugins.credentials.common

Class AbstractIdCredentialsListBoxModel<T extends AbstractIdCredentialsListBoxModel<T,C>,C extends IdCredentials>

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<T,C>

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

Direct Known Subclasses:

StandardListBoxModel, StandardUsernameListBoxModel

public abstract class AbstractIdCredentialsListBoxModel<T extends AbstractIdCredentialsListBoxModel<T,C>,C extends IdCredentials>
extends hudson.util.ListBoxModel

ListBoxModel with support for credentials.

This class is convenient for providing the config.groovy or config.jelly fragment for a collection of objects of some IdCredentials subtype.

If you want to let the user configure a credentials object, do the following:

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

 private String credentialsId;

 @DataBoundConstructor
 public MyModel( .... , String credentialsId) {
     this.credentialsId = credentialsId;
     ...
 }
 public String getCredentialsId() {return credentialsId;}
 

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

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

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

 public ListBoxModel doFillCredentialsIdItems() {
     if (!Jenkins.getInstance().hasPermission(Jenkins.ADMINISTER)) { // or whatever permission is appropriate for this page
         // Important! Otherwise you expose credentials metadata to random web requests.
         return new ListBoxModel();
     }
     return new StandardUsernameListBoxModel().withEmptySelection().withAll(
         CredentialsProvider.lookupCredentials(StandardUsernameCredentials.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 Jenkins.getInstance() as the context.

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. For example:

 public ListBoxModel doFillCredentialsIdItems(@AncestorInPath Item context, @QueryParameter String source) {
     if (context == null || !context.hasPermission(Item.CONFIGURE)) {
         return new ListBoxModel();
     }
     return new StandardUsernameListBoxModel().withEmptySelection().withAll(
         CredentialsProvider.lookupCredentials(StandardUsernameCredentials.class, context, ACL.SYSTEM, URIRequirementBuilder.fromUri(source).build()));
 }
 

Since:

1.6

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
AbstractIdCredentialsListBoxModel()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract String	describe(C c) Generate a description of the supplied credential.
AbstractIdCredentialsListBoxModel<T,C>	with(C u) Adds a single credential.
AbstractIdCredentialsListBoxModel<T,C>	withAll(C... credentials) Adds supplied credentials to the model.
AbstractIdCredentialsListBoxModel<T,C>	withAll(Iterable<? extends C> credentials) Adds supplied credentials to the model.
AbstractIdCredentialsListBoxModel<T,C>	withAll(Iterator<? extends C> credentials) Adds supplied credentials to the model.
AbstractIdCredentialsListBoxModel<T,C>	withEmptySelection() Adds an "empty" credential to signify selection of no credential.
AbstractIdCredentialsListBoxModel<T,C>	withMatching(CredentialsMatcher matcher, C... credentials) Adds the matching subset of suppled credentials to the model.
AbstractIdCredentialsListBoxModel<T,C>	withMatching(CredentialsMatcher matcher, Iterable<? extends C> credentials) Adds the matching subset of suppled credentials to the model.
AbstractIdCredentialsListBoxModel<T,C>	withMatching(CredentialsMatcher matcher, Iterator<? extends C> credentials) Adds the matching subset of suppled credentials to the model.

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

AbstractIdCredentialsListBoxModel

public AbstractIdCredentialsListBoxModel()

Method Detail

describe

@NonNull
protected abstract String describe(@NonNull
                      C c)

Generate a description of the supplied credential.

Parameters:

c - the credential.

Returns:

the description.

with

@NonNull
public AbstractIdCredentialsListBoxModel<T,C> with(@CheckForNull
                                                  C u)

Adds a single credential.

Parameters:

u - the credential to add.

Returns:

this for method chaining.

withEmptySelection

@NonNull
public AbstractIdCredentialsListBoxModel<T,C> withEmptySelection()

Adds an "empty" credential to signify selection of no credential.

Returns:

this for method chaining.

withAll

@NonNull
public AbstractIdCredentialsListBoxModel<T,C> withAll(@NonNull
                                                     C... credentials)

Adds supplied credentials to the model.

Parameters:

credentials - the credentials.

Returns:

this for method chaining.

withAll

@NonNull
public AbstractIdCredentialsListBoxModel<T,C> withAll(@NonNull
                                                     Iterable<? extends C> credentials)

Adds supplied credentials to the model.

Parameters:

credentials - the credentials.

Returns:

this for method chaining.

withAll

@NonNull
public AbstractIdCredentialsListBoxModel<T,C> withAll(@NonNull
                                                     Iterator<? extends C> credentials)

Adds supplied credentials to the model.

Parameters:

credentials - the credentials.

Returns:

this for method chaining.

withMatching

@NonNull
public AbstractIdCredentialsListBoxModel<T,C> withMatching(@NonNull
                                                          CredentialsMatcher matcher,
                                                          @NonNull
                                                          C... credentials)

Adds the matching subset of suppled credentials to the model.

Parameters:

matcher - the matcher.

credentials - the superset of credentials.

Returns:

this for method chaining.

withMatching

@NonNull
public AbstractIdCredentialsListBoxModel<T,C> withMatching(@NonNull
                                                          CredentialsMatcher matcher,
                                                          @NonNull
                                                          Iterable<? extends C> credentials)

Adds the matching subset of suppled credentials to the model.

Parameters:

matcher - the matcher.

credentials - the superset of credentials.

Returns:

this for method chaining.

withMatching

@NonNull
public AbstractIdCredentialsListBoxModel<T,C> withMatching(@NonNull
                                                          CredentialsMatcher matcher,
                                                          @NonNull
                                                          Iterator<? extends C> credentials)

Adds the matching subset of suppled credentials to the model.

Parameters:

matcher - the matcher.

credentials - the superset of credentials.

Returns:

this for method chaining.