Package dev.galasa.framework.spi.auth

Interface IAuthStore

public interface IAuthStore

Method Summary

Modifier and Type	Method	Description
void	deleteToken(String tokenId)	Deletes an existing token record from the auth store's tokens database.
List<IInternalAuthToken>	getTokens()	Returns a list of all the 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	shutdown()
void	storeToken(String clientId, String description, IInternalUser owner)	Stores a new token record in the auth store's tokens database.

Method Details

getTokens

List<IInternalAuthToken> getTokens()
                            throws AuthStoreException

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

Returns:

a list of all 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.

storeToken

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

Stores a new token record 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 record from the auth store's tokens database.

Parameters:

tokenId - the ID of the token record to delete.

Throws:

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

shutdown

void shutdown()
       throws AuthStoreException

Throws:

AuthStoreException