com.atlassian.bamboo.credentials

Interface CredentialsAccessor

All Known Subinterfaces:

CredentialsManager

All Known Implementing Classes:

CredentialsManagerImpl, RemoteCredentialsAccessor

public interface CredentialsAccessor

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CredentialsAccessor.IsCredentialsOfType Deprecated. since 5.15, use BambooPluginUtils#pluginKeyEquals(String)

Method Summary

Modifier and Type	Method and Description
Iterable<CredentialsData>	getAllCredentials()
Iterable<CredentialsData>	getAllCredentials(String pluginKey)
CredentialsData	getCredentials(long id) Gets the Shared Credentials by id
CredentialsData	getCredentialsByName(String name) Find global shared credentials by name
CredentialsData	getCredentialsByNameAndProjectId(String name, long projectId) Find shared credentials by name and project id
CredentialsData	getCredentialsByOid(BambooEntityOid oid) Find shared credentials by BambooEntityOid
Iterable<CredentialsData>	getProjectCredentials(Long projectId)
CredentialsData	getProjectCredentials(long id, long projectId) Gets the Shared Credentials by id and projectId
Iterable<CredentialsData>	getProjectCredentialsByPluginKey(Long projectId, String pluginKey)
boolean	hasAnyCredentials(String pluginKey)

Method Detail

getCredentials

@Nullable
CredentialsData getCredentials(long id)

Gets the Shared Credentials by id

Parameters:

id -

Returns:

Returns the object representation of the credentials

getProjectCredentials

@Nullable
CredentialsData getProjectCredentials(long id,
                                                long projectId)

Gets the Shared Credentials by id and projectId

Parameters:

id -

Returns:

Returns the object representation of the credentials

getCredentialsByOid

@Nullable
CredentialsData getCredentialsByOid(BambooEntityOid oid)

Find shared credentials by BambooEntityOid

Parameters:

oid -

Returns:

Since:

5.15

getCredentialsByName

@Nullable
CredentialsData getCredentialsByName(String name)

Find global shared credentials by name

Parameters:

name -

Returns:

Since:

5.15

getCredentialsByNameAndProjectId

CredentialsData getCredentialsByNameAndProjectId(String name,
                                                 long projectId)

Find shared credentials by name and project id

Parameters:

name -

projectId -

Returns:

getAllCredentials

@NotNull
Iterable<CredentialsData> getAllCredentials()

Returns:

A list of all global credentials

getProjectCredentials

@NotNull
Iterable<CredentialsData> getProjectCredentials(@NotNull
                                                         Long projectId)

Parameters:

projectId -

Returns:

A list of all project credentials in project associated with given projectId

getAllCredentials

@NotNull
Iterable<CredentialsData> getAllCredentials(@NotNull
                                                     String pluginKey)

Returns:

A list of global credentials that match the given plugin key

getProjectCredentialsByPluginKey

@NotNull
Iterable<CredentialsData> getProjectCredentialsByPluginKey(@NotNull
                                                                    Long projectId,
                                                                    String pluginKey)

Parameters:

projectId -

pluginKey -

Returns:

a collection of project credentials that match the given plugin key

hasAnyCredentials

boolean hasAnyCredentials(@NotNull
                          String pluginKey)

Returns:

True if there are global credentials that match the given plugin key