Package dev.galasa.framework.spi.auth

Interface IAuthStore

public interface IAuthStore

  • 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.

    • getAllUsers

      List<IUser> getAllUsers() throws AuthStoreException
      Returns a list of all the users using the system.
      Returns:
      a list of all users stored in the users store.
      Throws:
      AuthStoreException - if there is an issue accessing the users store.

    • createUser

      void createUser(String loginId, String clientName, String roleId) throws AuthStoreException
      Stores a new user record in the users store's database.
      Parameters:
      loginId - the loginId of the user trying to access Galasa API
      clientName - the name of the frontend client being used.
      roleId - the id of the role this user has been assigned. A numeric value.
      Throws:
      AuthStoreException - if there is an issue accessing the users store.

    • getUserByLoginId

      IUser getUserByLoginId(String loginId) throws AuthStoreException
      Retrieves a user record in the users store's database.
      Parameters:
      loginId - the loginId of the user trying to access Galasa API
      Throws:
      AuthStoreException - if there is an issue accessing the users store.

    • getUser

      IUser getUser(String userNumber) throws AuthStoreException
      Retrieves a user record in the users store's database.
      Parameters:
      userNumber - the ID of the user record to retrieve
      Throws:
      AuthStoreException - if there is an issue accessing the users store.

    • updateUser

      IUser updateUser(IUser user) throws AuthStoreException
      Updates a user record in the users store's database.
      Parameters:
      user - The user that needs to be updated
      Throws:
      AuthStoreException - if there is an issue accessing the users store.

    • shutdown

      void shutdown() throws AuthStoreException
      Throws:
      AuthStoreException

    • deleteUser

      void deleteUser(IUser user) throws AuthStoreException
      Throws:
      AuthStoreException

    • createClient

      IFrontEndClient createClient(String clientName)