Package com.cloudbees.plugins.credentials

Class CredentialsStoreAction

java.lang.Object

com.cloudbees.plugins.credentials.CredentialsStoreAction

All Implemented Interfaces:

Action, ModelObject, AccessControlled, ModelObjectWithChildren, ModelObjectWithContextMenu, IconSpec

Direct Known Subclasses:

SystemCredentialsProvider.UserFacingAction, UserCredentialsProvider.UserFacingAction

@ExportedBean
public abstract class CredentialsStoreAction
extends Object
implements Action, IconSpec, AccessControlled, ModelObjectWithContextMenu, ModelObjectWithChildren

An action for a CredentialsStore

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CredentialsStoreAction.CredentialsWrapper	A wrapper object to bind and expose Credentials instances into the web UI.
static class	CredentialsStoreAction.DomainWrapper	A wrapper object to bind and expose Domain instances into the web UI.

Nested classes/interfaces inherited from interface jenkins.model.ModelObjectWithContextMenu

ModelObjectWithContextMenu.ContextMenu, ModelObjectWithContextMenu.ContextMenuVisibility, ModelObjectWithContextMenu.MenuItem, ModelObjectWithContextMenu.MenuItemType

Field Summary

Fields

Modifier and Type	Field	Description
static final Permission	CREATE	Expose CredentialsProvider.CREATE for Jelly.
static final Permission	DELETE	Expose CredentialsProvider.DELETE for Jelly.
static final XStream2	FINGERPRINT_XML	An XStream2 that replaces Secret and SecretBytes instances with a hash of the secret and omits fields that should be excluded from credentials fingerprinting.
static final Permission	MANAGE_DOMAINS	Expose CredentialsProvider.MANAGE_DOMAINS for Jelly.
static final XStream2	SECRETS_REDACTED	An XStream2 that replaces Secret and SecretBytes instances with <secret-redacted/>
static final Permission	UPDATE	Expose CredentialsProvider.UPDATE for Jelly.
static final Permission	VIEW	Expose CredentialsProvider.VIEW for Jelly.

Constructor Summary

Constructors

Constructor	Description
CredentialsStoreAction()

Method Summary

Modifier and Type	Method	Description
void	checkPermission(Permission permission)
ModelObjectWithContextMenu.ContextMenu	doChildrenContextMenu(org.kohsuke.stapler.StaplerRequest2 request, org.kohsuke.stapler.StaplerResponse2 response)
ModelObjectWithContextMenu.ContextMenu	doContextMenu(org.kohsuke.stapler.StaplerRequest2 request, org.kohsuke.stapler.StaplerResponse2 response)
org.kohsuke.stapler.HttpResponse	doCreateDomain(org.kohsuke.stapler.StaplerRequest2 req)	Creates a domain.
ACL	getACL()
List<Action>	getActions()	Any additional actions to display for this CredentialsStore.
Api	getApi()	Expose the action's Api.
ModelObjectWithContextMenu.ContextMenu	getChildrenContextMenu(String prefix)	Creates the children context menu with the supplied prefix to all URLs.
ModelObjectWithContextMenu.ContextMenu	getContextMenu(String prefix)	Creates the context menu with the supplied prefix to all URLs.
String	getDisplayName()
CredentialsStoreAction.DomainWrapper	getDomain(String name)	Gets the named CredentialsStoreAction.DomainWrapper.
CredentialsStoreAction.DomainWrapper.DescriptorImpl	getDomainDescriptor()	Exposes CredentialsStoreAction.DomainWrapper.DescriptorImpl for Jelly.
Map<String,CredentialsStoreAction.DomainWrapper>	getDomains()	Returns the map of CredentialsStoreAction.DomainWrapper instances.
Object	getDynamic(String token)	Exposes the getActions() for Stapler.
final String	getFullDisplayName()	Returns the Item.getFullDisplayName() or nearest approximation.
final String	getFullName()	Returns the Item.getFullName() or nearest approximation.
String	getIconClassName()
String	getIconFileName()
DescriptorExtensionList<DomainSpecification,Descriptor<DomainSpecification>>	getSpecificationDescriptors()	Gets all the DomainSpecification descriptors.
abstract CredentialsStore	getStore()	Returns the CredentialsStore backing this action.
String	getUrlName()
boolean	hasPermission(Permission permission)
boolean	isDomainsModifiable()	Exposes CredentialsStore.isDomainsModifiable() for Jelly.
boolean	isVisible()	Checks if this action should be visible.

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.security.AccessControlled

checkAnyPermission, hasAnyPermission, hasPermission, hasPermission2

Methods inherited from interface jenkins.model.ModelObjectWithChildren

doChildrenContextMenu

Methods inherited from interface jenkins.model.ModelObjectWithContextMenu

doContextMenu

Field Details

VIEW

public static final Permission VIEW

Expose CredentialsProvider.VIEW for Jelly.

CREATE

public static final Permission CREATE

Expose CredentialsProvider.CREATE for Jelly.

UPDATE

public static final Permission UPDATE

Expose CredentialsProvider.UPDATE for Jelly.

DELETE

public static final Permission DELETE

Expose CredentialsProvider.DELETE for Jelly.

MANAGE_DOMAINS

public static final Permission MANAGE_DOMAINS

Expose CredentialsProvider.MANAGE_DOMAINS for Jelly.

SECRETS_REDACTED

public static final XStream2 SECRETS_REDACTED

An XStream2 that replaces Secret and SecretBytes instances with <secret-redacted/>

Since:

2.1.1

FINGERPRINT_XML

public static final XStream2 FINGERPRINT_XML

An XStream2 that replaces Secret and SecretBytes instances with a hash of the secret and omits fields that should be excluded from credentials fingerprinting.

Since:

2.1.15

Constructor Details

CredentialsStoreAction

public CredentialsStoreAction()

Method Details

getStore

@NonNull
public abstract CredentialsStore getStore()

Returns the CredentialsStore backing this action.

Returns:

the CredentialsStore.

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface Action

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

getActions

@NonNull
public List<Action> getActions()

Any additional actions to display for this CredentialsStore.

Returns:

Any additional actions to display for this CredentialsStore.

Since:

2.0

getDynamic

@CheckForNull
public Object getDynamic(String token)

Exposes the getActions() for Stapler.

Parameters:

token - the name of the action.

Returns:

the Action or null

Since:

2.0

getContextMenu

@CheckForNull
public ModelObjectWithContextMenu.ContextMenu getContextMenu(String prefix)

Creates the context menu with the supplied prefix to all URLs.

Parameters:

prefix - the prefix to prepend to relative urls.

Returns:

the ModelObjectWithContextMenu.ContextMenu or null

Since:

2.0

getChildrenContextMenu

@CheckForNull
public ModelObjectWithContextMenu.ContextMenu getChildrenContextMenu(String prefix)

Creates the children context menu with the supplied prefix to all URLs.

Parameters:

prefix - the prefix to prepend to relative urls.

Returns:

the ModelObjectWithContextMenu.ContextMenu or null

Since:

2.0

doContextMenu

public ModelObjectWithContextMenu.ContextMenu doContextMenu(org.kohsuke.stapler.StaplerRequest2 request,
 org.kohsuke.stapler.StaplerResponse2 response)

Specified by:

doContextMenu in interface ModelObjectWithContextMenu

doChildrenContextMenu

public ModelObjectWithContextMenu.ContextMenu doChildrenContextMenu(org.kohsuke.stapler.StaplerRequest2 request,
 org.kohsuke.stapler.StaplerResponse2 response)

Specified by:

doChildrenContextMenu in interface ModelObjectWithChildren

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface Action

getApi

public Api getApi()

Expose the action's Api.

Returns:

the action's Api.

isVisible

public boolean isVisible()

Checks if this action should be visible.

Returns:

true if the action should be visible.

getIconClassName

public String getIconClassName()

Specified by:

getIconClassName in interface IconSpec

getFullName

public final String getFullName()

Returns the Item.getFullName() or nearest approximation.

Returns:

the Item.getFullName() or nearest approximation.

getFullDisplayName

public final String getFullDisplayName()

Returns the Item.getFullDisplayName() or nearest approximation.

Returns:

the Item.getFullDisplayName() or nearest approximation.

getDomains

@Exported
@NonNull
public Map<String,CredentialsStoreAction.DomainWrapper> getDomains()

Returns the map of CredentialsStoreAction.DomainWrapper instances.

Returns:

the map of CredentialsStoreAction.DomainWrapper instances.

getDomain

@CheckForNull
public CredentialsStoreAction.DomainWrapper getDomain(String name)

Gets the named CredentialsStoreAction.DomainWrapper.

Parameters:

name - the name.

Returns:

the named CredentialsStoreAction.DomainWrapper.

isDomainsModifiable

public boolean isDomainsModifiable()

Exposes CredentialsStore.isDomainsModifiable() for Jelly.

Returns:

CredentialsStore.isDomainsModifiable().

getDomainDescriptor

public CredentialsStoreAction.DomainWrapper.DescriptorImpl getDomainDescriptor()

Exposes CredentialsStoreAction.DomainWrapper.DescriptorImpl for Jelly.

Returns:

CredentialsStoreAction.DomainWrapper.DescriptorImpl.

getSpecificationDescriptors

public DescriptorExtensionList<DomainSpecification,Descriptor<DomainSpecification>> getSpecificationDescriptors()

Gets all the DomainSpecification descriptors.

Returns:

all the DomainSpecification descriptors.

doCreateDomain

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public org.kohsuke.stapler.HttpResponse doCreateDomain(org.kohsuke.stapler.StaplerRequest2 req)
                                                throws jakarta.servlet.ServletException,
IOException

Creates a domain.

Parameters:

req - the request.

Returns:

the response.

Throws:

jakarta.servlet.ServletException - if something goes wrong.

IOException - if something goes wrong.

getACL

@NonNull
public ACL getACL()

Specified by:

getACL in interface AccessControlled

checkPermission

public void checkPermission(@NonNull
 Permission permission)
                     throws org.springframework.security.access.AccessDeniedException

Specified by:

checkPermission in interface AccessControlled

Throws:

org.springframework.security.access.AccessDeniedException

hasPermission

public boolean hasPermission(@NonNull
 Permission permission)

Specified by:

hasPermission in interface AccessControlled