[java-oidc-common] branch main updated: Minor Javadoc fixes

[Phil Smart]

This is an automated email from the git hooks/post-receive script.

philsmart pushed a commit to branch main
in repository java-oidc-common.

View the commit online:
http://git.shibboleth.net/view/?p=java-oidc-common.git;a=commit;h=e8ffa75fed2faf50394d4dfeb8697072d196a5f2

The following commit(s) were added to refs/heads/main by this push:
       new  e8ffa75   Minor Javadoc fixes
e8ffa75 is described below

commit e8ffa75fed2faf50394d4dfeb8697072d196a5f2
Author: Phil Smart <philip.smart at jisc.ac.uk>
AuthorDate: Fri Feb 5 14:29:11 2021 +0000

    Minor Javadoc fixes
---
 .../shibboleth/oidc/security/impl/JWSAssemblyUtils.java  | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/JWSAssemblyUtils.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/JWSAssemblyUtils.java
index 7b06061..a47e5ee 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/JWSAssemblyUtils.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/JWSAssemblyUtils.java
@@ -51,13 +51,13 @@ public final class JWSAssemblyUtils {
     
     /**
      * Assemble a HMAC based JSON Web Signature token using the given algorithm, claims, and secret,
-     * and return its serialized form.
+     * and return its JSON compact serialized form.
      * 
      * <p>Note, can be used over the Nimbus {@link MACSigner} on occasions where an algorithm to 
      * secret key compatibility issues exist e.g. using a HS512 HMAC with too small a secret key</p>
      * 
      * @param algorithm the JWA algorithm, **must** be one from the HMAC family.
-     * @param claimsSet the claims that form the payload.
+     * @param claimsSet the JSON claims that form the payload.
      * @param secret the pre-shared secret used to construct the HMAC.
      * 
      * @return a fully assembled JWS using the JSON compact serialisation.
@@ -84,7 +84,7 @@ public final class JWSAssemblyUtils {
     * @param claimsSet the claims that form the payload.
     * @param secret the pre-shared secret used to construct the HMAC.
     * 
-    * @return a fully assembled JWS.
+    * @return a fully assembled {@link SignedJWT signed JWT}.
     * 
     * @throws EncodingException On error during encoding.
     * @throws JOSEException If the algorithm is not supported.
@@ -121,9 +121,9 @@ public final class JWSAssemblyUtils {
     
     
     /**
-     * Convert the String secret into its byte representation assuming a UTF-8 encoding.
+     * Convert the given secret into its byte representation assuming a UTF-8 character set.
      * 
-     * @param secret the secret as a UTF-8 encoding string, must not be {@code null}.
+     * @param secret the secret.
      * 
      * @return the UTF-8 byte representation of the secret.
      */
@@ -134,13 +134,13 @@ public final class JWSAssemblyUtils {
     /**
      * Compose the message that is to be signed. 
      * 
-     * <p>From RFC7515: {@literal ASCII(BASE64URL(UTF8(JWS Protected Header)) || '.' ||
-      BASE64URL(JWS Payload)}
+     * <p>Returns a JWS Signing Input. RFC7515;
+     * {@literal ASCII(BASE64URL(UTF8(JWS Protected Header)) || '.' || BASE64URL(JWS Payload)}
      * 
      * @param header the header component of the message to be signed.
      * @param payload the payload component of the message to be signed.
      * 
-     * @return the message in its compact/serialised state ready to be signed.
+     * @return the JWS signing input ready to be signed.
      * 
      * @throws EncodingException if there is an error base64 encoding the components.
      */

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.