Package com.cloudbees.plugins.credentials

Class CredentialsSelectHelper

java.lang.Object

hudson.model.Descriptor<CredentialsSelectHelper>

com.cloudbees.plugins.credentials.CredentialsSelectHelper

All Implemented Interfaces:

Describable<CredentialsSelectHelper>, Saveable, OnMaster

@Extension
public class CredentialsSelectHelper
extends Descriptor<CredentialsSelectHelper>
implements Describable<CredentialsSelectHelper>

A descriptor used to assist the c:select tag with allowing in-place addition of credentials.

Author:

Stephen Connolly

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CredentialsSelectHelper.ContextResolver	An extension point to allow plugging in additional resolution of ModelObject instances.
static class	CredentialsSelectHelper.ItemContextResolver	A CredentialsSelectHelper.ContextResolver for Item instances resolvable by Jenkins.getItemByFullName(String).
static class	CredentialsSelectHelper.StoreItem	Value class to hold the details of a CredentialsStore.
static class	CredentialsSelectHelper.SystemContextResolver	A CredentialsSelectHelper.ContextResolver for Jenkins.
static class	CredentialsSelectHelper.UserContextResolver	A CredentialsSelectHelper.ContextResolver for User instances.
static class	CredentialsSelectHelper.WrappedContextResolver	Stapler binding for CredentialsSelectHelper.ContextResolver.
static class	CredentialsSelectHelper.WrappedContextResolverCredentialsProvider	Stapler binding for a CredentialsSelectHelper.ContextResolver and CredentialsProvider.
static class	CredentialsSelectHelper.WrappedCredentialsStore	Stapler binding for a CredentialsStore.

Nested classes/interfaces inherited from class hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Field Summary

Fields

Modifier and Type	Field	Description
static Permission	CREATE	Expose the CredentialsProvider.CREATE permission for Jelly.

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
CredentialsSelectHelper()

Method Summary

Modifier and Type	Method	Description
CredentialsSelectHelper	getDescriptor()
String	getDisplayName()
static Map<String,CredentialsProvider>	getProvidersByName()	Returns a map of the CredentialsProvider instances keyed by their name.
CredentialsSelectHelper.WrappedContextResolver	getResolver(String className)	Stapler binding for the resolver URL segment.
static Map<String,CredentialsSelectHelper.ContextResolver>	getResolversByName()	Returns a map of the CredentialsSelectHelper.ContextResolver instances keyed by their name.
List<CredentialsSelectHelper.StoreItem>	getStoreItems(ModelObject context, boolean includeUser)	Returns the CredentialsSelectHelper.StoreItem instances for the current Stapler request.
boolean	hasCreatePermission(ModelObject context, boolean includeUser)	Checks if the current user has permission to create a credential.
ModelObject	resolveContext(Object context)	Fixes up the context in case we are called from a page where the context is not a ModelObject.
static CredentialsStore	resolveForCLI(String storeId)	Resolves a CredentialsStore instance for CLI commands.

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Field Detail

CREATE

public static final Permission CREATE

Expose the CredentialsProvider.CREATE permission for Jelly.

Constructor Detail

CredentialsSelectHelper

public CredentialsSelectHelper()

Method Detail

getDescriptor

public CredentialsSelectHelper getDescriptor()

Specified by:

getDescriptor in interface Describable<CredentialsSelectHelper>

getDisplayName

@NonNull
public String getDisplayName()

Overrides:

getDisplayName in class Descriptor<CredentialsSelectHelper>

resolveContext

@CheckForNull
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public ModelObject resolveContext(Object context)

Fixes up the context in case we are called from a page where the context is not a ModelObject.

Parameters:

context - the initial guess of the context.

Returns:

the resolved context.

Since:

2.0.7

getStoreItems

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public List<CredentialsSelectHelper.StoreItem> getStoreItems(ModelObject context,
                                                             boolean includeUser)

Returns the CredentialsSelectHelper.StoreItem instances for the current Stapler request.

Parameters:

context - the context in which to retrieve the store items.

includeUser - true to also include any User scoped stores.

Returns:

the CredentialsSelectHelper.StoreItem instances for the current Stapler request.

Since:

2.0.5

hasCreatePermission

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public boolean hasCreatePermission(ModelObject context,
                                   boolean includeUser)

Checks if the current user has permission to create a credential.

Parameters:

context - the context.

includeUser - whether they can use their own credentials store.

Returns:

true if they can create a permission.

Since:

FIXME

getResolver

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public CredentialsSelectHelper.WrappedContextResolver getResolver(String className)

Stapler binding for the resolver URL segment.

Parameters:

className - the class name of the resolver.

Returns:

the wrapped resolver.

Since:

2.0

resolveForCLI

@CLIResolver
public static CredentialsStore resolveForCLI(String storeId)
                                      throws org.kohsuke.args4j.CmdLineException

Resolves a CredentialsStore instance for CLI commands.

Parameters:

storeId - the store identifier.

Returns:

the CredentialsStore instance.

Throws:

org.kohsuke.args4j.CmdLineException - if the store cannot be resolved.

Since:

2.1.1

getResolversByName

public static Map<String,CredentialsSelectHelper.ContextResolver> getResolversByName()

Returns a map of the CredentialsSelectHelper.ContextResolver instances keyed by their name. A resolver may have more than one entry if there are inferred unique short nicknames.

Returns:

a map of the CredentialsSelectHelper.ContextResolver instances keyed by their name

Since:

2.1.1

getProvidersByName

public static Map<String,CredentialsProvider> getProvidersByName()

Returns a map of the CredentialsProvider instances keyed by their name. A provider may have more than one entry if there are inferred unique short nicknames.

Returns:

a map of the CredentialsProvider instances keyed by their name

Since:

2.1.1