From db6629940e294b44d678e776ccce769a8ac715de Mon Sep 17 00:00:00 2001
From: crupest <crupest@outlook.com>
Date: Wed, 28 Apr 2021 16:55:37 +0800
Subject: refactor: ...

---
 .../Timeline/Services/Token/IUserTokenManager.cs   | 35 ++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 BackEnd/Timeline/Services/Token/IUserTokenManager.cs

(limited to 'BackEnd/Timeline/Services/Token/IUserTokenManager.cs')

diff --git a/BackEnd/Timeline/Services/Token/IUserTokenManager.cs b/BackEnd/Timeline/Services/Token/IUserTokenManager.cs
new file mode 100644
index 00000000..c6eaa5b7
--- /dev/null
+++ b/BackEnd/Timeline/Services/Token/IUserTokenManager.cs
@@ -0,0 +1,35 @@
+using System;
+using System.Threading.Tasks;
+using Timeline.Entities;
+using Timeline.Services.User;
+
+namespace Timeline.Services.Token
+{
+    public interface IUserTokenManager
+    {
+        /// <summary>
+        /// Try to create a token for given username and password.
+        /// </summary>
+        /// <param name="username">The username.</param>
+        /// <param name="password">The password.</param>
+        /// <param name="expireAt">The expire time of the token.</param>
+        /// <returns>The created token and the user info.</returns>
+        /// <exception cref="ArgumentNullException">Thrown when <paramref name="username"/> or <paramref name="password"/> is null.</exception>
+        /// <exception cref="ArgumentException">Thrown when <paramref name="username"/> is of bad format.</exception>
+        /// <exception cref="UserNotExistException">Thrown when the user with <paramref name="username"/> does not exist.</exception>
+        /// <exception cref="BadPasswordException">Thrown when <paramref name="password"/> is wrong.</exception>
+        public Task<UserTokenCreateResult> CreateToken(string username, string password, DateTime? expireAt = null);
+
+        /// <summary>
+        /// Verify a token and get the saved user info. This also check the database for existence of the user.
+        /// </summary>
+        /// <param name="token">The token.</param>
+        /// <returns>The user stored in token.</returns>
+        /// <exception cref="ArgumentNullException">Thrown when <paramref name="token"/> is null.</exception>
+        /// <exception cref="UserTokenTimeExpiredException">Thrown when the token is expired.</exception>
+        /// <exception cref="UserTokenVersionExpiredException">Thrown when the token is of bad version.</exception>
+        /// <exception cref="UserTokenBadFormatException">Thrown when the token is of bad format.</exception>
+        /// <exception cref="UserTokenUserNotExistException">Thrown when the user specified by the token does not exist. Usually the user had been deleted after the token was issued.</exception>
+        public Task<UserEntity> VerifyToken(string token);
+    }
+}
-- 
cgit v1.2.3