Package com.cloudbees.plugins.credentials

Class ViewCredentialsAction

java.lang.Object

com.cloudbees.plugins.credentials.ViewCredentialsAction

All Implemented Interfaces:

Action, ModelObject, AccessControlled, ModelObjectWithContextMenu, IconSpec

Direct Known Subclasses:

ViewCredentialsAction.RootActionImpl

@ExportedBean
public class ViewCredentialsAction
extends Object
implements Action, IconSpec, AccessControlled, ModelObjectWithContextMenu

An Action that lets you view the available credentials for any ModelObject.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ViewCredentialsAction.RootActionImpl	Add the ViewCredentialsAction to the Jenkins root.
static class	ViewCredentialsAction.TableEntry	Value class to simplify creating the table.
static class	ViewCredentialsAction.TransientTopLevelItemActionFactoryImpl	Add the ViewCredentialsAction to all TopLevelItem instances.
static class	ViewCredentialsAction.TransientUserActionFactoryImpl	Add the ViewCredentialsAction to all User instances.

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 Permission	MANAGE_DOMAINS	Expose CredentialsProvider.MANAGE_DOMAINS for Jelly.
static Permission	VIEW	Expose CredentialsProvider.VIEW for Jelly.

Constructor Summary

Constructors

Constructor	Description
ViewCredentialsAction(ModelObject context)	Constructor.

Method Summary

Modifier and Type	Method	Description
ModelObjectWithContextMenu.ContextMenu	doContextMenu(org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response)
ACL	getACL()
Api	getApi()	Expose a Jenkins Api.
ModelObject	getContext()	Gets the context.
String	getContextFullDisplayName()	Returns the full display name of the getContext().
String	getContextFullName()	Returns the full name of the getContext().
String	getDisplayName()
String	getFullDisplayName()	Returns the full display name of this action.
String	getFullName()	Returns the full name of this action.
String	getIconClassName()
String	getIconFileName()
List<CredentialsStore>	getLocalStores()	Exposes the CredentialsStore instances available to the getContext().
List<CredentialsStore>	getParentStores()	Exposes the CredentialsStore instances available to the getContext().
CredentialsStoreAction	getStore(String name)	Exposes the getStoreActions() by CredentialsStoreAction.getUrlName() for Stapler.
List<CredentialsStoreAction>	getStoreActions()	Exposes the getLocalStores() CredentialsStore.getStoreAction().
Map<String,CredentialsStoreAction>	getStoreActionsMap()	Exposes the getLocalStores() for the XML API.
String	getStoreBaseUrl(String itUrl)
List<ViewCredentialsAction.TableEntry>	getTableEntries()	Returns the credential entries.
String	getUrlName()
boolean	isVisible()	Tests if the ViewCredentialsAction 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, checkPermission, hasAnyPermission, hasPermission, hasPermission, hasPermission2

Field Detail

VIEW

public static final Permission VIEW

Expose CredentialsProvider.VIEW for Jelly.

MANAGE_DOMAINS

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static final Permission MANAGE_DOMAINS

Expose CredentialsProvider.MANAGE_DOMAINS for Jelly.

Constructor Detail

ViewCredentialsAction

public ViewCredentialsAction(ModelObject context)

Constructor.

Parameters:

context - the context.

Method Detail

getContext

public ModelObject getContext()

Gets the context.

Returns:

the context.

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface Action

getParentStores

@NonNull
public List<CredentialsStore> getParentStores()

Exposes the CredentialsStore instances available to the getContext().

Returns:

the CredentialsStore instances available to the getContext().

getLocalStores

@NonNull
public List<CredentialsStore> getLocalStores()

Exposes the CredentialsStore instances available to the getContext().

Returns:

the CredentialsStore instances available to the getContext().

getStoreActions

@NonNull
public List<CredentialsStoreAction> getStoreActions()

Exposes the getLocalStores() CredentialsStore.getStoreAction().

Returns:

the getLocalStores() CredentialsStore.getStoreAction().

getStoreActionsMap

@NonNull
@Exported(name="stores")
public Map<String,CredentialsStoreAction> getStoreActionsMap()

Exposes the getLocalStores() for the XML API.

Returns:

the getLocalStores() for the XML API.

Since:

2.1.0

getStore

@CheckForNull
public CredentialsStoreAction getStore(String name)

Exposes the getStoreActions() by CredentialsStoreAction.getUrlName() for Stapler.

Parameters:

name - the CredentialsStoreAction.getUrlName() to match.

Returns:

the CredentialsStoreAction or null

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface Action

getStoreBaseUrl

public String getStoreBaseUrl(String itUrl)

isVisible

public boolean isVisible()

Tests if the ViewCredentialsAction should be visible.

Returns:

true if the action should be visible.

getApi

public Api getApi()

Expose a Jenkins Api.

Returns:

the Api.

getTableEntries

public List<ViewCredentialsAction.TableEntry> getTableEntries()

Returns the credential entries.

Returns:

the credential entries.

getIconClassName

public String getIconClassName()

Specified by:

getIconClassName in interface IconSpec

getFullName

public final String getFullName()

Returns the full name of this action.

Returns:

the full name of this action.

getContextFullName

public String getContextFullName()

Returns the full name of the getContext().

Returns:

the full name of the getContext().

getFullDisplayName

public final String getFullDisplayName()

Returns the full display name of this action.

Returns:

the full display name of this action.

getContextFullDisplayName

public String getContextFullDisplayName()

Returns the full display name of the getContext().

Returns:

the full display name of the getContext().

getACL

@NonNull
public ACL getACL()

Specified by:

getACL in interface AccessControlled

doContextMenu

public ModelObjectWithContextMenu.ContextMenu doContextMenu(org.kohsuke.stapler.StaplerRequest request,
                                                            org.kohsuke.stapler.StaplerResponse response)

Specified by:

doContextMenu in interface ModelObjectWithContextMenu