Package dev.galasa.framework.spi.auth
Interface IAuthStoreService
public interface IAuthStoreService
-
Method Summary
Modifier and TypeMethodDescriptionvoid
deleteToken
(String tokenId) Deletes an existing token in the auth store's tokens database.Gets an token record given its ID from the auth store.Returns a list of all the auth token records stored in the auth store.void
storeToken
(String clientId, String description, IInternalUser owner) Stores a new token in the auth store's tokens database.
-
Method Details
-
getTokens
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.
-
getToken
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
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
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.
-