com.cloudbees.plugins.credentials

Class UserCredentialsProvider.StoreImpl

java.lang.Object

com.cloudbees.plugins.credentials.CredentialsStore

com.cloudbees.plugins.credentials.UserCredentialsProvider.StoreImpl

Enclosing class:

UserCredentialsProvider

public static class UserCredentialsProvider.StoreImpl
extends CredentialsStore

Method Summary

Methods

Modifier and Type	Method and 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.
hudson.model.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.
boolean	hasPermission(org.acegisecurity.Authentication a, hudson.security.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.
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

addDomain, checkPermission, hasPermission, isDomainsModifiable

Methods inherited from class java.lang.Object

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

Method Detail

getContext

public hudson.model.ModelObject getContext()

Description copied from class: CredentialsStore

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
                    org.acegisecurity.Authentication a,
                    @NonNull
                    hudson.security.Permission permission)

Description copied from class: CredentialsStore

Checks if the given principle has the given permission.

Specified by:

hasPermission 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.

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.

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.

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.