FerricStore.Management.ACL behaviour (ferricstore v0.5.4)

Stable ACL management contract for FerricStore control planes.

The default implementation is intentionally unsupported. Deployments can provide a configured implementation through application config.

Summary

acl_rule()

result()

username()

save(keyword)

save(opts \\ [])

@type acl_rule() :: binary()

@type result() :: :ok | {:ok, term()} | {:error, term()}

@type username() :: binary()

@callback del_user(
  username(),
  keyword()
) :: result()

@callback get_user(
  username(),
  keyword()
) :: result()

@callback list_users(keyword()) :: result()

@callback save(keyword()) :: result()

@callback set_user(username(), [acl_rule()], keyword()) :: result()

@spec del_user(
  username(),
  keyword()
) :: result()

@spec get_user(
  username(),
  keyword()
) :: result()

@spec list_users(keyword()) :: result()

@spec save(keyword()) :: result()

@spec set_user(username(), [acl_rule()], keyword()) :: result()