docs(simple-jwt-jjwt): Added package document for package simplejwt.jjwt.config

2023-08-04 19:53:49 +08:00
parent c50f66b4a3
commit ac9447d6ec
1 changed files with 58 additions and 0 deletions
@@ -0,0 +1,58 @@
+/*
+ * Copyright (C) 2023 CodeCraftersCN.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * <p>
+ * The package {@code cn.org.codecrafters.simplejwt.jjwt.config} contains
+ * configuration classes related to the {@link
+ * cn.org.codecrafters.simplejwt.jjwt.JjwtTokenResolver}
+ * implementation.
+ *
+ * <p>
+ * The classes in this package provide configuration options and settings for
+ * the {@link cn.org.codecrafters.simplejwt.jjwt.JjwtTokenResolver},
+ * which is used for resolving JSON Web Tokens (JWT) using the Auth0 library.
+ *
+ * <p>
+ * The {@link
+ * cn.org.codecrafters.simplejwt.jjwt.config.JjwtTokenResolverConfig}
+ * class is a configuration class that defines the mapping between standard
+ * {@link cn.org.codecrafters.simplejwt.constants.TokenAlgorithm} and the
+ * corresponding function implementation used by {@link
+ * cn.org.codecrafters.simplejwt.jjwt.JjwtTokenResolver} for handling
+ * JWT algorithms. It enables developers to specify and customize the
+ * algorithm functions according to the chosen JWT algorithm and the library
+ * being used.
+ *
+ * <p>
+ * The configuration options in this package help developers integrate and
+ * configure the {@link
+ * cn.org.codecrafters.simplejwt.jjwt.JjwtTokenResolver} seamlessly
+ * into their Spring Boot applications. Developers can fine-tune the token
+ * resolution process and customize algorithm handling to align with their
+ * specific requirements and desired level of security.
+ *
+ * <p>
+ * It is recommended to explore the classes in this package to understand how
+ * to configure and use the {@link
+ * cn.org.codecrafters.simplejwt.jjwt.JjwtTokenResolver} effectively
+ * in the Spring Boot environment to handle JWT authentication and
+ * authorization securely and efficiently.
+ *
+ * @since 1.0.0
+ */
+package cn.org.codecrafters.simplejwt.jjwt.config;