Self-review

QubitPi · Sep 11, 2023 · b2bd5a3 · b2bd5a3
1 parent 9f90665
commit b2bd5a3
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/docs/docs/security.md b/docs/docs/security.md
@@ -37,7 +37,7 @@ validator below:
 
 :::note
 
-Note that the implementation below depends on 2 JWT libraries:
+Note that the implementation[^1] below depends on 2 JWT libraries:
 
 ```xml
 <dependency>
@@ -214,6 +214,8 @@ public class ES384JwtTokenValidator implements AccessTokenValidator {
 }
 ```
 
+[^1]: https://stackoverflow.com/a/58965516
+
 [BinderFactory]: https://github.com/QubitPi/jersey-ws-template/blob/master/src/main/java/com/qubitpi/ws/jersey/template/application/BinderFactory.java
 
 [OAuth 2 access token]: https://www.oauth.com/oauth2-servers/access-tokens/
diff --git a/src/main/java/com/qubitpi/ws/jersey/template/web/filters/OAuthFilter.java b/src/main/java/com/qubitpi/ws/jersey/template/web/filters/OAuthFilter.java
@@ -31,6 +31,12 @@
 import java.io.IOException;
 import java.util.Objects;
 
+/**
+ * {@link OAuthFilter} is responsible for all OAuth 2 authorization logics, excluding authentications.
+ *
+ * For example, the filter validates an access token using an {@link AccessTokenValidator} that is
+ * <a href="https://stackoverflow.com/a/61620914">injected</a> into it.
+ */
 @Provider
 @Immutable
 @ThreadSafe