Package com.cloudbees.plugins.credentials

Class UserCredentialsProvider.StoreImpl

java.lang.Object

com.cloudbees.plugins.credentials.CredentialsStore

com.cloudbees.plugins.credentials.UserCredentialsProvider.StoreImpl

All Implemented Interfaces:

Saveable, AccessControlled

Enclosing class:

UserCredentialsProvider

public static class UserCredentialsProvider.StoreImpl
extends CredentialsStore

Our implementation

Field Summary

Fields inherited from interface hudson.model.Saveable

NOOP

Method Summary

Modifier and Type	Method	Description
boolean	addCredentials(Domain domain, Credentials credentials)	Adds the specified Credentials within the specified Domain for this CredentialsStore.
boolean	addDomain(Domain domain, List<Credentials> credentials)	Adds a new Domain with seed credentials.
ACL	getACL()
ModelObject	getContext()	Returns the context within which this store operates.
List<Credentials>	getCredentials(Domain domain)	Returns an unmodifiable list of credentials for the specified domain.
List<Domain>	getDomains()	Returns all the Domains that this credential provider has.
String	getRelativeLinkToContext()	Computes the relative path from the current page to this store.
CredentialsStoreAction	getStoreAction()	Return the CredentialsStoreAction for this store.
boolean	hasPermission(Authentication a, Permission permission)	Checks if the given principle has the given permission.
boolean	removeCredentials(Domain domain, Credentials credentials)	Removes the specified Credentials from the specified Domain for this CredentialsStore.
boolean	removeDomain(Domain domain)	Removes an existing Domain and all associated Credentials.
void	save()	Persists the state of this object into XML.
boolean	updateCredentials(Domain domain, Credentials current, Credentials replacement)	Updates the specified Credentials from the specified Domain for this CredentialsStore with the supplied replacement.
boolean	updateDomain(Domain current, Domain replacement)	Updates an existing Domain keeping the existing associated Credentials.

Methods inherited from class com.cloudbees.plugins.credentials.CredentialsStore

_isApplicable, addDomain, checkPermission, getContextDisplayName, getCredentialsDescriptors, getDisplayName, getDomainByName, getProvider, getProviderOrDie, getRelativeLinkTo, getRelativeLinkToAction, getScopes, hasPermission, isApplicable, isDomainsModifiable

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, hasPermission2

Method Detail

getStoreAction

@Nullable
public CredentialsStoreAction getStoreAction()

Return the CredentialsStoreAction for this store. The action will be displayed as a sub-item of the ViewCredentialsAction. Return null if this store will take control of displaying its action (which will be the case for legacy implementations)

Overrides:

getStoreAction in class CredentialsStore

Returns:

the CredentialsStoreAction for this store to be rendered in ViewCredentialsAction or null for old implementations compiled against pre 2.0 versions of credentials plugin.

getContext

@NonNull
public ModelObject getContext()

Returns the context within which this store operates. Credentials in this store will be available to child contexts (unless CredentialsScope.SYSTEM is valid for the store) but will not be available to parent contexts.

Specified by:

getContext in class CredentialsStore

Returns:

the context within which this store operates.

hasPermission

public boolean hasPermission(@NonNull
                             Authentication a,
                             @NonNull
                             Permission permission)

Checks if the given principle has the given permission.

Specified by:

hasPermission in interface AccessControlled

Specified by:

hasPermission in class CredentialsStore

Parameters:

a - the principle.

permission - the permission.

Returns:

false if the user doesn't have the permission.

getACL

@NonNull
public ACL getACL()

Specified by:

getACL in interface AccessControlled

Overrides:

getACL in class CredentialsStore

getDomains

@NonNull
@Exported
public List<Domain> getDomains()

Returns all the Domains that this credential provider has. Most implementers of CredentialsStore will probably want to override this method.

Overrides:

getDomains in class CredentialsStore

Returns:

the list of domains.

getCredentials

@NonNull
@Exported
public List<Credentials> getCredentials(@NonNull
                                        Domain domain)

Returns an unmodifiable list of credentials for the specified domain.

Specified by:

getCredentials in class CredentialsStore

Parameters:

domain - the domain.

Returns:

the possibly empty (e.g. for an unknown Domain) unmodifiable list of credentials for the specified domain.

addDomain

public boolean addDomain(@NonNull
                         Domain domain,
                         List<Credentials> credentials)
                  throws IOException

Adds a new Domain with seed credentials.

Overrides:

addDomain in class CredentialsStore

Parameters:

domain - the domain.

credentials - the initial credentials with which to populate the domain.

Returns:

true if the CredentialsStore was modified.

Throws:

IOException - if the change could not be persisted.

removeDomain

public boolean removeDomain(@NonNull
                            Domain domain)
                     throws IOException

Removes an existing Domain and all associated Credentials.

Overrides:

removeDomain in class CredentialsStore

Parameters:

domain - the domain.

Returns:

true if the CredentialsStore was modified.

Throws:

IOException - if the change could not be persisted.

updateDomain

public boolean updateDomain(@NonNull
                            Domain current,
                            @NonNull
                            Domain replacement)
                     throws IOException

Updates an existing Domain keeping the existing associated Credentials.

Overrides:

updateDomain in class CredentialsStore

Parameters:

current - the domain to update.

replacement - the new replacement domain.

Returns:

true if the CredentialsStore was modified.

Throws:

IOException - if the change could not be persisted.

addCredentials

public boolean addCredentials(@NonNull
                              Domain domain,
                              @NonNull
                              Credentials credentials)
                       throws IOException

Adds the specified Credentials within the specified Domain for this CredentialsStore.

Specified by:

addCredentials in class CredentialsStore

Parameters:

domain - the domain.

credentials - the credentials

Returns:

true if the CredentialsStore was modified.

Throws:

IOException - if the change could not be persisted.

removeCredentials

public boolean removeCredentials(@NonNull
                                 Domain domain,
                                 @NonNull
                                 Credentials credentials)
                          throws IOException

Removes the specified Credentials from the specified Domain for this CredentialsStore.

Specified by:

removeCredentials in class CredentialsStore

Parameters:

domain - the domain.

credentials - the credentials

Returns:

true if the CredentialsStore was modified.

Throws:

IOException - if the change could not be persisted.

updateCredentials

public boolean updateCredentials(@NonNull
                                 Domain domain,
                                 @NonNull
                                 Credentials current,
                                 @NonNull
                                 Credentials replacement)
                          throws IOException

Updates the specified Credentials from the specified Domain for this CredentialsStore with the supplied replacement.

Specified by:

updateCredentials in class CredentialsStore

Parameters:

domain - the domain.

current - the credentials to update.

replacement - the new replacement credentials.

Returns:

true if the CredentialsStore was modified.

Throws:

IOException - if the change could not be persisted.

getRelativeLinkToContext

public String getRelativeLinkToContext()

Computes the relative path from the current page to this store.

Overrides:

getRelativeLinkToContext in class CredentialsStore

Returns:

the relative path from the current page or null

save

public void save()
          throws IOException

Persists the state of this object into XML. Default implementation delegates to CredentialsStore.getContext() if it implements Saveable otherwise dropping back to a no-op.

Specified by:

save in interface Saveable

Overrides:

save in class CredentialsStore

Throws:

IOException

See Also:

Saveable.save()