Package dev.galasa.framework.spi.auth

Interface IAuthStoreService

public interface IAuthStoreService

Method Summary

Modifier and Type	Method	Description
void	deleteToken(String tokenId)	Deletes an existing token in the auth store's tokens database.
IInternalAuthToken	getToken(String tokenId)	Gets an token record given its ID from the auth store.
List<IInternalAuthToken>	getTokens()	Returns a list of all the auth token records stored in the auth store.
List<IInternalAuthToken>	getTokensByLoginId(String loginId)	Returns a list of token records stored in the auth store that match a given login ID.
void	storeToken(String clientId, String description, IInternalUser owner)	Stores a new token in the auth store's tokens database.

Method Details

getTokens

List<IInternalAuthToken> getTokens()
                            throws AuthStoreException

Returns a list of all the auth token records stored in the auth store.

Returns:

a list of all auth token records stored in the auth store.

Throws:

AuthStoreException - if there is an issue accessing the auth store.

getTokensByLoginId

List<IInternalAuthToken> getTokensByLoginId(String loginId)
                                     throws AuthStoreException

Returns a list of token records stored in the auth store that match a given login ID.

Returns:

a list of all token records stored in the auth store by login ID.

Throws:

AuthStoreException - if there is an issue accessing the auth store.

getToken

IInternalAuthToken getToken(String tokenId)
                     throws AuthStoreException

Gets an token record given its ID from the auth store.

Parameters:

tokenId - the ID of the token record to retrieve

Returns:

an auth token givne

Throws:

AuthStoreException

storeToken

void storeToken(String clientId,
 String description,
 IInternalUser owner)
         throws AuthStoreException

Stores a new token in the auth store's tokens database.

Parameters:

clientId - the ID of the Dex client that the token works with.

description - the user-provided description of the token.

owner - the details of the user that the token belongs to.

Throws:

AuthStoreException - if there is an issue accessing the auth store.

deleteToken

void deleteToken(String tokenId)
          throws AuthStoreException

Deletes an existing token in the auth store's tokens database.

Parameters:

tokenId - the ID of the token to delete.

Throws:

AuthStoreException - if there was an issue accessing the auth store.