com.cloudbees.plugins.credentials

Class CredentialsStore

java.lang.Object

com.cloudbees.plugins.credentials.CredentialsStore

Direct Known Subclasses:

SystemCredentialsProvider.StoreImpl, UserCredentialsProvider.StoreImpl

public abstract class CredentialsStore
extends Object

A store of Credentials.

Since:

1.8

Author:

Stephen Connolly

Constructor Summary

Constructors

Constructor and Description
CredentialsStore()

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	addCredentials(Domain domain, Credentials credentials) Adds the specified Credentials within the specified Domain for this CredentialsStore.
boolean	addDomain(Domain domain, Credentials... credentials) Adds a new Domain with seed credentials.
boolean	addDomain(Domain domain, List<Credentials> credentials) Adds a new Domain with seed credentials.
void	checkPermission(hudson.security.Permission p) Checks if the current security principal has this permission.
abstract hudson.model.ModelObject	getContext() Returns the context within which this store operates.
abstract 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.
abstract boolean	hasPermission(org.acegisecurity.Authentication a, hudson.security.Permission permission) Checks if the given principle has the given permission.
boolean	hasPermission(hudson.security.Permission p) Checks if the current security principal has this permission.
boolean	isDomainsModifiable() Identifies whether this CredentialsStore supports making changes to the list of domains or whether it only supports a fixed set of domains (which may only be one domain).
abstract 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.
abstract 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 java.lang.Object

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

Constructor Detail

CredentialsStore

public CredentialsStore()

Method Detail

getContext

public abstract hudson.model.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.

Returns:

the context within which this store operates.

checkPermission

public final void checkPermission(@NonNull
                   hudson.security.Permission p)

Checks if the current security principal has this permission.

This is just a convenience function.

Throws:

org.acegisecurity.AccessDeniedException - if the user doesn't have the permission.

hasPermission

public final boolean hasPermission(@NonNull
                    hudson.security.Permission p)

Checks if the current security principal has this permission.

Returns:

false if the user doesn't have the permission.

hasPermission

public abstract boolean hasPermission(@NonNull
                    org.acegisecurity.Authentication a,
                    @NonNull
                    hudson.security.Permission permission)

Checks if the given principle has the given permission.

getDomains

@NonNull
public List<Domain> getDomains()

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

Returns:

the list of domains.

isDomainsModifiable

public final boolean isDomainsModifiable()

Identifies whether this CredentialsStore supports making changes to the list of domains or whether it only supports a fixed set of domains (which may only be one domain).

Note: in order for implementations to return true all of the following methods must be overridden:

• getDomains()
• addDomain(Domain, java.util.List)
• removeDomain(Domain)
• updateDomain(Domain, Domain)

Returns:

true iff addDomain(Domain, List) addDomain(Domain, Credentials...), removeDomain(Domain) and updateDomain(Domain, Domain) are expected to work

getCredentials

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

Returns an unmodifiable list of credentials for the specified domain.

Parameters:

domain - the domain.

Returns:

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

addDomain

public final boolean addDomain(@NonNull
                Domain domain,
                Credentials... credentials)
                        throws IOException

Adds a new Domain with seed credentials.

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.

addDomain

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

Adds a new Domain with seed credentials.

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.

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.

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 abstract boolean addCredentials(@NonNull
                     Domain domain,
                     @NonNull
                     Credentials credentials)
                                throws IOException

Adds the specified Credentials within the specified Domain for this 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 abstract boolean removeCredentials(@NonNull
                        Domain domain,
                        @NonNull
                        Credentials credentials)
                                   throws IOException

Removes the specified Credentials from the specified Domain for this 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 abstract 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.

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.