You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ws.apache.org by co...@apache.org on 2019/12/16 10:16:01 UTC

[ws-wss4j] 01/02: Fixing up some javadoc

This is an automated email from the ASF dual-hosted git repository.

coheigea pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ws-wss4j.git

commit f76ad80af477a12d4e9eba4e607faae9fe2670a1
Author: Colm O hEigeartaigh <co...@apache.org>
AuthorDate: Mon Dec 16 10:03:49 2019 +0000

    Fixing up some javadoc
---
 .../java/org/apache/wss4j/common/crypto/AlgorithmSuiteValidator.java  | 4 ++--
 .../main/java/org/apache/wss4j/dom/message/WSSecUsernameToken.java    | 4 +---
 .../org/apache/wss4j/dom/processor/SecurityContextTokenProcessor.java | 2 +-
 .../main/java/org/apache/wss4j/dom/processor/SignatureProcessor.java  | 2 +-
 .../src/main/java/org/apache/wss4j/dom/str/STRParserUtil.java         | 1 -
 .../org/apache/wss4j/policy/stax/enforcer/PolicyEnforcerFactory.java  | 2 +-
 6 files changed, 6 insertions(+), 9 deletions(-)

diff --git a/ws-security-common/src/main/java/org/apache/wss4j/common/crypto/AlgorithmSuiteValidator.java b/ws-security-common/src/main/java/org/apache/wss4j/common/crypto/AlgorithmSuiteValidator.java
index 36d072a..7b4ae29 100644
--- a/ws-security-common/src/main/java/org/apache/wss4j/common/crypto/AlgorithmSuiteValidator.java
+++ b/ws-security-common/src/main/java/org/apache/wss4j/common/crypto/AlgorithmSuiteValidator.java
@@ -238,7 +238,7 @@ public class AlgorithmSuiteValidator {
         if (requiredKeyLength > 0 && (derivedKeyLength / 8) != requiredKeyLength) {
             LOG.warn(
                 "The signature derived key length of " + derivedKeyLength + " does not match"
-                + "the requirement of " + requiredKeyLength
+                + " the requirement of " + requiredKeyLength
             );
         }
     }
@@ -253,7 +253,7 @@ public class AlgorithmSuiteValidator {
         if (requiredKeyLength > 0 && (derivedKeyLength / 8) != requiredKeyLength) {
             LOG.warn(
                 "The encryption derived key length of " + derivedKeyLength + " does not match"
-                + "the requirement of " + requiredKeyLength
+                + " the requirement of " + requiredKeyLength
             );
         }
     }
diff --git a/ws-security-dom/src/main/java/org/apache/wss4j/dom/message/WSSecUsernameToken.java b/ws-security-dom/src/main/java/org/apache/wss4j/dom/message/WSSecUsernameToken.java
index 51f2455..b92196e 100644
--- a/ws-security-dom/src/main/java/org/apache/wss4j/dom/message/WSSecUsernameToken.java
+++ b/ws-security-dom/src/main/java/org/apache/wss4j/dom/message/WSSecUsernameToken.java
@@ -161,8 +161,6 @@ public class WSSecUsernameToken extends WSSecBase {
      * <code>prepare()</code> all parameters such as user, password,
      * passwordType etc. must be set. A complete <code>UsernameToken</code> is
      * constructed.
-     *
-     * @param The salt value to use if we are using a derived key
      */
     public void prepare() {
         prepare(null);
@@ -224,7 +222,7 @@ public class WSSecUsernameToken extends WSSecBase {
      * <code>UsernameToken</code> is constructed and added to the
      * <code>wsse:Security</code> header.
      *
-     * @param the salt value to add if we are using a derived key
+     * @param salt the salt value to add if we are using a derived key
      * @return Document with UsernameToken added
      */
     public Document build(byte[] salt) {
diff --git a/ws-security-dom/src/main/java/org/apache/wss4j/dom/processor/SecurityContextTokenProcessor.java b/ws-security-dom/src/main/java/org/apache/wss4j/dom/processor/SecurityContextTokenProcessor.java
index a051f9d..182aeca 100644
--- a/ws-security-dom/src/main/java/org/apache/wss4j/dom/processor/SecurityContextTokenProcessor.java
+++ b/ws-security-dom/src/main/java/org/apache/wss4j/dom/processor/SecurityContextTokenProcessor.java
@@ -92,7 +92,7 @@ public class SecurityContextTokenProcessor implements Processor {
      * Get the secret from the provided callback handler and return it.
      *
      * @param cb
-     * @param sct
+     * @param identifier
      * @return The key collected using the callback handler
      */
     private byte[] getSecret(CallbackHandler cb, String identifier)
diff --git a/ws-security-dom/src/main/java/org/apache/wss4j/dom/processor/SignatureProcessor.java b/ws-security-dom/src/main/java/org/apache/wss4j/dom/processor/SignatureProcessor.java
index 47bf540..7ac544c 100644
--- a/ws-security-dom/src/main/java/org/apache/wss4j/dom/processor/SignatureProcessor.java
+++ b/ws-security-dom/src/main/java/org/apache/wss4j/dom/processor/SignatureProcessor.java
@@ -408,8 +408,8 @@ public class SignatureProcessor implements Processor {
      * Retrieve the Reference elements and set them on the ValidateContext
      * @param xmlSignature the XMLSignature object to get the references from
      * @param context the ValidateContext
+     * @param data The RequestData object
      * @param wsDocInfo the WSDocInfo object where tokens are stored
-     * @param doc the owner document from which to find elements
      * @throws WSSecurityException
      */
     private void setElementsOnContext(
diff --git a/ws-security-dom/src/main/java/org/apache/wss4j/dom/str/STRParserUtil.java b/ws-security-dom/src/main/java/org/apache/wss4j/dom/str/STRParserUtil.java
index 9f22d11..f7730c2 100644
--- a/ws-security-dom/src/main/java/org/apache/wss4j/dom/str/STRParserUtil.java
+++ b/ws-security-dom/src/main/java/org/apache/wss4j/dom/str/STRParserUtil.java
@@ -64,7 +64,6 @@ public final class STRParserUtil {
      * @param secRef the SecurityTokenReference to the SAML Assertion
      * @param strElement The SecurityTokenReference DOM element
      * @param request The RequestData instance used to obtain configuration
-     * @param wsDocInfo The WSDocInfo object that holds previous results
      * @return an SamlAssertionWrapper object
      * @throws WSSecurityException
      */
diff --git a/ws-security-policy-stax/src/main/java/org/apache/wss4j/policy/stax/enforcer/PolicyEnforcerFactory.java b/ws-security-policy-stax/src/main/java/org/apache/wss4j/policy/stax/enforcer/PolicyEnforcerFactory.java
index 1c3a33e..6402ca6 100644
--- a/ws-security-policy-stax/src/main/java/org/apache/wss4j/policy/stax/enforcer/PolicyEnforcerFactory.java
+++ b/ws-security-policy-stax/src/main/java/org/apache/wss4j/policy/stax/enforcer/PolicyEnforcerFactory.java
@@ -431,7 +431,7 @@ public class PolicyEnforcerFactory {
      * @param roleOrActor The actor or role of the security processing. Must be set to the same value
      * as WSSSecurityProperties#setActor()
      * @param attachmentCount The number of Attachments received in the message
-     * @param Whether we are using SOAP 1.2 or not
+     * @param soap12 Whether we are using SOAP 1.2 or not
      * @return the newly created PolicyEnforcer instance
      * @throws WSSPolicyException
      */