Package com.cloudbees.plugins.credentials

Class CredentialsSelectHelper.WrappedCredentialsStore

java.lang.Object

com.cloudbees.plugins.credentials.CredentialsSelectHelper.WrappedCredentialsStore

All Implemented Interfaces:

ModelObject, IconSpec

Enclosing class:

CredentialsSelectHelper

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static final class CredentialsSelectHelper.WrappedCredentialsStore
extends Object
implements IconSpec, ModelObject

Stapler binding for a CredentialsStore.

Since:

2.0

Constructor Summary

Constructors

Constructor	Description
WrappedCredentialsStore(CredentialsSelectHelper.ContextResolver resolver, CredentialsProvider provider, String token, CredentialsStore store)	Our constructor.

Method Summary

Modifier and Type	Method	Description
net.sf.json.JSONObject	doAddCredentials(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)	Stapler web binding for adding credentials to the domain.
List<CredentialsDescriptor>	getCredentialsDescriptors()	Exposes the CredentialsDescriptor instances appropriate for this CredentialsStore.
String	getDescription()	Exposes the description of this store (i.e.
String	getDisplayName()
String	getIconClassName()
CredentialsStore	getStore()	The backing CredentialsStore.
String	getUrl()	Exposes our URL (as we will be invoked from an unknown page so we need an absolute URL).
CredentialsStoreAction.DomainWrapper	getWrapper()	Returns a CredentialsStoreAction.DomainWrapper to use for contextualizing the credentials form.
Map<String,CredentialsStoreAction.DomainWrapper>	getWrappers()	The CredentialsStoreAction.DomainWrapper instances.

Methods inherited from class java.lang.Object

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

Constructor Details

WrappedCredentialsStore

public WrappedCredentialsStore(@NonNull
 CredentialsSelectHelper.ContextResolver resolver,
 @NonNull
 CredentialsProvider provider,
 @NonNull
 String token,
 @NonNull
 CredentialsStore store)

Our constructor.

Parameters:

resolver - the CredentialsSelectHelper.ContextResolver

provider - the CredentialsProvider

token - the context's CredentialsSelectHelper.ContextResolver.getToken(ModelObject).

store - the CredentialsStore

Method Details

doAddCredentials

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public net.sf.json.JSONObject doAddCredentials(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                                        throws IOException,
jakarta.servlet.ServletException

Stapler web binding for adding credentials to the domain.

Parameters:

req - the request.

rsp - the response.

Throws:

IOException - if something goes wrong.

jakarta.servlet.ServletException - if something goes wrong.

getWrapper

public CredentialsStoreAction.DomainWrapper getWrapper()

Returns a CredentialsStoreAction.DomainWrapper to use for contextualizing the credentials form.

Returns:

a CredentialsStoreAction.DomainWrapper to use for contextualizing the credentials form.

getIconClassName

public String getIconClassName()

Specified by:

getIconClassName in interface IconSpec

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface ModelObject

getDescription

public String getDescription()

Exposes the description of this store (i.e. the CredentialsProvider.getDisplayName().

Returns:

the description of this store (i.e. the CredentialsProvider.getDisplayName().

getUrl

public String getUrl()

Exposes our URL (as we will be invoked from an unknown page so we need an absolute URL).

Returns:

our URL.

getCredentialsDescriptors

public List<CredentialsDescriptor> getCredentialsDescriptors()

Exposes the CredentialsDescriptor instances appropriate for this CredentialsStore.

Returns:

the CredentialsDescriptor instances appropriate for this CredentialsStore.

getWrappers

public Map<String,CredentialsStoreAction.DomainWrapper> getWrappers()

The CredentialsStoreAction.DomainWrapper instances.

Returns:

the CredentialsStoreAction.DomainWrapper instances.

getStore

public CredentialsStore getStore()

The backing CredentialsStore.

Returns:

backing CredentialsStore.

Since:

2.1.5