Auctoritas v0.2.3 Auctoritas.AuthenticationManager.DataStorage View Source
Default DataStorage implementation (based on Cachex)
Link to this section Summary
Types
Token expiration in seconds
Name from config (Auctoritas supervisor name)
Authentication token
Functions
Check for collisions
Delete token and its data
Get tokens data
Get a list of tokens
Get tokens with associated data (value and expiration)
Insert data into storage
Starts data_storage when returned {:ok, worker_map_or_equals}
Return {:no_worker}
if data_storage startup isn't required
Check if token exists
Get token expiration (countdown)
Callback implementation for Auctoritas.DataStorage.update_metadata/3
Update token data
Link to this section Types
expiration()
View Source
expiration() :: non_neg_integer()
expiration() :: non_neg_integer()
Token expiration in seconds
name()
View Source
name() :: String.t()
name() :: String.t()
Name from config (Auctoritas supervisor name)
token()
View Source
token() :: String.t()
token() :: String.t()
Authentication token
Link to this section Functions
check_collision(name, token) View Source
Check for collisions
Arguments:
- Name: Name from config
- Token: Generated token
delete_token(name, token) View Source
Delete token and its data
Arguments:
- Name: Name from config
- Token: Token to delete
get_token_data(name, token) View Source
Get tokens data
Arguments:
- Name: Name from config
- Token: Generated token
get_tokens(name, start, amount)
View Source
get_tokens(name(), start :: non_neg_integer(), amount :: non_neg_integer()) ::
{:ok, list()} | {:error, error :: any()}
get_tokens(name(), start :: non_neg_integer(), amount :: non_neg_integer()) :: {:ok, list()} | {:error, error :: any()}
Get a list of tokens
Arguments:
- Name: Name from config
- Start: Starting point in the list
- Amount: Amount of tokens to take from list
get_tokens_with_data(name, start, amount)
View Source
get_tokens_with_data(name(), non_neg_integer(), non_neg_integer()) ::
{atom(), any()}
get_tokens_with_data(name(), non_neg_integer(), non_neg_integer()) :: {atom(), any()}
Get tokens with associated data (value and expiration)
Arguments:
- Name: Name from config
- Start: Starting point in the list
- Amount: Amount of tokens to take from list
insert_token(name, expiration, token, data, metadata) View Source
Insert data into storage
Arguments:
- Name: Name from config
- Token: Generated token
- Data: Any kind of data you would like to associate with token
start_link(config) View Source
Starts data_storage when returned {:ok, worker_map_or_equals}
Return {:no_worker}
if data_storage startup isn't required
Callback implementation for Auctoritas.DataStorage.start_link/1
.
token_exists?(name, token) View Source
Check if token exists
Arguments:
- Name: Name from config
- Token: Generated token
token_expires?(name, token)
View Source
token_expires?(name(), token()) ::
{:ok, expiration()} | {:error, error :: any()}
token_expires?(name(), token()) :: {:ok, expiration()} | {:error, error :: any()}
Get token expiration (countdown)
Arguments:
- Name: Name from config
- Token: Generated token
update_metadata(name, token, new_metadata) View Source
Callback implementation for Auctoritas.DataStorage.update_metadata/3
.
update_token(name, token, new_data) View Source
Update token data
Arguments:
- Name: Name from config
- Token: Generated token
- Data: Data to update (Map.Merge)