doc: add basic java docs and java doc maven plugin (#16)

pom.xml

@@ -200,6 +200,20 @@ SPDX-License-Identifier: Apache-2.0
             </resource>
         </resources>
         <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>3.6.0</version>
+                <executions>
+                    <execution>
+                        <id>attach-javadocs</id>
+                        <phase>compile</phase>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
             <plugin>
                 <groupId>org.eclipse.dash</groupId>
                 <artifactId>license-tool-plugin</artifactId>

src/main/java/org/eclipse/tractusx/ssi/examples/BuildDIDDocEd25519VerificationKey2020.java

@@ -39,7 +39,16 @@
 import org.eclipse.tractusx.ssi.lib.model.did.Ed25519VerificationMethodBuilder;
 import org.eclipse.tractusx.ssi.lib.model.did.VerificationMethod;
 
+/** This is example class to demonstrate how to create @{@link DidDocument} using Ed25519 key */
 public class BuildDIDDocEd25519VerificationKey2020 {
+
+  /**
+   * Build did document
+   *
+   * @param hostName the host name
+   * @return the did document
+   * @throws KeyGenerationException the key generation exception
+   */
   public static DidDocument buildDidDocument(String hostName) throws KeyGenerationException {
     final Did did = DidWebFactory.fromHostname(hostName);
 

src/main/java/org/eclipse/tractusx/ssi/examples/BuildDIDDocJsonWebKey2020.java

@@ -40,7 +40,14 @@
 import org.eclipse.tractusx.ssi.lib.model.did.JWKVerificationMethodBuilder;
 import org.eclipse.tractusx.ssi.lib.model.did.VerificationMethod;
 
+/** This is example class to demonstrate how to create @{@link DidDocument} using Json web key */
 public class BuildDIDDocJsonWebKey2020 {
+  /**
+   * Build did document.
+   *
+   * @param hostName the host name
+   * @return the did document
+   */
   @SneakyThrows
   public static DidDocument buildDidDocument(String hostName) {
     // Building DID and Key

src/main/java/org/eclipse/tractusx/ssi/examples/ResolveDIDDoc.java

@@ -31,7 +31,16 @@
 import org.eclipse.tractusx.ssi.lib.model.did.DidDocument;
 import org.eclipse.tractusx.ssi.lib.model.did.DidMethod;
 
+/** This is an example class to demonstrate did document resolve from given did web url */
 public class ResolveDIDDoc {
+  /**
+   * Resolve did document.
+   *
+   * @param didUrl the did url
+   * @return the did document
+   * @throws DidDocumentResolverNotRegisteredException the did document resolver not registered
+   *     exception
+   */
   public static DidDocument ResovleDocument(String didUrl)
       throws DidDocumentResolverNotRegisteredException {
 

src/main/java/org/eclipse/tractusx/ssi/examples/VC.java

@@ -39,7 +39,13 @@
 import org.eclipse.tractusx.ssi.lib.proof.LinkedDataProofGenerator;
 import org.eclipse.tractusx.ssi.lib.proof.SignatureType;
 
+/** This is example class to demonstrate how create Verifiable Credentials */
 public class VC {
+  /**
+   * Create verifiable credential without proof
+   *
+   * @return the verifiable credential
+   */
   public static VerifiableCredential createVCWithoutProof() {
 
     // VC Bulider
@@ -64,6 +70,17 @@ public static VerifiableCredential createVCWithoutProof() {
     return credentialWithoutProof;
   }
 
+  /**
+   * Create verifiable credential with ED21559 proof
+   *
+   * @param credential the credential
+   * @param privateKey the private key
+   * @param issuer the issuer
+   * @return the verifiable credential
+   * @throws UnsupportedSignatureTypeException the unsupported signature type exception
+   * @throws SsiException the ssi exception
+   * @throws InvalidePrivateKeyFormat the invalide private key format
+   */
   public static VerifiableCredential createVCWithED21559Proof(
       VerifiableCredential credential, IPrivateKey privateKey, Did issuer)
       throws UnsupportedSignatureTypeException, SsiException, InvalidePrivateKeyFormat {
@@ -92,6 +109,17 @@ public static VerifiableCredential createVCWithED21559Proof(
     return builder.build();
   }
 
+  /**
+   * Create vc with jws proof verifiable credential.
+   *
+   * @param credential the credential
+   * @param privateKey the private key
+   * @param issuer the issuer
+   * @return the verifiable credential
+   * @throws UnsupportedSignatureTypeException the unsupported signature type exception
+   * @throws SsiException the ssi exception
+   * @throws InvalidePrivateKeyFormat the invalide private key format
+   */
   public static VerifiableCredential createVCWithJWSProof(
       VerifiableCredential credential, IPrivateKey privateKey, Did issuer)
       throws UnsupportedSignatureTypeException, SsiException, InvalidePrivateKeyFormat {

src/main/java/org/eclipse/tractusx/ssi/examples/VP.java

@@ -37,8 +37,19 @@
 import org.eclipse.tractusx.ssi.lib.serialization.jwt.SerializedJwtPresentationFactory;
 import org.eclipse.tractusx.ssi.lib.serialization.jwt.SerializedJwtPresentationFactoryImpl;
 
+/**
+ * This is an example class to demonstrate how to create a Verifiable Presentation in JSON-LD and
+ * JWT format
+ */
 class VP {
 
+  /**
+   * Create a verifiable presentation.
+   *
+   * @param issuer the issuer
+   * @param credentials the credentials
+   * @return the verifiable presentation
+   */
   public static VerifiablePresentation createVP(
       Did issuer, List<VerifiableCredential> credentials) {
     final VerifiablePresentationBuilder verifiablePresentationBuilder =
@@ -52,6 +63,17 @@ public static VerifiablePresentation createVP(
     return verifiablePresentation;
   }
 
+  /**
+   * Create vp as a signed jwt.
+   *
+   * @param issuer the issuer
+   * @param credentials the credentials
+   * @param audience the audience
+   * @param privateKey the private key
+   * @param publicKey the public key
+   * @return the signed jwt
+   * @throws IOException the io exception
+   */
   public static SignedJWT createVPAsJWT(
       Did issuer,
       List<VerifiableCredential> credentials,

src/main/java/org/eclipse/tractusx/ssi/examples/Validation.java

@@ -26,13 +26,30 @@
 import org.eclipse.tractusx.ssi.lib.exception.JwtExpiredException;
 import org.eclipse.tractusx.ssi.lib.jwt.SignedJwtValidator;
 
+/** This is example class to demonstrate how to validate JWT expiry date and audience */
 public class Validation {
+  /**
+   * Validate jwt date.
+   *
+   * @param signedJWT the signed jwt
+   * @param audience the audience
+   * @throws JwtAudienceCheckFailedException the jwt audience check failed exception
+   * @throws JwtExpiredException the jwt expired exception
+   */
   public static void validateJWTDate(SignedJWT signedJWT, String audience)
       throws JwtAudienceCheckFailedException, JwtExpiredException {
     SignedJwtValidator jwtValidator = new SignedJwtValidator();
     jwtValidator.validateDate(signedJWT);
   }
 
+  /**
+   * Validate jwt audiences.
+   *
+   * @param signedJWT the signed jwt
+   * @param audience the audience
+   * @throws JwtAudienceCheckFailedException the jwt audience check failed exception
+   * @throws JwtExpiredException the jwt expired exception
+   */
   public static void validateJWTAudiences(SignedJWT signedJWT, String audience)
       throws JwtAudienceCheckFailedException, JwtExpiredException {
     SignedJwtValidator jwtValidator = new SignedJwtValidator();

src/main/java/org/eclipse/tractusx/ssi/examples/Verification.java

@@ -31,8 +31,17 @@
 import org.eclipse.tractusx.ssi.lib.model.verifiable.credential.VerifiableCredential;
 import org.eclipse.tractusx.ssi.lib.proof.LinkedDataProofValidation;
 
+/**
+ * This is example class to demonstrate how to verify @{@link SignedJWT} and {@link
+ * VerifiableCredential}
+ */
 public class Verification {
 
+  /**
+   * Verify jwt.
+   *
+   * @param jwt the jwt
+   */
   public static void verifyJWT(SignedJWT jwt) {
     // DID Resolver constructor params
     DidWebParser didParser = new DidWebParser();
@@ -50,6 +59,12 @@ public static void verifyJWT(SignedJWT jwt) {
     }
   }
 
+  /**
+   * Verify ed21559 signed ld.
+   *
+   * @param verifiableCredential the verifiable credential
+   * @return the boolean
+   */
   public static boolean verifyED21559LD(VerifiableCredential verifiableCredential) {
     // DID Resolver constructor params
     DidWebParser didParser = new DidWebParser();
@@ -61,6 +76,12 @@ public static boolean verifyED21559LD(VerifiableCredential verifiableCredential)
     return proofValidation.verify(verifiableCredential);
   }
 
+  /**
+   * Verify jws signed ld.
+   *
+   * @param verifiableCredential the verifiable credential
+   * @return the boolean
+   */
   public static boolean verifyJWSLD(VerifiableCredential verifiableCredential) {
     // DID Resolver constructor params
     DidWebParser didParser = new DidWebParser();

src/main/java/org/eclipse/tractusx/ssi/lib/SsiLibrary.java

@@ -25,7 +25,9 @@
 import net.i2p.crypto.eddsa.EdDSASecurityProvider;
 import org.bouncycastle.jce.provider.BouncyCastleProvider;
 
+/** The type SSI library. */
 public final class SsiLibrary {
+  /** Initialize. */
   public static void initialize() {
     Security.addProvider(new EdDSASecurityProvider());
     Security.addProvider(new BouncyCastleProvider());

src/main/java/org/eclipse/tractusx/ssi/lib/crypt/IKey.java

@@ -24,13 +24,36 @@
 import java.io.IOException;
 import org.eclipse.tractusx.ssi.lib.model.base.EncodeType;
 
+/** The interface Key. */
 public interface IKey {
-  // TODO add docs
+  /**
+   * Gets key length.
+   *
+   * @return the key length
+   */
   int getKeyLength();
 
+  /**
+   * Convert the key to a string for storing
+   *
+   * @return the string
+   * @throws IOException the io exception
+   */
   String asStringForStoring() throws IOException;
 
+  /**
+   * Convert the key to a string for exchange.
+   *
+   * @param encodeType the encode type
+   * @return the string
+   * @throws IOException the io exception
+   */
   String asStringForExchange(EncodeType encodeType) throws IOException;
 
+  /**
+   * Convert the key to a byte array.
+   *
+   * @return the byte [ ]
+   */
   byte[] asByte();
 }

src/main/java/org/eclipse/tractusx/ssi/lib/crypt/IKeyGenerator.java

@@ -23,6 +23,14 @@
 
 import org.eclipse.tractusx.ssi.lib.exception.KeyGenerationException;
 
+/** The interface KeyGenerator. */
 public interface IKeyGenerator {
+
+  /**
+   * Generate key pair.
+   *
+   * @return the key pair
+   * @throws KeyGenerationException the key generation exception
+   */
   KeyPair generateKey() throws KeyGenerationException;
 }

src/main/java/org/eclipse/tractusx/ssi/lib/crypt/IPrivateKey.java

@@ -21,4 +21,5 @@
 
 package org.eclipse.tractusx.ssi.lib.crypt;
 
+/** The interface private key. */
 public interface IPrivateKey extends IKey {}

src/main/java/org/eclipse/tractusx/ssi/lib/crypt/IPublicKey.java

@@ -21,4 +21,5 @@
 
 package org.eclipse.tractusx.ssi.lib.crypt;
 
+/** The interface public key. */
 public interface IPublicKey extends IKey {}

src/main/java/org/eclipse/tractusx/ssi/lib/crypt/KeyPair.java

@@ -24,6 +24,7 @@
 import lombok.Data;
 import lombok.RequiredArgsConstructor;
 
+/** The type key pair. */
 @RequiredArgsConstructor
 @Data
 public class KeyPair {

src/main/java/org/eclipse/tractusx/ssi/lib/crypt/jwk/JsonWebKey.java

@@ -22,36 +22,62 @@
 package org.eclipse.tractusx.ssi.lib.crypt.jwk;
 
 import com.nimbusds.jose.jwk.OctetKeyPair;
-import java.io.IOException;
 import lombok.AccessLevel;
 import lombok.RequiredArgsConstructor;
 import org.eclipse.tractusx.ssi.lib.crypt.IPrivateKey;
 import org.eclipse.tractusx.ssi.lib.crypt.IPublicKey;
 import org.eclipse.tractusx.ssi.lib.crypt.octet.OctetKeyPairFactory;
 
+/** The type JsonWebKey. */
 @RequiredArgsConstructor(access = AccessLevel.PRIVATE)
 public class JsonWebKey {
   private final OctetKeyPair keyPair;
 
-  public JsonWebKey(String id, IPublicKey publicKey, IPrivateKey privateKey) throws IOException {
+  /**
+   * Instantiates a new JsonWebKey.
+   *
+   * @param id the id
+   * @param publicKey the public key
+   * @param privateKey the private key
+   */
+  public JsonWebKey(String id, IPublicKey publicKey, IPrivateKey privateKey) {
     OctetKeyPairFactory keyPairFactory = new OctetKeyPairFactory();
     OctetKeyPair keyOctetKeyPair = keyPairFactory.fromKeyPairWithKeyID(id, publicKey, privateKey);
-
     this.keyPair = keyOctetKeyPair;
   }
 
+  /**
+   * Gets the curve name of the key pair.
+   *
+   * @return the curve
+   */
   public String getCurv() {
     return keyPair.getCurve().getName();
   }
 
+  /**
+   * Gets key id.
+   *
+   * @return the key id
+   */
   public String getKeyID() {
     return keyPair.getKeyID();
   }
 
+  /**
+   * Gets key type.
+   *
+   * @return the key type
+   */
   public String getKeyType() {
     return this.keyPair.getKeyType().getValue();
   }
 
+  /**
+   * Gets the x member contains the x coordinate for the elliptic curve point.
+   *
+   * @return the x
+   */
   public String getX() {
     return this.keyPair.getX().toString();
   }