docs(global): Optimised javadocs.
This commit is contained in:
+2
-6
@@ -34,25 +34,21 @@ import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.DependsOn;
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* SimpleJwtAutoConfiguration is responsible for automatically configuring the
|
||||
* Simple JWT library with {@code com.auth0:java-jwt} when used in a Spring
|
||||
* Boot application. It provides default settings and configurations to ensure
|
||||
* that the library works smoothly without requiring manual configuration.
|
||||
*
|
||||
* <p>
|
||||
* This auto-configuration class sets up the necessary beans and components
|
||||
* This autoconfiguration class sets up the necessary beans and components
|
||||
* required for JWT generation and validation. It automatically creates and
|
||||
* configures the {@link TokenResolver} bean based on the available options and
|
||||
* properties.
|
||||
*
|
||||
* <p>
|
||||
* Developers using the Simple JWT library with Spring Boot do not need to
|
||||
* explicitly configure the library, as the auto-configuration takes care of
|
||||
* explicitly configure the library, as the autoconfiguration takes care of
|
||||
* setting up the necessary components and configurations automatically.
|
||||
* However, developers still have the flexibility to customize the behavior of
|
||||
* the library by providing their own configurations and properties.
|
||||
*
|
||||
*
|
||||
* @author Zihlu Wang
|
||||
* @version 1.0.0
|
||||
|
||||
+3
-1
@@ -29,9 +29,11 @@ import org.springframework.context.annotation.Conditional;
|
||||
import java.util.UUID;
|
||||
|
||||
/**
|
||||
* GuidAutoConfiguration
|
||||
* Autoconfiguration for injecting a {@code GuidCreator} for generating jwt id.
|
||||
*
|
||||
* @author Zihlu Wang
|
||||
* @version 1.1.0
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Slf4j
|
||||
@AutoConfiguration
|
||||
|
||||
+3
-6
@@ -34,28 +34,25 @@ import org.springframework.boot.context.properties.EnableConfigurationProperties
|
||||
import org.springframework.context.annotation.Bean;
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* JjwtTokenResolverAutoConfiguration is responsible for automatically
|
||||
* configuring the Simple JWT library with {@code io.jsonwebtoken:jjwt-api}
|
||||
* when used in a Spring Boot application. It provides default settings and
|
||||
* configurations to ensure that the library works smoothly without requiring
|
||||
* manual configuration.
|
||||
*
|
||||
* <p>
|
||||
* This auto-configuration class sets up the necessary beans and components
|
||||
* This autoconfiguration class sets up the necessary beans and components
|
||||
* required for JWT generation and validation. It automatically creates and
|
||||
* configures the {@link TokenResolver} bean based on the available options and
|
||||
* properties.
|
||||
*
|
||||
* <p>
|
||||
* Developers using the Simple JWT library with Spring Boot do not need to
|
||||
* explicitly configure the library, as the auto-configuration takes care of
|
||||
* explicitly configure the library, as the autoconfiguration takes care of
|
||||
* setting up the necessary components and configurations automatically.
|
||||
* However, developers still have the flexibility to customize the behavior of
|
||||
* the library by providing their own configurations and properties.
|
||||
*
|
||||
* @author Zihlu Wang
|
||||
* @version 1.0.0
|
||||
* @version 1.1.0
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Slf4j
|
||||
|
||||
+3
-3
@@ -9,11 +9,11 @@ import org.springframework.core.type.AnnotatedTypeMetadata;
|
||||
import java.util.Objects;
|
||||
|
||||
/**
|
||||
* GuidCreatorCondition
|
||||
* <p>
|
||||
* Created on 28 Aug 2023
|
||||
* The condition to create bean {@code jtiCreator}.
|
||||
*
|
||||
* @author Zihlu Wang
|
||||
* @version 1.1.0
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Slf4j
|
||||
public class GuidCreatorCondition implements Condition {
|
||||
|
||||
+5
-9
@@ -24,28 +24,24 @@ import lombok.Data;
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* {@code SimpleJwtProperties} is a configuration properties class used to
|
||||
* store the properties related to Simple JWT library configuration. These
|
||||
* properties can be configured in the application's properties file (e.g.,
|
||||
* application.properties) with the prefix "code-crafters.simple-jwt".
|
||||
*
|
||||
*
|
||||
* <p>
|
||||
* SimpleJwtProperties provides configuration options for the JWT algorithm,
|
||||
* issuer, and secret. The properties are used by the {@link
|
||||
* AuthzeroTokenResolverAutoConfiguration}
|
||||
* class to set up the necessary configurations for JWT generation and
|
||||
* validation.
|
||||
*
|
||||
*
|
||||
* AuthzeroTokenResolverAutoConfiguration} and {@link
|
||||
* cn.org.codecrafters.simplejwt.jjwt.JjwtTokenResolver} to set up the
|
||||
* necessary configurations for JWT generation and validation.
|
||||
* <p>
|
||||
* Developers can customize the JWT algorithm, issuer, and secret by setting
|
||||
* the corresponding properties in the application's properties file. The
|
||||
* SimpleJwtAutoConfiguration class reads these properties and uses them to
|
||||
* create the TokenResolver bean with the desired configuration.
|
||||
*
|
||||
*
|
||||
* @author Zihlu Wang
|
||||
* @version 1.1.0
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Data
|
||||
|
||||
+1
-4
@@ -16,15 +16,12 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* The "cn.org.codecrafters.simplejwt.autoconfiguration.properties" package
|
||||
* contains configuration properties classes used for Simple JWT library
|
||||
* auto-configuration. These classes define the properties that can be
|
||||
* autoconfiguration. These classes define the properties that can be
|
||||
* configured in the application's properties file (e.g.,
|
||||
* application.properties) to customize the behavior and settings of the Simple
|
||||
* JWT library.
|
||||
*
|
||||
*
|
||||
* <p>
|
||||
* Developers can customize the JWT algorithm, issuer, and secret by setting
|
||||
* the corresponding properties in the application's properties file with the
|
||||
|
||||
Reference in New Issue
Block a user