Package dev.galasa.framework.spi.creds

Interface ICredentialsService

public interface ICredentialsService

Method Summary

Modifier and Type	Method	Description
void	deleteCredentials(String credentialsId)
Map<String,ICredentials>	getAllCredentials()	Gets all the credentials stored in the credentials store
ICredentials	getCredentials(@NotNull String credentialsId)	Gets the credentials with the given ID and returns them after attempting to decrypt their values
void	setCredentials(String credentialsId, ICredentials credentials)

Method Details

getCredentials

ICredentials getCredentials(@NotNull
 @NotNull String credentialsId)
                     throws CredentialsException

Gets the credentials with the given ID and returns them after attempting to decrypt their values

Parameters:

credentialsId - the ID of the credentials to retrieve from the credentials store

Returns:

the decrypted credentials in the credentials store, or null if no such credentials exist

Throws:

CredentialsException - if there was an issue accessing the credentials store

getAllCredentials

Map<String,ICredentials> getAllCredentials()
                                    throws CredentialsException

Gets all the credentials stored in the credentials store

Returns:

a map of credentials, where keys correspond to credentials IDs and values correspond to the credentials

Throws:

CredentialsException - if there was an issue accessing the credentials store

setCredentials

void setCredentials(String credentialsId,
 ICredentials credentials)
             throws CredentialsException

Throws:

CredentialsException

deleteCredentials

void deleteCredentials(String credentialsId)
                throws CredentialsException

Throws:

CredentialsException