Skip to content

Commit 0b04bf2

Browse files
author
zihluwang
committed
docs: updated javadoc
1 parent cd5fee9 commit 0b04bf2

File tree

4 files changed

+10
-8
lines changed

4 files changed

+10
-8
lines changed

key-pair-loader/src/main/java/com/onixbyte/security/KeyLoader.java

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,8 @@
1717

1818
package com.onixbyte.security;
1919

20-
import com.onixbyte.security.exception.KeyLoadingException;
21-
2220
import java.security.PrivateKey;
2321
import java.security.PublicKey;
24-
import java.security.interfaces.ECPrivateKey;
2522

2623
/**
2724
* The {@code KeyLoader} class provides utility methods for loading keys pairs from PEM-formatted
@@ -31,7 +28,7 @@
3128
* from PEM-formatted strings for cryptographic operations.
3229
*
3330
* @author zihluwang
34-
* @version 1.6.0
31+
* @version 2.0.0
3532
* @since 1.6.0
3633
*/
3734
public interface KeyLoader {

key-pair-loader/src/main/java/com/onixbyte/security/exception/KeyLoadingException.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,16 @@
2929
* <p><b>Example usage:</b></p>
3030
* <pre>{@code
3131
* try {
32-
* ECPrivateKey privateKey = KeyLoader.loadEcdsaPrivateKey(pemPrivateKey);
32+
* KeyLoader keyLoader = new EcKeyLoader();
33+
* ECPrivateKey privateKey = keyLoader.loadPrivateKey(pemPrivateKey);
3334
* } catch (KeyLoadingException e) {
3435
* // Handle the exception
3536
* e.printStackTrace();
3637
* }
3738
* }</pre>
3839
*
3940
* @author zihluwang
40-
* @version 1.6.0
41+
* @version 2.0.0
4142
* @since 1.6.0
4243
*/
4344
public class KeyLoadingException extends RuntimeException {

key-pair-loader/src/main/java/com/onixbyte/security/impl/EcKeyLoader.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,10 @@
4848
* -----END EC PUBLIC KEY-----""";
4949
* ECPublicKey publicKey = KeyLoader.loadPublicKey(pemPublicKey);
5050
* }</pre>
51+
*
52+
* @author zihluwang
53+
* @version 2.0.0
54+
* @since 2.0.0
5155
*/
5256
public class EcKeyLoader implements KeyLoader {
5357

simple-jwt-spring-boot-starter/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ It is quite simple to install this module by `Maven`. The only thing you need to
2929
<version>${simple-jwt-${any-implementation}.version}</version>
3030
</dependency>
3131
<dependency>
32-
<groupId>cn.org.codecrafters</groupId>
32+
<groupId>com.onixbyte</groupId>
3333
<artifactId>simple-jwt-spring-boot-starter</artifactId>
3434
<version>${simple-jwt-spring-boot-starter.version}</version>
3535
</dependency>
@@ -50,7 +50,7 @@ Find `build.gradle` in the needed project, and add the following code to the `de
5050

5151
```groovy
5252
implementation '${implementation-builder-group-id}:simple-jwt-${any-implementation}:${simple-jwt-${any-implementation}.version}'
53-
implementation 'cn.org.codecrafters:simple-jwt-spring-boot-starter:${simple-jwt-spring-boot-starter.version}'
53+
implementation 'com.onixbyte:simple-jwt-spring-boot-starter:${simple-jwt-spring-boot-starter.version}'
5454
```
5555

5656
### If you are not using `Maven` or `Gradle`

0 commit comments

Comments
 (0)