Author: coheigea
Date: Wed Mar 9 12:31:54 2011
New Revision: 1079776
URL: http://svn.apache.org/viewvc?rev=1079776&view=rev
Log:
Javadoc fixes.
Modified:
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/WSPasswordCallback.java
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/handler/RequestData.java
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/processor/UsernameTokenProcessor.java
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/saml/SAMLUtil.java
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/str/DerivedKeyTokenSTRParser.java
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/str/EncryptedKeySTRParser.java
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/str/STRParser.java
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/str/SecurityTokenRefSTRParser.java
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/str/SignatureSTRParser.java
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/NoOpValidator.java
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/SamlAssertionValidator.java
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/SignatureTrustValidator.java
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/TimestampValidator.java
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/UsernameTokenValidator.java
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/Validator.java
Modified:
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/WSPasswordCallback.java
URL:
http://svn.apache.org/viewvc/webservices/wss4j/trunk/src/main/java/org/apache/ws/security/WSPasswordCallback.java?rev=1079776&r1=1079775&r2=1079776&view=diff
==============================================================================
---
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/WSPasswordCallback.java
(original)
+++
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/WSPasswordCallback.java
Wed Mar 9 12:31:54 2011
@@ -243,7 +243,7 @@ public class WSPasswordCallback implemen
/**
* Returns the RequestData associated with the request
- * @return
+ * @return the RequestData associated with the request
*/
public RequestData getRequestData() {
return data;
Modified:
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/handler/RequestData.java
URL:
http://svn.apache.org/viewvc/webservices/wss4j/trunk/src/main/java/org/apache/ws/security/handler/RequestData.java?rev=1079776&r1=1079775&r2=1079776&view=diff
==============================================================================
---
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/handler/RequestData.java
(original)
+++
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/handler/RequestData.java
Wed Mar 9 12:31:54 2011
@@ -392,12 +392,18 @@ public class RequestData {
/**
* Returns the CallbackHandler used for this request.
- * @return
+ * @return the CallbackHandler used for this request.
*/
public CallbackHandler getCallbackHandler() {
return callback;
}
+ /**
+ * Get the Validator instance corresponding to the QName
+ * @param qName the QName with which to find a Validator instance
+ * @return the Validator instance corresponding to the QName
+ * @throws WSSecurityException
+ */
public Validator getValidator(QName qName) throws WSSecurityException {
if (wssConfig != null) {
return wssConfig.getValidator(qName);
Modified:
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/processor/UsernameTokenProcessor.java
URL:
http://svn.apache.org/viewvc/webservices/wss4j/trunk/src/main/java/org/apache/ws/security/processor/UsernameTokenProcessor.java?rev=1079776&r1=1079775&r2=1079776&view=diff
==============================================================================
---
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/processor/UsernameTokenProcessor.java
(original)
+++
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/processor/UsernameTokenProcessor.java
Wed Mar 9 12:31:54 2011
@@ -74,7 +74,7 @@ public class UsernameTokenProcessor impl
* Check the UsernameToken element and validate it.
*
* @param token the DOM element that contains the UsernameToken
- * @param wssConfig The WSSConfig object from which to obtain configuration
+ * @param data The RequestData object from which to obtain configuration
* @return UsernameToken the UsernameToken object that was parsed
* @throws WSSecurityException
*/
Modified:
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/saml/SAMLUtil.java
URL:
http://svn.apache.org/viewvc/webservices/wss4j/trunk/src/main/java/org/apache/ws/security/saml/SAMLUtil.java?rev=1079776&r1=1079775&r2=1079776&view=diff
==============================================================================
---
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/saml/SAMLUtil.java
(original)
+++
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/saml/SAMLUtil.java
Wed Mar 9 12:31:54 2011
@@ -65,10 +65,8 @@ public class SAMLUtil {
*
* @param secRef the SecurityTokenReference to the SAML Assertion
* @param strElement The SecurityTokenReference DOM element
- * @param crypto The Crypto instance to use to obtain certificates
- * @param cb The CallbackHandler instance used for secret keys
+ * @param request The RequestData instance used to obtain configuration
* @param wsDocInfo The WSDocInfo object that holds previous results
- * @param config The WSSConfig object used to access configuration
* @return an AssertionWrapper object
* @throws WSSecurityException
*/
@@ -118,11 +116,10 @@ public class SAMLUtil {
* the Subject of the assertion
*
* @param assertion The SAML Assertion
- * @param crypto The Crypto instance to use to obtain certificates
- * @param cb The CallbackHandler instance used for secret keys
+ * @param data The RequestData instance used to obtain configuration
* @param docInfo A WSDocInfo instance
- * @return a SAMLKeyInfo object
* @param bspCompliant Whether to process tokens in compliance with the
BSP spec or not
+ * @return a SAMLKeyInfo object
* @throws WSSecurityException
*/
public static SAMLKeyInfo getCredentialFromSubject(
@@ -166,8 +163,7 @@ public class SAMLUtil {
* Get the SAMLKeyInfo object corresponding to the credential stored in
the Subject of a
* SAML 1.1 assertion
* @param assertion The SAML 1.1 assertion
- * @param crypto The crypto instance used to get the credential
- * @param cb The CallbackHandler used for secret keys
+ * @param data The RequestData instance used to obtain configuration
* @param docInfo A WSDocInfo instance
* @param bspCompliant Whether to process tokens in compliance with the
BSP spec or not
* @return The SAMLKeyInfo object obtained from the Subject
@@ -224,8 +220,7 @@ public class SAMLUtil {
* Get the SAMLKeyInfo object corresponding to the credential stored in
the Subject of a
* SAML 2 assertion
* @param assertion The SAML 2 assertion
- * @param crypto The crypto instance used to get the credential
- * @param cb The CallbackHandler used for secret keys
+ * @param data The RequestData instance used to obtain configuration
* @param docInfo A WSDocInfo instance
* @param bspCompliant Whether to process tokens in compliance with the
BSP spec or not
* @return The SAMLKeyInfo object obtained from the Subject
@@ -270,8 +265,7 @@ public class SAMLUtil {
* This method returns a SAMLKeyInfo corresponding to the credential found
in the
* KeyInfo (DOM Element) argument.
* @param keyInfoElement The KeyInfo as a DOM Element
- * @param crypto The crypto instance
- * @param cb The CallbackHandler used for secret keys
+ * @param data The RequestData instance used to obtain configuration
* @param docInfo A WSDocInfo instance
* @param bspCompliant Whether to process tokens in compliance with the
BSP spec or not
* @return The credential (as a SAMLKeyInfo object)
Modified:
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/str/DerivedKeyTokenSTRParser.java
URL:
http://svn.apache.org/viewvc/webservices/wss4j/trunk/src/main/java/org/apache/ws/security/str/DerivedKeyTokenSTRParser.java?rev=1079776&r1=1079775&r2=1079776&view=diff
==============================================================================
---
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/str/DerivedKeyTokenSTRParser.java
(original)
+++
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/str/DerivedKeyTokenSTRParser.java
Wed Mar 9 12:31:54 2011
@@ -54,10 +54,8 @@ public class DerivedKeyTokenSTRParser im
* Parse a SecurityTokenReference element and extract credentials.
*
* @param strElement The SecurityTokenReference element
- * @param crypto The crypto instance used to extract credentials
- * @param cb The CallbackHandler instance to supply passwords
+ * @param data the RequestData associated with the request
* @param wsDocInfo The WSDocInfo object to access previous processing
results
- * @param config The WSSConfig object used to access configuration
* @param parameters A set of implementation-specific parameters
* @throws WSSecurityException
*/
Modified:
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/str/EncryptedKeySTRParser.java
URL:
http://svn.apache.org/viewvc/webservices/wss4j/trunk/src/main/java/org/apache/ws/security/str/EncryptedKeySTRParser.java?rev=1079776&r1=1079775&r2=1079776&view=diff
==============================================================================
---
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/str/EncryptedKeySTRParser.java
(original)
+++
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/str/EncryptedKeySTRParser.java
Wed Mar 9 12:31:54 2011
@@ -58,10 +58,8 @@ public class EncryptedKeySTRParser imple
* Parse a SecurityTokenReference element and extract credentials.
*
* @param strElement The SecurityTokenReference element
- * @param crypto The crypto instance used to extract credentials
- * @param cb The CallbackHandler instance to supply passwords
+ * @param data the RequestData associated with the request
* @param wsDocInfo The WSDocInfo object to access previous processing
results
- * @param config The WSSConfig object used to access configuration
* @param parameters A set of implementation-specific parameters
* @throws WSSecurityException
*/
Modified:
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/str/STRParser.java
URL:
http://svn.apache.org/viewvc/webservices/wss4j/trunk/src/main/java/org/apache/ws/security/str/STRParser.java?rev=1079776&r1=1079775&r2=1079776&view=diff
==============================================================================
---
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/str/STRParser.java
(original)
+++
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/str/STRParser.java
Wed Mar 9 12:31:54 2011
@@ -40,10 +40,8 @@ public interface STRParser {
* Parse a SecurityTokenReference element and extract credentials.
*
* @param strElement The SecurityTokenReference element
- * @param crypto The crypto instance used to extract credentials
- * @param cb The CallbackHandler instance to supply passwords
+ * @param data the RequestData associated with the request
* @param wsDocInfo The WSDocInfo object to access previous processing
results
- * @param config The WSSConfig object used to access configuration
* @param parameters A set of implementation-specific parameters
* @throws WSSecurityException
*/
Modified:
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/str/SecurityTokenRefSTRParser.java
URL:
http://svn.apache.org/viewvc/webservices/wss4j/trunk/src/main/java/org/apache/ws/security/str/SecurityTokenRefSTRParser.java?rev=1079776&r1=1079775&r2=1079776&view=diff
==============================================================================
---
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/str/SecurityTokenRefSTRParser.java
(original)
+++
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/str/SecurityTokenRefSTRParser.java
Wed Mar 9 12:31:54 2011
@@ -59,10 +59,8 @@ public class SecurityTokenRefSTRParser i
* Parse a SecurityTokenReference element and extract credentials.
*
* @param strElement The SecurityTokenReference element
- * @param crypto The crypto instance used to extract credentials
- * @param cb The CallbackHandler instance to supply passwords
+ * @param data the RequestData associated with the request
* @param wsDocInfo The WSDocInfo object to access previous processing
results
- * @param config The WSSConfig object used to access configuration
* @param parameters A set of implementation-specific parameters
* @throws WSSecurityException
*/
Modified:
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/str/SignatureSTRParser.java
URL:
http://svn.apache.org/viewvc/webservices/wss4j/trunk/src/main/java/org/apache/ws/security/str/SignatureSTRParser.java?rev=1079776&r1=1079775&r2=1079776&view=diff
==============================================================================
---
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/str/SignatureSTRParser.java
(original)
+++
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/str/SignatureSTRParser.java
Wed Mar 9 12:31:54 2011
@@ -81,10 +81,8 @@ public class SignatureSTRParser implemen
* Parse a SecurityTokenReference element and extract credentials.
*
* @param strElement The SecurityTokenReference element
- * @param crypto The crypto instance used to extract credentials
- * @param cb The CallbackHandler instance to supply passwords
+ * @param data the RequestData associated with the request
* @param wsDocInfo The WSDocInfo object to access previous processing
results
- * @param config The WSSConfig object used to access configuration
* @param parameters A set of implementation-specific parameters
* @throws WSSecurityException
*/
Modified:
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/NoOpValidator.java
URL:
http://svn.apache.org/viewvc/webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/NoOpValidator.java?rev=1079776&r1=1079775&r2=1079776&view=diff
==============================================================================
---
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/NoOpValidator.java
(original)
+++
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/NoOpValidator.java
Wed Mar 9 12:31:54 2011
@@ -32,7 +32,7 @@ public class NoOpValidator implements Va
* Validate the credential argument.
*
* @param credential the Credential to be validated
- * @param RequestData associated with the request
+ * @param data the RequestData associated with the request
* @throws WSSecurityException on a failed validation
*/
public Credential validate(Credential credential, RequestData data) throws
WSSecurityException {
Modified:
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/SamlAssertionValidator.java
URL:
http://svn.apache.org/viewvc/webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/SamlAssertionValidator.java?rev=1079776&r1=1079775&r2=1079776&view=diff
==============================================================================
---
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/SamlAssertionValidator.java
(original)
+++
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/SamlAssertionValidator.java
Wed Mar 9 12:31:54 2011
@@ -41,7 +41,7 @@ public class SamlAssertionValidator exte
* A Crypto and a CallbackHandler implementation is also required to be
set.
*
* @param credential the Credential to be validated
- * @param RequestData associated with the request
+ * @param data the RequestData associated with the request
* @throws WSSecurityException on a failed validation
*/
public Credential validate(Credential credential, RequestData data) throws
WSSecurityException {
Modified:
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/SignatureTrustValidator.java
URL:
http://svn.apache.org/viewvc/webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/SignatureTrustValidator.java?rev=1079776&r1=1079775&r2=1079776&view=diff
==============================================================================
---
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/SignatureTrustValidator.java
(original)
+++
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/SignatureTrustValidator.java
Wed Mar 9 12:31:54 2011
@@ -49,6 +49,7 @@ public class SignatureTrustValidator imp
* this is not successful, then it will attempt to verify trust on the
Public Key.
*
* @param credential the Credential to be validated
+ * @param data the RequestData associated with the request
* @throws WSSecurityException on a failed validation
*/
public Credential validate(Credential credential, RequestData data) throws
WSSecurityException {
Modified:
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/TimestampValidator.java
URL:
http://svn.apache.org/viewvc/webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/TimestampValidator.java?rev=1079776&r1=1079775&r2=1079776&view=diff
==============================================================================
---
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/TimestampValidator.java
(original)
+++
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/TimestampValidator.java
Wed Mar 9 12:31:54 2011
@@ -35,7 +35,7 @@ public class TimestampValidator implemen
* Validate the credential argument. It must contain a non-null Timestamp.
*
* @param credential the Credential to be validated
- * @param RequestData associated with the request
+ * @param data the RequestData associated with the request
* @throws WSSecurityException on a failed validation
*/
public Credential validate(Credential credential, RequestData data) throws
WSSecurityException {
Modified:
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/UsernameTokenValidator.java
URL:
http://svn.apache.org/viewvc/webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/UsernameTokenValidator.java?rev=1079776&r1=1079775&r2=1079776&view=diff
==============================================================================
---
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/UsernameTokenValidator.java
(original)
+++
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/UsernameTokenValidator.java
Wed Mar 9 12:31:54 2011
@@ -53,7 +53,7 @@ public class UsernameTokenValidator impl
* of this type.
*
* @param credential the Credential to be validated
- * @param RequestData associated with the request
+ * @param data the RequestData associated with the request
* @throws WSSecurityException on a failed validation
*/
public Credential validate(Credential credential, RequestData data) throws
WSSecurityException {
Modified:
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/Validator.java
URL:
http://svn.apache.org/viewvc/webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/Validator.java?rev=1079776&r1=1079775&r2=1079776&view=diff
==============================================================================
---
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/Validator.java
(original)
+++
webservices/wss4j/trunk/src/main/java/org/apache/ws/security/validate/Validator.java
Wed Mar 9 12:31:54 2011
@@ -35,7 +35,7 @@ public interface Validator {
* that was validated, or it can represent some transformation of the
initial Credential
* instance.
* @param credential the Credential to be validated
- * @param RequestData associated with the request
+ * @param data the RequestData associated with the request
* @return a validated Credential
* @throws WSSecurityException on a failed validation
*/
