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/IUserTokenHandler.cs   | 28 ++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 BackEnd/Timeline/Services/Token/IUserTokenHandler.cs

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

diff --git a/BackEnd/Timeline/Services/Token/IUserTokenHandler.cs b/BackEnd/Timeline/Services/Token/IUserTokenHandler.cs
new file mode 100644
index 00000000..d9788909
--- /dev/null
+++ b/BackEnd/Timeline/Services/Token/IUserTokenHandler.cs
@@ -0,0 +1,28 @@
+using System;
+
+namespace Timeline.Services.Token
+{
+    public interface IUserTokenHandler
+    {
+        /// <summary>
+        /// Create a token for a given token info.
+        /// </summary>
+        /// <param name="tokenInfo">The info to generate token.</param>
+        /// <returns>Return the generated token.</returns>
+        /// <exception cref="ArgumentNullException">Thrown when <paramref name="tokenInfo"/> is null.</exception>
+        string GenerateToken(UserTokenInfo tokenInfo);
+
+        /// <summary>
+        /// Verify a token and get the saved info. Do not validate lifetime!!!
+        /// </summary>
+        /// <param name="token">The token to verify.</param>
+        /// <returns>The saved info in token.</returns>
+        /// <exception cref="ArgumentNullException">Thrown when <paramref name="token"/> is null.</exception>
+        /// <exception cref="UserTokenBadFormatException">Thrown when the token is of bad format.</exception>
+        /// <remarks>
+        /// If this method throw <see cref="UserTokenBadFormatException"/>, it usually means the token is not created by this service.
+        /// Do not check expire time in this method, only check whether it is present.
+        /// </remarks>
+        UserTokenInfo VerifyToken(string token);
+    }
+}
-- 
cgit v1.2.3