Author: coheigea
Date: Wed Oct 30 11:13:21 2013
New Revision: 1537040
URL: http://svn.apache.org/r1537040
Log:
More javadoc fixes
Modified:
webservices/wss4j/trunk/ws-security-common/src/main/java/org/apache/wss4j/common/ConfigurationConstants.java
webservices/wss4j/trunk/ws-security-common/src/main/java/org/apache/wss4j/common/crypto/CryptoFactory.java
webservices/wss4j/trunk/ws-security-common/src/main/java/org/apache/wss4j/common/ext/WSPasswordCallback.java
webservices/wss4j/trunk/ws-security-dom/src/main/java/org/apache/wss4j/dom/message/token/DerivedKeyToken.java
Modified:
webservices/wss4j/trunk/ws-security-common/src/main/java/org/apache/wss4j/common/ConfigurationConstants.java
URL:
http://svn.apache.org/viewvc/webservices/wss4j/trunk/ws-security-common/src/main/java/org/apache/wss4j/common/ConfigurationConstants.java?rev=1537040&r1=1537039&r2=1537040&view=diff
==============================================================================
---
webservices/wss4j/trunk/ws-security-common/src/main/java/org/apache/wss4j/common/ConfigurationConstants.java
(original)
+++
webservices/wss4j/trunk/ws-security-common/src/main/java/org/apache/wss4j/common/ConfigurationConstants.java
Wed Oct 30 11:13:21 2013
@@ -541,9 +541,9 @@ public final class ConfigurationConstant
* Specific parameter for UsernameTokens to define the encoding of the
password. It can
* be used on either the outbound or inbound side. The valid values are:
*
- * - {@link WSConstants#PW_DIGEST}
- * - {@link WSConstants#PW_TEXT}
- * - {@link WSConstants#PW_NONE}
+ * - PasswordDigest
+ * - PasswordText
+ * - PasswordNone
*
* On the Outbound side, the default value is PW_DIGEST. There is no
default value on
* the inbound side. If a value is specified on the inbound side, the
password type of
@@ -554,8 +554,8 @@ public final class ConfigurationConstant
/**
* Defines which key identifier type to use for signature. The WS-Security
specifications
- * recommends to use the identifier type <code>IssuerSerial</code>. For
possible signature
- * key identifier types refer to {@link #getKeyIdentifier(String)}.
+ * recommends to use the identifier type <code>IssuerSerial</code>.
+ *
* For signature <code>IssuerSerial</code>, <code>DirectReference</code>,
* <code>X509KeyIdentifier</code>, <code>Thumbprint</code>,
<code>SKIKeyIdentifier</code>
* and <code>KeyValue</code> are valid only.
@@ -650,10 +650,8 @@ public final class ConfigurationConstant
/**
* Defines which key identifier type to use for encryption. The
WS-Security specifications
- * recommends to use the identifier type <code>IssuerSerial</code>. For
- * possible encryption key identifier types refer to
- * {@link #getKeyIdentifier(String)}. For encryption
<code>IssuerSerial</code>,
- * <code>DirectReference</code>, <code>X509KeyIdentifier</code>,
+ * recommends to use the identifier type <code>IssuerSerial</code>. For
encryption
+ * <code>IssuerSerial</code>, <code>DirectReference</code>,
<code>X509KeyIdentifier</code>,
* <code>Thumbprint</code>, <code>SKIKeyIdentifier</code>,
<code>EncryptedKeySHA1</code>
* and <code>EmbeddedKeyName</code> are valid only.
* <p/>
@@ -668,11 +666,15 @@ public final class ConfigurationConstant
/**
* Defines which symmetric encryption algorithm to use. WSS4J supports the
- * following algorithms: {@link WSConstants#TRIPLE_DES},
- * {@link WSConstants#AES_128}, {@link WSConstants#AES_256},
- * and {@link WSConstants#AES_192}. Except for AES 192 all of these
- * algorithms are required by the XML Encryption specification.
- * The default algorithm is:
+ * following algorithms:
+ *
+ * "http://www.w3.org/2001/04/xmlenc#tripledes-cbc";;
+ * "http://www.w3.org/2001/04/xmlenc#aes128-cbc";;
+ * "http://www.w3.org/2001/04/xmlenc#aes256-cbc";;
+ * "http://www.w3.org/2001/04/xmlenc#aes192-cbc";;
+ *
+ * Except for AES 192 all of these algorithms are required by the XML
Encryption
+ * specification. The default algorithm is:
*
* "http://www.w3.org/2001/04/xmlenc#aes128-cbc";
*
Modified:
webservices/wss4j/trunk/ws-security-common/src/main/java/org/apache/wss4j/common/crypto/CryptoFactory.java
URL:
http://svn.apache.org/viewvc/webservices/wss4j/trunk/ws-security-common/src/main/java/org/apache/wss4j/common/crypto/CryptoFactory.java?rev=1537040&r1=1537039&r2=1537040&view=diff
==============================================================================
---
webservices/wss4j/trunk/ws-security-common/src/main/java/org/apache/wss4j/common/crypto/CryptoFactory.java
(original)
+++
webservices/wss4j/trunk/ws-security-common/src/main/java/org/apache/wss4j/common/crypto/CryptoFactory.java
Wed Oct 30 11:13:21 2013
@@ -257,7 +257,7 @@ public abstract class CryptoFactory {
* This allows loading the resources with a custom class loader
* @param propFilename
* @param loader
- * @return
+ * @return a Properties object loaded from the propFilename argument
* @throws WSSecurityException if there is an error in loading the crypto
properties
*/
public static Properties getProperties(
Modified:
webservices/wss4j/trunk/ws-security-common/src/main/java/org/apache/wss4j/common/ext/WSPasswordCallback.java
URL:
http://svn.apache.org/viewvc/webservices/wss4j/trunk/ws-security-common/src/main/java/org/apache/wss4j/common/ext/WSPasswordCallback.java?rev=1537040&r1=1537039&r2=1537040&view=diff
==============================================================================
---
webservices/wss4j/trunk/ws-security-common/src/main/java/org/apache/wss4j/common/ext/WSPasswordCallback.java
(original)
+++
webservices/wss4j/trunk/ws-security-common/src/main/java/org/apache/wss4j/common/ext/WSPasswordCallback.java
Wed Oct 30 11:13:21 2013
@@ -145,7 +145,7 @@ public class WSPasswordCallback implemen
* Set the Key.
* <p/>
*
- * @param key is the key associated to the identifier
+ * @param secret
*/
public void setKey(byte[] secret) {
this.secret = secret;
Modified:
webservices/wss4j/trunk/ws-security-dom/src/main/java/org/apache/wss4j/dom/message/token/DerivedKeyToken.java
URL:
http://svn.apache.org/viewvc/webservices/wss4j/trunk/ws-security-dom/src/main/java/org/apache/wss4j/dom/message/token/DerivedKeyToken.java?rev=1537040&r1=1537039&r2=1537040&view=diff
==============================================================================
---
webservices/wss4j/trunk/ws-security-dom/src/main/java/org/apache/wss4j/dom/message/token/DerivedKeyToken.java
(original)
+++
webservices/wss4j/trunk/ws-security-dom/src/main/java/org/apache/wss4j/dom/message/token/DerivedKeyToken.java
Wed Oct 30 11:13:21 2013
@@ -100,7 +100,7 @@ public class DerivedKeyToken {
* This will create a DerivedKeyToken object with the given
DerivedKeyToken element
*
* @param elem The DerivedKeyToken DOM element
- * @param bspCompliant whether the DerivedKeyToken processing complies
with the BSP spec
+ * @param bspEnforcer a BSPEnforcer instance to enforce BSP rules
* @throws WSSecurityException If the element is not a derived key token
*/
public DerivedKeyToken(Element elem, BSPEnforcer bspEnforcer) throws
WSSecurityException {
