You are viewing a plain text version of this content. The canonical link for it is here.
Posted to fx-dev@ws.apache.org by "Granqvist, Hans" <hg...@verisign.com> on 2005/09/13 00:23:29 UTC
javadoc patch
Here is a simple patch for fixing current javadoc wss4j errors.
I simply tagged missing params with 'TODO' and fixed obvious
mistakes.
Any takers? (Don't think I have commit privs on wss4j)
Thanks,
Hans
--start--
Index: src/org/apache/ws/axis/security/package.html
===================================================================
--- src/org/apache/ws/axis/security/package.html (revision
280420)
+++ src/org/apache/ws/axis/security/package.html (working copy)
@@ -584,9 +584,9 @@
checks if all required actions were performed. If this check fails, the
WSS4J handler aborts the SOAP request and throws an Axis SOAP fault.
Otherwise it creates its own data structure
-{@link org.apache.ws.axis.security.WSDoAllReceiverResult}, copies the
+{@link org.apache.ws.security.handler.WSHandlerResult}, copies the
security results in this structure, and adds the actor name of the
-security header. The it stores this new data structure in a vector and
stores
+security header. Then it stores this new data structure in a vector and
stores
this vector in a specific
{@link org.apache.ws.security.handler.WSHandlerConstants#RECV_RESULTS
property}
of the current message context. If WSS4J handlers are
Index: src/org/apache/ws/security/WSSConfig.java
===================================================================
--- src/org/apache/ws/security/WSSConfig.java (revision 280420)
+++ src/org/apache/ws/security/WSSConfig.java (working copy)
@@ -99,7 +99,7 @@
/**
* Checks if we are in WS-I Basic Security Profile compliance mode
*
- * @return
+ * @return TODO
*/
public boolean isWsiBSPCompliant() {
return wsiBSPCompliant;
@@ -118,7 +118,7 @@
/**
* Checks if we need to use milliseconds in timestamps
*
- * @return
+ * @return TODO
*/
public boolean isPrecisionInMilliSeconds() {
return precisionInMilliSeconds;
@@ -127,7 +127,7 @@
/**
* Set the precision in milliseconds
*
- * @param wsiBSPCompliant
+ * @param precisionInMilliSeconds TODO
*/
public void setPrecisionInMilliSeconds(boolean
precisionInMilliSeconds) {
this.precisionInMilliSeconds = precisionInMilliSeconds;
Index: src/org/apache/ws/security/message/token/UsernameToken.java
===================================================================
--- src/org/apache/ws/security/message/token/UsernameToken.java
(revision 280420)
+++ src/org/apache/ws/security/message/token/UsernameToken.java (working
copy)
@@ -76,7 +76,6 @@
* Constructs a <code>UsernameToken</code> object and parses the
* <code>wsse:UsernameToken</code> element to initialize it.
*
- * @param wssConfig Configuration options for processing and
building the <code>wsse:Security</code> header
* @param elem the <code>wsse:UsernameToken</code> element
that
* contains the UsernameToken data
* @throws WSSecurityException
@@ -113,7 +112,6 @@
* This constructes set the password encoding to
* {@link WSConstants#PASSWORD_DIGEST}
*
- * @param wssConfig Configuration options for processing and
building the <code>wsse:Security</code> header
* @param doc the SOAP envelope as <code>Document</code>
*/
public UsernameToken(boolean milliseconds, Document doc) {
@@ -125,9 +123,8 @@
* to the defined parameters.
* <p/>
*
- * @param wssConfig Configuration options for processing and
building the <code>wsse:Security</code> header
* @param doc the SOAP envelope as <code>Document</code>
- * @param passwordType the required password encoding, either
+ * @param pwType the required password encoding, either
* {@link WSConstants#PASSWORD_DIGEST} or
* {@link WSConstants#PASSWORD_TEXT}
*/
Index: src/org/apache/ws/security/message/token/Timestamp.java
===================================================================
--- src/org/apache/ws/security/message/token/Timestamp.java
(revision 280420)
+++ src/org/apache/ws/security/message/token/Timestamp.java (working
copy)
@@ -56,7 +56,7 @@
* Constructs a <code>Timestamp</code> object and parses the
* <code>wsu:Timestamp</code> element to initialize it.
*
- * @param elem the <code>wsu:Timestamp</code> element that
+ * @param element the <code>wsu:Timestamp</code> element that
* contains the timestamp data
*/
public Timestamp(Element element) throws WSSecurityException {
@@ -221,7 +221,7 @@
/**
* Returns the value of the wsu:Id attribute
- * @return
+ * @return TODO
*/
public String getID() {
return this.element.getAttributeNS(WSConstants.WSU_NS, "Id");
Index:
src/org/apache/ws/security/message/token/SecurityTokenReference.java
===================================================================
--- src/org/apache/ws/security/message/token/SecurityTokenReference.java
(revision 280420)
+++ src/org/apache/ws/security/message/token/SecurityTokenReference.java
(working copy)
@@ -62,8 +62,7 @@
* Constructor.
* <p/>
*
- * @param wssConfig
- * @param elem
+ * @param elem TODO
* @throws WSSecurityException
*/
public SecurityTokenReference(Element elem) throws
WSSecurityException {
@@ -86,8 +85,7 @@
* Constructor.
* <p/>
*
- * @param wssConfig
- * @param doc
+ * @param doc TODO
*/
public SecurityTokenReference(Document doc) {
doDebug = log.isDebugEnabled();
@@ -250,9 +248,6 @@
*
* @param cert
* is the X509 certficate to get the thumbprint
- * @param crypto
- * is the Crypto implementation. Used to read SKI info
bytes from
- * certificate
*/
public void setKeyIdentifierThumb(X509Certificate cert)
throws WSSecurityException {
@@ -598,7 +593,7 @@
* get the dom element.
* <p/>
*
- * @return
+ * @return TODO
*/
public Element getElement() {
return this.element;
@@ -622,7 +617,7 @@
* return the string representation.
* <p/>
*
- * @return
+ * @return TODO
*/
public String toString() {
return DOM2Writer.nodeToString((Node) this.element);
Index:
src/org/apache/ws/security/message/token/SignatureConfirmation.java
===================================================================
--- src/org/apache/ws/security/message/token/SignatureConfirmation.java
(revision 280420)
+++ src/org/apache/ws/security/message/token/SignatureConfirmation.java
(working copy)
@@ -60,8 +60,8 @@
* <p/> * * @param doc the SOAP envelope as
<code>Document</code> - * @param the Signature value as byte[] of
<code>null</code> if no value - * available. + * @param
signVal the Signature value as byte[] of <code>null</code> + * if
no value available. */ public SignatureConfirmation(Document
doc, byte[] signVal) { @@ -110,7 +110,7 @@
/** * Returns the value of the wsu:Id attribute - *
@return + * @return TODO */ public String getID() {
return this.element.getAttributeNS(WSConstants.WSU_NS, "Id"); Index:
src/org/apache/ws/security/message/token/BinarySecurity.java
===================================================================
--- src/org/apache/ws/security/message/token/BinarySecurity.java
(revision 280420)
+++ src/org/apache/ws/security/message/token/BinarySecurity.java
(working copy)
@@ -77,7 +77,7 @@
* get the value type.
* <p/>
*
- * @return
+ * @return TODO
*/
public String getValueType() {
return this.element.getAttribute("ValueType");
@@ -97,7 +97,7 @@
* get the encoding type.
* <p/>
*
- * @return
+ * @return TODO
*/
public String getEncodingType() {
return this.element.getAttribute("EncodingType");
@@ -117,7 +117,7 @@
* get the byte array containing token information.
* <p/>
*
- * @return
+ * @return TODO
*/
public byte[] getToken() {
Text node = getFirstNode();
@@ -149,7 +149,7 @@
* return the first text node.
* <p/>
*
- * @return
+ * @return TODO
*/
protected Text getFirstNode() {
Node node = this.element.getFirstChild();
@@ -160,7 +160,7 @@
* return the dom element.
* <p/>
*
- * @return
+ * @return TODO
*/
public Element getElement() {
return this.element;
@@ -170,7 +170,7 @@
* get the id.
* <p/>
*
- * @return
+ * @return TODO
*/
public String getID() {
return this.element.getAttributeNS(WSConstants.WSU_NS, "Id");
@@ -191,7 +191,7 @@
* return the string representation of the token.
* <p/>
*
- * @return
+ * @return TODO
*/
public String toString() {
return DOM2Writer.nodeToString((Node) this.element);
Index: src/org/apache/ws/security/message/token/X509Security.java
===================================================================
--- src/org/apache/ws/security/message/token/X509Security.java
(revision 280420)
+++ src/org/apache/ws/security/message/token/X509Security.java (working
copy)
@@ -45,7 +45,6 @@
* This constructor creates a new X509 certificate object and
initializes
* it from the data containe in the element.
*
- * @param wssConfig Configuration options for processing and
building the <code>wsse:Security</code> header
* @param elem the element containing the X509 certificate
data
* @throws WSSecurityException
*/
Index: src/org/apache/ws/security/message/token/Reference.java
===================================================================
--- src/org/apache/ws/security/message/token/Reference.java
(revision 280420)
+++ src/org/apache/ws/security/message/token/Reference.java (working
copy)
@@ -80,7 +80,7 @@
* get the dom element.
* <p/>
*
- * @return
+ * @return TODO
*/
public Element getElement() {
return this.element;
@@ -90,7 +90,7 @@
* get the URI.
* <p/>
*
- * @return
+ * @return TODO
*/
public String getValueType() {
return this.element.getAttribute("ValueType");
@@ -100,7 +100,7 @@
* get the URI.
* <p/>
*
- * @return
+ * @return TODO
*/
public String getURI() {
return this.element.getAttribute("URI");
@@ -130,7 +130,7 @@
* return the string representation.
* <p/>
*
- * @return
+ * @return TODO
*/
public String toString() {
return DOM2Writer.nodeToString((Node) this.element);
Index: src/org/apache/ws/security/message/WSSAddSAMLToken.java
===================================================================
--- src/org/apache/ws/security/message/WSSAddSAMLToken.java
(revision 280420)
+++ src/org/apache/ws/security/message/WSSAddSAMLToken.java (working
copy)
@@ -70,7 +70,7 @@
* <code>wsse:Security</code> header.
*
* @param doc The SOAP enevlope as W3C document
- * @param username The username to set in the UsernameToken
+ * @param assertion TODO
* @return Document with UsernameToken added
*/
public Document build(Document doc, SAMLAssertion assertion) {
Index: src/org/apache/ws/security/message/WSAddTimestamp.java
===================================================================
--- src/org/apache/ws/security/message/WSAddTimestamp.java
(revision 280420)
+++ src/org/apache/ws/security/message/WSAddTimestamp.java (working
copy)
@@ -110,7 +110,7 @@
/**
* Get the wsu:Id value of the Timestamp
*
- * @return
+ * @return TODO
*/
public String getId() {
return id;
Index: src/org/apache/ws/security/message/WSSAddUsernameToken.java
===================================================================
--- src/org/apache/ws/security/message/WSSAddUsernameToken.java
(revision 280420)
+++ src/org/apache/ws/security/message/WSSAddUsernameToken.java (working
copy)
@@ -111,7 +111,7 @@
}
/**
* get the id
- * @return
+ * @return TODO
*/
public String getId() {
return id;
Index: src/org/apache/ws/security/message/WSSignEnvelope.java
===================================================================
--- src/org/apache/ws/security/message/WSSignEnvelope.java
(revision 280420)
+++ src/org/apache/ws/security/message/WSSignEnvelope.java (working
copy)
@@ -125,7 +125,7 @@
/**
* Get the single cert flag.
*
- * @return
+ * @return TODO
*/
public boolean isUseSingleCertificate() {
return this.useSingleCert;
@@ -181,7 +181,7 @@
* If the canonicalization method was not set then Exclusive XML
* Canonicalization is used by default.
*
- * @return
+ * @return TODO
*/
public String getSigCanonicalization() {
return canonAlgo;
Index: src/org/apache/ws/security/message/WSBaseMessage.java
===================================================================
--- src/org/apache/ws/security/message/WSBaseMessage.java
(revision 280420)
+++ src/org/apache/ws/security/message/WSBaseMessage.java (working
copy)
@@ -104,7 +104,7 @@
* Set which parts of the message to encrypt/sign.
* <p/>
*
- * @param act The vector containing the WSEncryptionPart objects
+ * @param parts The vector containing the WSEncryptionPart objects
*/
public void setParts(Vector parts) {
this.parts = parts;
Index: src/org/apache/ws/security/message/EnvelopeIdResolver.java
===================================================================
--- src/org/apache/ws/security/message/EnvelopeIdResolver.java
(revision 280420)
+++ src/org/apache/ws/security/message/EnvelopeIdResolver.java (working
copy)
@@ -56,7 +56,7 @@
* Singleton instance of the resolver.
* <p/>
*
- * @return
+ * @return TODO
*/
public synchronized static ResourceResolverSpi getInstance() {
if (resolver == null) {
@@ -74,7 +74,7 @@
*
* @param uri
* @param BaseURI
- * @return
+ * @return TODO
* @throws ResourceResolverException
*/
public XMLSignatureInput engineResolve(Attr uri, String BaseURI)
@@ -168,7 +168,7 @@
*
* @param uri
* @param BaseURI
- * @return
+ * @return TODO
*/
public boolean engineCanResolve(Attr uri, String BaseURI) {
if (uri == null) {
Index: src/org/apache/ws/security/message/WSEncryptBody.java
===================================================================
--- src/org/apache/ws/security/message/WSEncryptBody.java
(revision 280420)
+++ src/org/apache/ws/security/message/WSEncryptBody.java (working
copy)
@@ -134,8 +134,8 @@
* algorithm.
*
* @param keyEnc specifies the key encoding algorithm.
- * @see WSConstants.KEYTRANSPORT_RSA15
- * @see WSConstants.KEYTRANSPORT_RSAOEP
+ * @see WSConstants#KEYTRANSPORT_RSA15
+ * @see WSConstants#KEYTRANSPORT_RSAOEP
*/
public void setKeyEnc(String keyEnc) {
keyEncAlgo = keyEnc;
@@ -175,15 +175,15 @@
}
/**
- * Set the name of the symmetric encryption algorithm to use
+ * Set the name of the symmetric encryption algorithm to use.
* <p/>
- * This encyrption alogrithm is used to encrypt
+ * This encryption alogrithm is used to encrypt
* the data, i.e. the SOAP Body. If the algorithm
* is not set then Triple DES is used. Refer to
* WSConstants which algorithms are supported.
* <p/>
*
- * @param algo Is the name of the encyrption algorithm
+ * @param algo Is the name of the encryption algorithm
* @see WSConstants#TRIPLE_DES
* @see WSConstants#AES_128
* @see WSConstants#AES_192
@@ -195,7 +195,7 @@
/**
* Set the name of an optional canonicalization algorithm to use
- * before encryption
+ * before encryption.
* <p/>
* This c14n alogrithm is used to serialize the data before
* encryption, i.e. the SOAP Body. If the algorithm
@@ -211,9 +211,9 @@
}
/**
- * Get the name of symmetric encryption algorithm to use
+ * Get the name of symmetric encryption algorithm to use.
* <p/>
- * The name of the encyrption alogrithm to encrypt
+ * The name of the encryption alogrithm to encrypt
* the data, i.e. the SOAP Body. Refer to
* WSConstants which algorithms are supported.
* <p/>
@@ -688,7 +688,7 @@
}
/**
- * @return
+ * @return TODO
*/
public SecretKey getSymmetricKey() {
return symmetricKey;
@@ -713,7 +713,7 @@
}
/**
- * @return
+ * @return TODO
*/
public SecurityTokenReference getSecurityTokenReference() {
return securityTokenReference;
Index: src/org/apache/ws/security/WSSecurityEngine.java
===================================================================
--- src/org/apache/ws/security/WSSecurityEngine.java (revision
280420)
+++ src/org/apache/ws/security/WSSecurityEngine.java (working copy)
@@ -245,7 +245,9 @@
* <ul>
* <li>{@link #SIGNATURE <code>ds:Signature</code>}</li>
* <li>{@link #ENCRYPTED_KEY <code>xenc:EncryptedKey</code>}</li>
- * <li>{@link #USERNAME_TOKEN <code>wsse:UsernameToken</code>}</li>
+ * <li>{@link #REFERENCE_LIST <code>xenc:ReferenceList</code>}</li>
+ * <li>{@link #usernameToken <code>wsse:UsernameToken</code>}</li>
+ * <li>{@link #timeStamp <code>wsu:Timestamp</code>}</li>
* </ul>
* <p/>
*
Index: src/org/apache/ws/security/WSPasswordCallback.java
===================================================================
--- src/org/apache/ws/security/WSPasswordCallback.java (revision
280420)
+++ src/org/apache/ws/security/WSPasswordCallback.java (working copy)
@@ -48,7 +48,7 @@
* associated with the identifier. WSS4J uses this key to encrypt or
* decrypt parts of the SOAP request. Note, the key must match the
* symmetric encryption/decryption algorithm specified (refer to
- * {@link org.apache.ws.security.handler.WSHandlerConstants#
ENC_SYM_ALGO}).</li>
+ * {@link
org.apache.ws.security.handler.WSHandlerConstants#ENC_SYM_ALGO}).</li>
* * <li><code>USERNAME_TOKEN_UNKNOWN</code> - either an not specified
* password type or a password type passwordText. In these both cases
<b>only</b>
* the password variable is <b>set</>. The callback class now may check
if
Index: src/org/apache/ws/security/util/WSSecurityUtil.java
===================================================================
--- src/org/apache/ws/security/util/WSSecurityUtil.java (revision
280420)
+++ src/org/apache/ws/security/util/WSSecurityUtil.java (working copy)
@@ -113,7 +113,7 @@
*
* @param actor
* @param hActor
- * @return
+ * @return TODO
*/
public static boolean isActorEqual(String actor, String hActor) {
if ((((hActor == null) || (hActor.length() == 0))
@@ -295,7 +295,7 @@
* @param element
* @param namespace
* @param prefix
- * @return
+ * @return TODO
*/
public static String setNamespace(Element element,
String namespace,
@@ -410,8 +410,6 @@
* Search for an element given its wsu:id.
* <p/>
*
- * @param wssConfig The WSS configuration data conating namesapce
- * definitions, etc.
* @param doc the DOM document (SOAP request)
* @param id the Id of the element
* @return the found element or null if no element with the Id
exists
@@ -455,8 +453,6 @@
*
* @param doc the DOM document (SOAP request)
* @param wsuIdVal the value for the wsu:Id
- * @param wssConfig The WSS configuration data conating namesapce
- * definitions, etc.
* @return then BST element (DOM element)
*/
public static Element createBinarySecurityToken(Document doc,
Index: src/org/apache/ws/security/util/Loader.java
===================================================================
--- src/org/apache/ws/security/util/Loader.java (revision 280420)
+++ src/org/apache/ws/security/util/Loader.java (working copy)
@@ -48,7 +48,7 @@
* <p/>
*
* @param resource
- * @return
+ * @return TODO
*/
static public URL getResource(String resource) {
ClassLoader classLoader = null;
@@ -95,7 +95,7 @@
* <p/>
*
* @param clazz
- * @return
+ * @return TODO
* @throws ClassNotFoundException
*/
static public Class loadClass(String clazz) throws
ClassNotFoundException {
--end--
---------------------------------------------------------------------
To unsubscribe, e-mail: wss4j-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: wss4j-dev-help@ws.apache.org
Re: javadoc patch
Posted by Davanum Srinivas <da...@gmail.com>.
Hans,
yes you do :) please feel free to commit.
-- dims
On 9/12/05, Granqvist, Hans <hg...@verisign.com> wrote:
> Here is a simple patch for fixing current javadoc wss4j errors.
> I simply tagged missing params with 'TODO' and fixed obvious
> mistakes.
>
> Any takers? (Don't think I have commit privs on wss4j)
>
> Thanks,
> Hans
>
> --start--
>
> Index: src/org/apache/ws/axis/security/package.html
> ===================================================================
> --- src/org/apache/ws/axis/security/package.html (revision
> 280420)
> +++ src/org/apache/ws/axis/security/package.html (working copy)
> @@ -584,9 +584,9 @@
> checks if all required actions were performed. If this check fails, the
> WSS4J handler aborts the SOAP request and throws an Axis SOAP fault.
> Otherwise it creates its own data structure
> -{@link org.apache.ws.axis.security.WSDoAllReceiverResult}, copies the
> +{@link org.apache.ws.security.handler.WSHandlerResult}, copies the
> security results in this structure, and adds the actor name of the
> -security header. The it stores this new data structure in a vector and
> stores
> +security header. Then it stores this new data structure in a vector and
> stores
> this vector in a specific
> {@link org.apache.ws.security.handler.WSHandlerConstants#RECV_RESULTS
> property}
> of the current message context. If WSS4J handlers are
> Index: src/org/apache/ws/security/WSSConfig.java
> ===================================================================
> --- src/org/apache/ws/security/WSSConfig.java (revision 280420)
> +++ src/org/apache/ws/security/WSSConfig.java (working copy)
> @@ -99,7 +99,7 @@
> /**
> * Checks if we are in WS-I Basic Security Profile compliance mode
> *
> - * @return
> + * @return TODO
> */
> public boolean isWsiBSPCompliant() {
> return wsiBSPCompliant;
> @@ -118,7 +118,7 @@
> /**
> * Checks if we need to use milliseconds in timestamps
> *
> - * @return
> + * @return TODO
> */
> public boolean isPrecisionInMilliSeconds() {
> return precisionInMilliSeconds;
> @@ -127,7 +127,7 @@
> /**
> * Set the precision in milliseconds
> *
> - * @param wsiBSPCompliant
> + * @param precisionInMilliSeconds TODO
> */
> public void setPrecisionInMilliSeconds(boolean
> precisionInMilliSeconds) {
> this.precisionInMilliSeconds = precisionInMilliSeconds;
> Index: src/org/apache/ws/security/message/token/UsernameToken.java
> ===================================================================
> --- src/org/apache/ws/security/message/token/UsernameToken.java
> (revision 280420)
> +++ src/org/apache/ws/security/message/token/UsernameToken.java (working
> copy)
> @@ -76,7 +76,6 @@
> * Constructs a <code>UsernameToken</code> object and parses the
> * <code>wsse:UsernameToken</code> element to initialize it.
> *
> - * @param wssConfig Configuration options for processing and
> building the <code>wsse:Security</code> header
> * @param elem the <code>wsse:UsernameToken</code> element
> that
> * contains the UsernameToken data
> * @throws WSSecurityException
> @@ -113,7 +112,6 @@
> * This constructes set the password encoding to
> * {@link WSConstants#PASSWORD_DIGEST}
> *
> - * @param wssConfig Configuration options for processing and
> building the <code>wsse:Security</code> header
> * @param doc the SOAP envelope as <code>Document</code>
> */
> public UsernameToken(boolean milliseconds, Document doc) {
> @@ -125,9 +123,8 @@
> * to the defined parameters.
> * <p/>
> *
> - * @param wssConfig Configuration options for processing and
> building the <code>wsse:Security</code> header
> * @param doc the SOAP envelope as <code>Document</code>
> - * @param passwordType the required password encoding, either
> + * @param pwType the required password encoding, either
> * {@link WSConstants#PASSWORD_DIGEST} or
> * {@link WSConstants#PASSWORD_TEXT}
> */
> Index: src/org/apache/ws/security/message/token/Timestamp.java
> ===================================================================
> --- src/org/apache/ws/security/message/token/Timestamp.java
> (revision 280420)
> +++ src/org/apache/ws/security/message/token/Timestamp.java (working
> copy)
> @@ -56,7 +56,7 @@
> * Constructs a <code>Timestamp</code> object and parses the
> * <code>wsu:Timestamp</code> element to initialize it.
> *
> - * @param elem the <code>wsu:Timestamp</code> element that
> + * @param element the <code>wsu:Timestamp</code> element that
> * contains the timestamp data
> */
> public Timestamp(Element element) throws WSSecurityException {
> @@ -221,7 +221,7 @@
>
> /**
> * Returns the value of the wsu:Id attribute
> - * @return
> + * @return TODO
> */
> public String getID() {
> return this.element.getAttributeNS(WSConstants.WSU_NS, "Id");
> Index:
> src/org/apache/ws/security/message/token/SecurityTokenReference.java
> ===================================================================
> --- src/org/apache/ws/security/message/token/SecurityTokenReference.java
> (revision 280420)
> +++ src/org/apache/ws/security/message/token/SecurityTokenReference.java
> (working copy)
> @@ -62,8 +62,7 @@
> * Constructor.
> * <p/>
> *
> - * @param wssConfig
> - * @param elem
> + * @param elem TODO
> * @throws WSSecurityException
> */
> public SecurityTokenReference(Element elem) throws
> WSSecurityException {
> @@ -86,8 +85,7 @@
> * Constructor.
> * <p/>
> *
> - * @param wssConfig
> - * @param doc
> + * @param doc TODO
> */
> public SecurityTokenReference(Document doc) {
> doDebug = log.isDebugEnabled();
> @@ -250,9 +248,6 @@
> *
> * @param cert
> * is the X509 certficate to get the thumbprint
> - * @param crypto
> - * is the Crypto implementation. Used to read SKI info
> bytes from
> - * certificate
> */
> public void setKeyIdentifierThumb(X509Certificate cert)
> throws WSSecurityException {
> @@ -598,7 +593,7 @@
> * get the dom element.
> * <p/>
> *
> - * @return
> + * @return TODO
> */
> public Element getElement() {
> return this.element;
> @@ -622,7 +617,7 @@
> * return the string representation.
> * <p/>
> *
> - * @return
> + * @return TODO
> */
> public String toString() {
> return DOM2Writer.nodeToString((Node) this.element);
> Index:
> src/org/apache/ws/security/message/token/SignatureConfirmation.java
> ===================================================================
> --- src/org/apache/ws/security/message/token/SignatureConfirmation.java
> (revision 280420)
> +++ src/org/apache/ws/security/message/token/SignatureConfirmation.java
> (working copy)
> @@ -60,8 +60,8 @@
> * <p/> * * @param doc the SOAP envelope as
> <code>Document</code> - * @param the Signature value as byte[] of
> <code>null</code> if no value - * available. + * @param
> signVal the Signature value as byte[] of <code>null</code> + * if
> no value available. */ public SignatureConfirmation(Document
> doc, byte[] signVal) { @@ -110,7 +110,7 @@
> /** * Returns the value of the wsu:Id attribute - *
> @return + * @return TODO */ public String getID() {
> return this.element.getAttributeNS(WSConstants.WSU_NS, "Id"); Index:
> src/org/apache/ws/security/message/token/BinarySecurity.java
> ===================================================================
> --- src/org/apache/ws/security/message/token/BinarySecurity.java
> (revision 280420)
> +++ src/org/apache/ws/security/message/token/BinarySecurity.java
> (working copy)
> @@ -77,7 +77,7 @@
> * get the value type.
> * <p/>
> *
> - * @return
> + * @return TODO
> */
> public String getValueType() {
> return this.element.getAttribute("ValueType");
> @@ -97,7 +97,7 @@
> * get the encoding type.
> * <p/>
> *
> - * @return
> + * @return TODO
> */
> public String getEncodingType() {
> return this.element.getAttribute("EncodingType");
> @@ -117,7 +117,7 @@
> * get the byte array containing token information.
> * <p/>
> *
> - * @return
> + * @return TODO
> */
> public byte[] getToken() {
> Text node = getFirstNode();
> @@ -149,7 +149,7 @@
> * return the first text node.
> * <p/>
> *
> - * @return
> + * @return TODO
> */
> protected Text getFirstNode() {
> Node node = this.element.getFirstChild();
> @@ -160,7 +160,7 @@
> * return the dom element.
> * <p/>
> *
> - * @return
> + * @return TODO
> */
> public Element getElement() {
> return this.element;
> @@ -170,7 +170,7 @@
> * get the id.
> * <p/>
> *
> - * @return
> + * @return TODO
> */
> public String getID() {
> return this.element.getAttributeNS(WSConstants.WSU_NS, "Id");
> @@ -191,7 +191,7 @@
> * return the string representation of the token.
> * <p/>
> *
> - * @return
> + * @return TODO
> */
> public String toString() {
> return DOM2Writer.nodeToString((Node) this.element);
> Index: src/org/apache/ws/security/message/token/X509Security.java
> ===================================================================
> --- src/org/apache/ws/security/message/token/X509Security.java
> (revision 280420)
> +++ src/org/apache/ws/security/message/token/X509Security.java (working
> copy)
> @@ -45,7 +45,6 @@
> * This constructor creates a new X509 certificate object and
> initializes
> * it from the data containe in the element.
> *
> - * @param wssConfig Configuration options for processing and
> building the <code>wsse:Security</code> header
> * @param elem the element containing the X509 certificate
> data
> * @throws WSSecurityException
> */
> Index: src/org/apache/ws/security/message/token/Reference.java
> ===================================================================
> --- src/org/apache/ws/security/message/token/Reference.java
> (revision 280420)
> +++ src/org/apache/ws/security/message/token/Reference.java (working
> copy)
> @@ -80,7 +80,7 @@
> * get the dom element.
> * <p/>
> *
> - * @return
> + * @return TODO
> */
> public Element getElement() {
> return this.element;
> @@ -90,7 +90,7 @@
> * get the URI.
> * <p/>
> *
> - * @return
> + * @return TODO
> */
> public String getValueType() {
> return this.element.getAttribute("ValueType");
> @@ -100,7 +100,7 @@
> * get the URI.
> * <p/>
> *
> - * @return
> + * @return TODO
> */
> public String getURI() {
> return this.element.getAttribute("URI");
> @@ -130,7 +130,7 @@
> * return the string representation.
> * <p/>
> *
> - * @return
> + * @return TODO
> */
> public String toString() {
> return DOM2Writer.nodeToString((Node) this.element);
> Index: src/org/apache/ws/security/message/WSSAddSAMLToken.java
> ===================================================================
> --- src/org/apache/ws/security/message/WSSAddSAMLToken.java
> (revision 280420)
> +++ src/org/apache/ws/security/message/WSSAddSAMLToken.java (working
> copy)
> @@ -70,7 +70,7 @@
> * <code>wsse:Security</code> header.
> *
> * @param doc The SOAP enevlope as W3C document
> - * @param username The username to set in the UsernameToken
> + * @param assertion TODO
> * @return Document with UsernameToken added
> */
> public Document build(Document doc, SAMLAssertion assertion) {
> Index: src/org/apache/ws/security/message/WSAddTimestamp.java
> ===================================================================
> --- src/org/apache/ws/security/message/WSAddTimestamp.java
> (revision 280420)
> +++ src/org/apache/ws/security/message/WSAddTimestamp.java (working
> copy)
> @@ -110,7 +110,7 @@
> /**
> * Get the wsu:Id value of the Timestamp
> *
> - * @return
> + * @return TODO
> */
> public String getId() {
> return id;
> Index: src/org/apache/ws/security/message/WSSAddUsernameToken.java
> ===================================================================
> --- src/org/apache/ws/security/message/WSSAddUsernameToken.java
> (revision 280420)
> +++ src/org/apache/ws/security/message/WSSAddUsernameToken.java (working
> copy)
> @@ -111,7 +111,7 @@
> }
> /**
> * get the id
> - * @return
> + * @return TODO
> */
> public String getId() {
> return id;
> Index: src/org/apache/ws/security/message/WSSignEnvelope.java
> ===================================================================
> --- src/org/apache/ws/security/message/WSSignEnvelope.java
> (revision 280420)
> +++ src/org/apache/ws/security/message/WSSignEnvelope.java (working
> copy)
> @@ -125,7 +125,7 @@
> /**
> * Get the single cert flag.
> *
> - * @return
> + * @return TODO
> */
> public boolean isUseSingleCertificate() {
> return this.useSingleCert;
> @@ -181,7 +181,7 @@
> * If the canonicalization method was not set then Exclusive XML
> * Canonicalization is used by default.
> *
> - * @return
> + * @return TODO
> */
> public String getSigCanonicalization() {
> return canonAlgo;
> Index: src/org/apache/ws/security/message/WSBaseMessage.java
> ===================================================================
> --- src/org/apache/ws/security/message/WSBaseMessage.java
> (revision 280420)
> +++ src/org/apache/ws/security/message/WSBaseMessage.java (working
> copy)
> @@ -104,7 +104,7 @@
> * Set which parts of the message to encrypt/sign.
> * <p/>
> *
> - * @param act The vector containing the WSEncryptionPart objects
> + * @param parts The vector containing the WSEncryptionPart objects
> */
> public void setParts(Vector parts) {
> this.parts = parts;
> Index: src/org/apache/ws/security/message/EnvelopeIdResolver.java
> ===================================================================
> --- src/org/apache/ws/security/message/EnvelopeIdResolver.java
> (revision 280420)
> +++ src/org/apache/ws/security/message/EnvelopeIdResolver.java (working
> copy)
> @@ -56,7 +56,7 @@
> * Singleton instance of the resolver.
> * <p/>
> *
> - * @return
> + * @return TODO
> */
> public synchronized static ResourceResolverSpi getInstance() {
> if (resolver == null) {
> @@ -74,7 +74,7 @@
> *
> * @param uri
> * @param BaseURI
> - * @return
> + * @return TODO
> * @throws ResourceResolverException
> */
> public XMLSignatureInput engineResolve(Attr uri, String BaseURI)
> @@ -168,7 +168,7 @@
> *
> * @param uri
> * @param BaseURI
> - * @return
> + * @return TODO
> */
> public boolean engineCanResolve(Attr uri, String BaseURI) {
> if (uri == null) {
> Index: src/org/apache/ws/security/message/WSEncryptBody.java
> ===================================================================
> --- src/org/apache/ws/security/message/WSEncryptBody.java
> (revision 280420)
> +++ src/org/apache/ws/security/message/WSEncryptBody.java (working
> copy)
> @@ -134,8 +134,8 @@
> * algorithm.
> *
> * @param keyEnc specifies the key encoding algorithm.
> - * @see WSConstants.KEYTRANSPORT_RSA15
> - * @see WSConstants.KEYTRANSPORT_RSAOEP
> + * @see WSConstants#KEYTRANSPORT_RSA15
> + * @see WSConstants#KEYTRANSPORT_RSAOEP
> */
> public void setKeyEnc(String keyEnc) {
> keyEncAlgo = keyEnc;
> @@ -175,15 +175,15 @@
> }
>
> /**
> - * Set the name of the symmetric encryption algorithm to use
> + * Set the name of the symmetric encryption algorithm to use.
> * <p/>
> - * This encyrption alogrithm is used to encrypt
> + * This encryption alogrithm is used to encrypt
> * the data, i.e. the SOAP Body. If the algorithm
> * is not set then Triple DES is used. Refer to
> * WSConstants which algorithms are supported.
> * <p/>
> *
> - * @param algo Is the name of the encyrption algorithm
> + * @param algo Is the name of the encryption algorithm
> * @see WSConstants#TRIPLE_DES
> * @see WSConstants#AES_128
> * @see WSConstants#AES_192
> @@ -195,7 +195,7 @@
>
> /**
> * Set the name of an optional canonicalization algorithm to use
> - * before encryption
> + * before encryption.
> * <p/>
> * This c14n alogrithm is used to serialize the data before
> * encryption, i.e. the SOAP Body. If the algorithm
> @@ -211,9 +211,9 @@
> }
>
> /**
> - * Get the name of symmetric encryption algorithm to use
> + * Get the name of symmetric encryption algorithm to use.
> * <p/>
> - * The name of the encyrption alogrithm to encrypt
> + * The name of the encryption alogrithm to encrypt
> * the data, i.e. the SOAP Body. Refer to
> * WSConstants which algorithms are supported.
> * <p/>
> @@ -688,7 +688,7 @@
> }
>
> /**
> - * @return
> + * @return TODO
> */
> public SecretKey getSymmetricKey() {
> return symmetricKey;
> @@ -713,7 +713,7 @@
> }
>
> /**
> - * @return
> + * @return TODO
> */
> public SecurityTokenReference getSecurityTokenReference() {
> return securityTokenReference;
> Index: src/org/apache/ws/security/WSSecurityEngine.java
> ===================================================================
> --- src/org/apache/ws/security/WSSecurityEngine.java (revision
> 280420)
> +++ src/org/apache/ws/security/WSSecurityEngine.java (working copy)
> @@ -245,7 +245,9 @@
> * <ul>
> * <li>{@link #SIGNATURE <code>ds:Signature</code>}</li>
> * <li>{@link #ENCRYPTED_KEY <code>xenc:EncryptedKey</code>}</li>
> - * <li>{@link #USERNAME_TOKEN <code>wsse:UsernameToken</code>}</li>
> + * <li>{@link #REFERENCE_LIST <code>xenc:ReferenceList</code>}</li>
> + * <li>{@link #usernameToken <code>wsse:UsernameToken</code>}</li>
> + * <li>{@link #timeStamp <code>wsu:Timestamp</code>}</li>
> * </ul>
> * <p/>
> *
> Index: src/org/apache/ws/security/WSPasswordCallback.java
> ===================================================================
> --- src/org/apache/ws/security/WSPasswordCallback.java (revision
> 280420)
> +++ src/org/apache/ws/security/WSPasswordCallback.java (working copy)
> @@ -48,7 +48,7 @@
> * associated with the identifier. WSS4J uses this key to encrypt or
> * decrypt parts of the SOAP request. Note, the key must match the
> * symmetric encryption/decryption algorithm specified (refer to
> - * {@link org.apache.ws.security.handler.WSHandlerConstants#
> ENC_SYM_ALGO}).</li>
> + * {@link
> org.apache.ws.security.handler.WSHandlerConstants#ENC_SYM_ALGO}).</li>
> * * <li><code>USERNAME_TOKEN_UNKNOWN</code> - either an not specified
> * password type or a password type passwordText. In these both cases
> <b>only</b>
> * the password variable is <b>set</>. The callback class now may check
> if
> Index: src/org/apache/ws/security/util/WSSecurityUtil.java
> ===================================================================
> --- src/org/apache/ws/security/util/WSSecurityUtil.java (revision
> 280420)
> +++ src/org/apache/ws/security/util/WSSecurityUtil.java (working copy)
> @@ -113,7 +113,7 @@
> *
> * @param actor
> * @param hActor
> - * @return
> + * @return TODO
> */
> public static boolean isActorEqual(String actor, String hActor) {
> if ((((hActor == null) || (hActor.length() == 0))
> @@ -295,7 +295,7 @@
> * @param element
> * @param namespace
> * @param prefix
> - * @return
> + * @return TODO
> */
> public static String setNamespace(Element element,
> String namespace,
> @@ -410,8 +410,6 @@
> * Search for an element given its wsu:id.
> * <p/>
> *
> - * @param wssConfig The WSS configuration data conating namesapce
> - * definitions, etc.
> * @param doc the DOM document (SOAP request)
> * @param id the Id of the element
> * @return the found element or null if no element with the Id
> exists
> @@ -455,8 +453,6 @@
> *
> * @param doc the DOM document (SOAP request)
> * @param wsuIdVal the value for the wsu:Id
> - * @param wssConfig The WSS configuration data conating namesapce
> - * definitions, etc.
> * @return then BST element (DOM element)
> */
> public static Element createBinarySecurityToken(Document doc,
> Index: src/org/apache/ws/security/util/Loader.java
> ===================================================================
> --- src/org/apache/ws/security/util/Loader.java (revision 280420)
> +++ src/org/apache/ws/security/util/Loader.java (working copy)
> @@ -48,7 +48,7 @@
> * <p/>
> *
> * @param resource
> - * @return
> + * @return TODO
> */
> static public URL getResource(String resource) {
> ClassLoader classLoader = null;
> @@ -95,7 +95,7 @@
> * <p/>
> *
> * @param clazz
> - * @return
> + * @return TODO
> * @throws ClassNotFoundException
> */
> static public Class loadClass(String clazz) throws
> ClassNotFoundException {
>
>
>
>
> --end--
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: wss4j-dev-unsubscribe@ws.apache.org
> For additional commands, e-mail: wss4j-dev-help@ws.apache.org
>
>
--
Davanum Srinivas : http://wso2.com/ - Oxygenating The Web Service Platform
---------------------------------------------------------------------
To unsubscribe, e-mail: wss4j-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: wss4j-dev-help@ws.apache.org
Re: javadoc patch
Posted by Davanum Srinivas <da...@gmail.com>.
Hans,
yes you do :) please feel free to commit.
-- dims
On 9/12/05, Granqvist, Hans <hg...@verisign.com> wrote:
> Here is a simple patch for fixing current javadoc wss4j errors.
> I simply tagged missing params with 'TODO' and fixed obvious
> mistakes.
>
> Any takers? (Don't think I have commit privs on wss4j)
>
> Thanks,
> Hans
>
> --start--
>
> Index: src/org/apache/ws/axis/security/package.html
> ===================================================================
> --- src/org/apache/ws/axis/security/package.html (revision
> 280420)
> +++ src/org/apache/ws/axis/security/package.html (working copy)
> @@ -584,9 +584,9 @@
> checks if all required actions were performed. If this check fails, the
> WSS4J handler aborts the SOAP request and throws an Axis SOAP fault.
> Otherwise it creates its own data structure
> -{@link org.apache.ws.axis.security.WSDoAllReceiverResult}, copies the
> +{@link org.apache.ws.security.handler.WSHandlerResult}, copies the
> security results in this structure, and adds the actor name of the
> -security header. The it stores this new data structure in a vector and
> stores
> +security header. Then it stores this new data structure in a vector and
> stores
> this vector in a specific
> {@link org.apache.ws.security.handler.WSHandlerConstants#RECV_RESULTS
> property}
> of the current message context. If WSS4J handlers are
> Index: src/org/apache/ws/security/WSSConfig.java
> ===================================================================
> --- src/org/apache/ws/security/WSSConfig.java (revision 280420)
> +++ src/org/apache/ws/security/WSSConfig.java (working copy)
> @@ -99,7 +99,7 @@
> /**
> * Checks if we are in WS-I Basic Security Profile compliance mode
> *
> - * @return
> + * @return TODO
> */
> public boolean isWsiBSPCompliant() {
> return wsiBSPCompliant;
> @@ -118,7 +118,7 @@
> /**
> * Checks if we need to use milliseconds in timestamps
> *
> - * @return
> + * @return TODO
> */
> public boolean isPrecisionInMilliSeconds() {
> return precisionInMilliSeconds;
> @@ -127,7 +127,7 @@
> /**
> * Set the precision in milliseconds
> *
> - * @param wsiBSPCompliant
> + * @param precisionInMilliSeconds TODO
> */
> public void setPrecisionInMilliSeconds(boolean
> precisionInMilliSeconds) {
> this.precisionInMilliSeconds = precisionInMilliSeconds;
> Index: src/org/apache/ws/security/message/token/UsernameToken.java
> ===================================================================
> --- src/org/apache/ws/security/message/token/UsernameToken.java
> (revision 280420)
> +++ src/org/apache/ws/security/message/token/UsernameToken.java (working
> copy)
> @@ -76,7 +76,6 @@
> * Constructs a <code>UsernameToken</code> object and parses the
> * <code>wsse:UsernameToken</code> element to initialize it.
> *
> - * @param wssConfig Configuration options for processing and
> building the <code>wsse:Security</code> header
> * @param elem the <code>wsse:UsernameToken</code> element
> that
> * contains the UsernameToken data
> * @throws WSSecurityException
> @@ -113,7 +112,6 @@
> * This constructes set the password encoding to
> * {@link WSConstants#PASSWORD_DIGEST}
> *
> - * @param wssConfig Configuration options for processing and
> building the <code>wsse:Security</code> header
> * @param doc the SOAP envelope as <code>Document</code>
> */
> public UsernameToken(boolean milliseconds, Document doc) {
> @@ -125,9 +123,8 @@
> * to the defined parameters.
> * <p/>
> *
> - * @param wssConfig Configuration options for processing and
> building the <code>wsse:Security</code> header
> * @param doc the SOAP envelope as <code>Document</code>
> - * @param passwordType the required password encoding, either
> + * @param pwType the required password encoding, either
> * {@link WSConstants#PASSWORD_DIGEST} or
> * {@link WSConstants#PASSWORD_TEXT}
> */
> Index: src/org/apache/ws/security/message/token/Timestamp.java
> ===================================================================
> --- src/org/apache/ws/security/message/token/Timestamp.java
> (revision 280420)
> +++ src/org/apache/ws/security/message/token/Timestamp.java (working
> copy)
> @@ -56,7 +56,7 @@
> * Constructs a <code>Timestamp</code> object and parses the
> * <code>wsu:Timestamp</code> element to initialize it.
> *
> - * @param elem the <code>wsu:Timestamp</code> element that
> + * @param element the <code>wsu:Timestamp</code> element that
> * contains the timestamp data
> */
> public Timestamp(Element element) throws WSSecurityException {
> @@ -221,7 +221,7 @@
>
> /**
> * Returns the value of the wsu:Id attribute
> - * @return
> + * @return TODO
> */
> public String getID() {
> return this.element.getAttributeNS(WSConstants.WSU_NS, "Id");
> Index:
> src/org/apache/ws/security/message/token/SecurityTokenReference.java
> ===================================================================
> --- src/org/apache/ws/security/message/token/SecurityTokenReference.java
> (revision 280420)
> +++ src/org/apache/ws/security/message/token/SecurityTokenReference.java
> (working copy)
> @@ -62,8 +62,7 @@
> * Constructor.
> * <p/>
> *
> - * @param wssConfig
> - * @param elem
> + * @param elem TODO
> * @throws WSSecurityException
> */
> public SecurityTokenReference(Element elem) throws
> WSSecurityException {
> @@ -86,8 +85,7 @@
> * Constructor.
> * <p/>
> *
> - * @param wssConfig
> - * @param doc
> + * @param doc TODO
> */
> public SecurityTokenReference(Document doc) {
> doDebug = log.isDebugEnabled();
> @@ -250,9 +248,6 @@
> *
> * @param cert
> * is the X509 certficate to get the thumbprint
> - * @param crypto
> - * is the Crypto implementation. Used to read SKI info
> bytes from
> - * certificate
> */
> public void setKeyIdentifierThumb(X509Certificate cert)
> throws WSSecurityException {
> @@ -598,7 +593,7 @@
> * get the dom element.
> * <p/>
> *
> - * @return
> + * @return TODO
> */
> public Element getElement() {
> return this.element;
> @@ -622,7 +617,7 @@
> * return the string representation.
> * <p/>
> *
> - * @return
> + * @return TODO
> */
> public String toString() {
> return DOM2Writer.nodeToString((Node) this.element);
> Index:
> src/org/apache/ws/security/message/token/SignatureConfirmation.java
> ===================================================================
> --- src/org/apache/ws/security/message/token/SignatureConfirmation.java
> (revision 280420)
> +++ src/org/apache/ws/security/message/token/SignatureConfirmation.java
> (working copy)
> @@ -60,8 +60,8 @@
> * <p/> * * @param doc the SOAP envelope as
> <code>Document</code> - * @param the Signature value as byte[] of
> <code>null</code> if no value - * available. + * @param
> signVal the Signature value as byte[] of <code>null</code> + * if
> no value available. */ public SignatureConfirmation(Document
> doc, byte[] signVal) { @@ -110,7 +110,7 @@
> /** * Returns the value of the wsu:Id attribute - *
> @return + * @return TODO */ public String getID() {
> return this.element.getAttributeNS(WSConstants.WSU_NS, "Id"); Index:
> src/org/apache/ws/security/message/token/BinarySecurity.java
> ===================================================================
> --- src/org/apache/ws/security/message/token/BinarySecurity.java
> (revision 280420)
> +++ src/org/apache/ws/security/message/token/BinarySecurity.java
> (working copy)
> @@ -77,7 +77,7 @@
> * get the value type.
> * <p/>
> *
> - * @return
> + * @return TODO
> */
> public String getValueType() {
> return this.element.getAttribute("ValueType");
> @@ -97,7 +97,7 @@
> * get the encoding type.
> * <p/>
> *
> - * @return
> + * @return TODO
> */
> public String getEncodingType() {
> return this.element.getAttribute("EncodingType");
> @@ -117,7 +117,7 @@
> * get the byte array containing token information.
> * <p/>
> *
> - * @return
> + * @return TODO
> */
> public byte[] getToken() {
> Text node = getFirstNode();
> @@ -149,7 +149,7 @@
> * return the first text node.
> * <p/>
> *
> - * @return
> + * @return TODO
> */
> protected Text getFirstNode() {
> Node node = this.element.getFirstChild();
> @@ -160,7 +160,7 @@
> * return the dom element.
> * <p/>
> *
> - * @return
> + * @return TODO
> */
> public Element getElement() {
> return this.element;
> @@ -170,7 +170,7 @@
> * get the id.
> * <p/>
> *
> - * @return
> + * @return TODO
> */
> public String getID() {
> return this.element.getAttributeNS(WSConstants.WSU_NS, "Id");
> @@ -191,7 +191,7 @@
> * return the string representation of the token.
> * <p/>
> *
> - * @return
> + * @return TODO
> */
> public String toString() {
> return DOM2Writer.nodeToString((Node) this.element);
> Index: src/org/apache/ws/security/message/token/X509Security.java
> ===================================================================
> --- src/org/apache/ws/security/message/token/X509Security.java
> (revision 280420)
> +++ src/org/apache/ws/security/message/token/X509Security.java (working
> copy)
> @@ -45,7 +45,6 @@
> * This constructor creates a new X509 certificate object and
> initializes
> * it from the data containe in the element.
> *
> - * @param wssConfig Configuration options for processing and
> building the <code>wsse:Security</code> header
> * @param elem the element containing the X509 certificate
> data
> * @throws WSSecurityException
> */
> Index: src/org/apache/ws/security/message/token/Reference.java
> ===================================================================
> --- src/org/apache/ws/security/message/token/Reference.java
> (revision 280420)
> +++ src/org/apache/ws/security/message/token/Reference.java (working
> copy)
> @@ -80,7 +80,7 @@
> * get the dom element.
> * <p/>
> *
> - * @return
> + * @return TODO
> */
> public Element getElement() {
> return this.element;
> @@ -90,7 +90,7 @@
> * get the URI.
> * <p/>
> *
> - * @return
> + * @return TODO
> */
> public String getValueType() {
> return this.element.getAttribute("ValueType");
> @@ -100,7 +100,7 @@
> * get the URI.
> * <p/>
> *
> - * @return
> + * @return TODO
> */
> public String getURI() {
> return this.element.getAttribute("URI");
> @@ -130,7 +130,7 @@
> * return the string representation.
> * <p/>
> *
> - * @return
> + * @return TODO
> */
> public String toString() {
> return DOM2Writer.nodeToString((Node) this.element);
> Index: src/org/apache/ws/security/message/WSSAddSAMLToken.java
> ===================================================================
> --- src/org/apache/ws/security/message/WSSAddSAMLToken.java
> (revision 280420)
> +++ src/org/apache/ws/security/message/WSSAddSAMLToken.java (working
> copy)
> @@ -70,7 +70,7 @@
> * <code>wsse:Security</code> header.
> *
> * @param doc The SOAP enevlope as W3C document
> - * @param username The username to set in the UsernameToken
> + * @param assertion TODO
> * @return Document with UsernameToken added
> */
> public Document build(Document doc, SAMLAssertion assertion) {
> Index: src/org/apache/ws/security/message/WSAddTimestamp.java
> ===================================================================
> --- src/org/apache/ws/security/message/WSAddTimestamp.java
> (revision 280420)
> +++ src/org/apache/ws/security/message/WSAddTimestamp.java (working
> copy)
> @@ -110,7 +110,7 @@
> /**
> * Get the wsu:Id value of the Timestamp
> *
> - * @return
> + * @return TODO
> */
> public String getId() {
> return id;
> Index: src/org/apache/ws/security/message/WSSAddUsernameToken.java
> ===================================================================
> --- src/org/apache/ws/security/message/WSSAddUsernameToken.java
> (revision 280420)
> +++ src/org/apache/ws/security/message/WSSAddUsernameToken.java (working
> copy)
> @@ -111,7 +111,7 @@
> }
> /**
> * get the id
> - * @return
> + * @return TODO
> */
> public String getId() {
> return id;
> Index: src/org/apache/ws/security/message/WSSignEnvelope.java
> ===================================================================
> --- src/org/apache/ws/security/message/WSSignEnvelope.java
> (revision 280420)
> +++ src/org/apache/ws/security/message/WSSignEnvelope.java (working
> copy)
> @@ -125,7 +125,7 @@
> /**
> * Get the single cert flag.
> *
> - * @return
> + * @return TODO
> */
> public boolean isUseSingleCertificate() {
> return this.useSingleCert;
> @@ -181,7 +181,7 @@
> * If the canonicalization method was not set then Exclusive XML
> * Canonicalization is used by default.
> *
> - * @return
> + * @return TODO
> */
> public String getSigCanonicalization() {
> return canonAlgo;
> Index: src/org/apache/ws/security/message/WSBaseMessage.java
> ===================================================================
> --- src/org/apache/ws/security/message/WSBaseMessage.java
> (revision 280420)
> +++ src/org/apache/ws/security/message/WSBaseMessage.java (working
> copy)
> @@ -104,7 +104,7 @@
> * Set which parts of the message to encrypt/sign.
> * <p/>
> *
> - * @param act The vector containing the WSEncryptionPart objects
> + * @param parts The vector containing the WSEncryptionPart objects
> */
> public void setParts(Vector parts) {
> this.parts = parts;
> Index: src/org/apache/ws/security/message/EnvelopeIdResolver.java
> ===================================================================
> --- src/org/apache/ws/security/message/EnvelopeIdResolver.java
> (revision 280420)
> +++ src/org/apache/ws/security/message/EnvelopeIdResolver.java (working
> copy)
> @@ -56,7 +56,7 @@
> * Singleton instance of the resolver.
> * <p/>
> *
> - * @return
> + * @return TODO
> */
> public synchronized static ResourceResolverSpi getInstance() {
> if (resolver == null) {
> @@ -74,7 +74,7 @@
> *
> * @param uri
> * @param BaseURI
> - * @return
> + * @return TODO
> * @throws ResourceResolverException
> */
> public XMLSignatureInput engineResolve(Attr uri, String BaseURI)
> @@ -168,7 +168,7 @@
> *
> * @param uri
> * @param BaseURI
> - * @return
> + * @return TODO
> */
> public boolean engineCanResolve(Attr uri, String BaseURI) {
> if (uri == null) {
> Index: src/org/apache/ws/security/message/WSEncryptBody.java
> ===================================================================
> --- src/org/apache/ws/security/message/WSEncryptBody.java
> (revision 280420)
> +++ src/org/apache/ws/security/message/WSEncryptBody.java (working
> copy)
> @@ -134,8 +134,8 @@
> * algorithm.
> *
> * @param keyEnc specifies the key encoding algorithm.
> - * @see WSConstants.KEYTRANSPORT_RSA15
> - * @see WSConstants.KEYTRANSPORT_RSAOEP
> + * @see WSConstants#KEYTRANSPORT_RSA15
> + * @see WSConstants#KEYTRANSPORT_RSAOEP
> */
> public void setKeyEnc(String keyEnc) {
> keyEncAlgo = keyEnc;
> @@ -175,15 +175,15 @@
> }
>
> /**
> - * Set the name of the symmetric encryption algorithm to use
> + * Set the name of the symmetric encryption algorithm to use.
> * <p/>
> - * This encyrption alogrithm is used to encrypt
> + * This encryption alogrithm is used to encrypt
> * the data, i.e. the SOAP Body. If the algorithm
> * is not set then Triple DES is used. Refer to
> * WSConstants which algorithms are supported.
> * <p/>
> *
> - * @param algo Is the name of the encyrption algorithm
> + * @param algo Is the name of the encryption algorithm
> * @see WSConstants#TRIPLE_DES
> * @see WSConstants#AES_128
> * @see WSConstants#AES_192
> @@ -195,7 +195,7 @@
>
> /**
> * Set the name of an optional canonicalization algorithm to use
> - * before encryption
> + * before encryption.
> * <p/>
> * This c14n alogrithm is used to serialize the data before
> * encryption, i.e. the SOAP Body. If the algorithm
> @@ -211,9 +211,9 @@
> }
>
> /**
> - * Get the name of symmetric encryption algorithm to use
> + * Get the name of symmetric encryption algorithm to use.
> * <p/>
> - * The name of the encyrption alogrithm to encrypt
> + * The name of the encryption alogrithm to encrypt
> * the data, i.e. the SOAP Body. Refer to
> * WSConstants which algorithms are supported.
> * <p/>
> @@ -688,7 +688,7 @@
> }
>
> /**
> - * @return
> + * @return TODO
> */
> public SecretKey getSymmetricKey() {
> return symmetricKey;
> @@ -713,7 +713,7 @@
> }
>
> /**
> - * @return
> + * @return TODO
> */
> public SecurityTokenReference getSecurityTokenReference() {
> return securityTokenReference;
> Index: src/org/apache/ws/security/WSSecurityEngine.java
> ===================================================================
> --- src/org/apache/ws/security/WSSecurityEngine.java (revision
> 280420)
> +++ src/org/apache/ws/security/WSSecurityEngine.java (working copy)
> @@ -245,7 +245,9 @@
> * <ul>
> * <li>{@link #SIGNATURE <code>ds:Signature</code>}</li>
> * <li>{@link #ENCRYPTED_KEY <code>xenc:EncryptedKey</code>}</li>
> - * <li>{@link #USERNAME_TOKEN <code>wsse:UsernameToken</code>}</li>
> + * <li>{@link #REFERENCE_LIST <code>xenc:ReferenceList</code>}</li>
> + * <li>{@link #usernameToken <code>wsse:UsernameToken</code>}</li>
> + * <li>{@link #timeStamp <code>wsu:Timestamp</code>}</li>
> * </ul>
> * <p/>
> *
> Index: src/org/apache/ws/security/WSPasswordCallback.java
> ===================================================================
> --- src/org/apache/ws/security/WSPasswordCallback.java (revision
> 280420)
> +++ src/org/apache/ws/security/WSPasswordCallback.java (working copy)
> @@ -48,7 +48,7 @@
> * associated with the identifier. WSS4J uses this key to encrypt or
> * decrypt parts of the SOAP request. Note, the key must match the
> * symmetric encryption/decryption algorithm specified (refer to
> - * {@link org.apache.ws.security.handler.WSHandlerConstants#
> ENC_SYM_ALGO}).</li>
> + * {@link
> org.apache.ws.security.handler.WSHandlerConstants#ENC_SYM_ALGO}).</li>
> * * <li><code>USERNAME_TOKEN_UNKNOWN</code> - either an not specified
> * password type or a password type passwordText. In these both cases
> <b>only</b>
> * the password variable is <b>set</>. The callback class now may check
> if
> Index: src/org/apache/ws/security/util/WSSecurityUtil.java
> ===================================================================
> --- src/org/apache/ws/security/util/WSSecurityUtil.java (revision
> 280420)
> +++ src/org/apache/ws/security/util/WSSecurityUtil.java (working copy)
> @@ -113,7 +113,7 @@
> *
> * @param actor
> * @param hActor
> - * @return
> + * @return TODO
> */
> public static boolean isActorEqual(String actor, String hActor) {
> if ((((hActor == null) || (hActor.length() == 0))
> @@ -295,7 +295,7 @@
> * @param element
> * @param namespace
> * @param prefix
> - * @return
> + * @return TODO
> */
> public static String setNamespace(Element element,
> String namespace,
> @@ -410,8 +410,6 @@
> * Search for an element given its wsu:id.
> * <p/>
> *
> - * @param wssConfig The WSS configuration data conating namesapce
> - * definitions, etc.
> * @param doc the DOM document (SOAP request)
> * @param id the Id of the element
> * @return the found element or null if no element with the Id
> exists
> @@ -455,8 +453,6 @@
> *
> * @param doc the DOM document (SOAP request)
> * @param wsuIdVal the value for the wsu:Id
> - * @param wssConfig The WSS configuration data conating namesapce
> - * definitions, etc.
> * @return then BST element (DOM element)
> */
> public static Element createBinarySecurityToken(Document doc,
> Index: src/org/apache/ws/security/util/Loader.java
> ===================================================================
> --- src/org/apache/ws/security/util/Loader.java (revision 280420)
> +++ src/org/apache/ws/security/util/Loader.java (working copy)
> @@ -48,7 +48,7 @@
> * <p/>
> *
> * @param resource
> - * @return
> + * @return TODO
> */
> static public URL getResource(String resource) {
> ClassLoader classLoader = null;
> @@ -95,7 +95,7 @@
> * <p/>
> *
> * @param clazz
> - * @return
> + * @return TODO
> * @throws ClassNotFoundException
> */
> static public Class loadClass(String clazz) throws
> ClassNotFoundException {
>
>
>
>
> --end--
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: wss4j-dev-unsubscribe@ws.apache.org
> For additional commands, e-mail: wss4j-dev-help@ws.apache.org
>
>
--
Davanum Srinivas : http://wso2.com/ - Oxygenating The Web Service Platform
---------------------------------------------------------------------
To unsubscribe, e-mail: wss4j-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: wss4j-dev-help@ws.apache.org