You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@santuario.apache.org by co...@apache.org on 2014/04/07 07:12:24 UTC
svn commit: r1585385 - in
/santuario/xml-security-java/trunk/src/main/java/org/apache:
jcp/xml/dsig/internal/dom/ xml/security/keys/ xml/security/keys/content/
xml/security/keys/keyresolver/implementations/
xml/security/stax/securityToken/ xml/security...
Author: coheigea
Date: Mon Apr 7 05:12:23 2014
New Revision: 1585385
URL: http://svn.apache.org/r1585385
Log:
Fixing javadoc warnings
Modified:
santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/BaseStructure.java
santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMCanonicalizationMethod.java
santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMKeyInfo.java
santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMReference.java
santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMSignatureProperties.java
santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMSignatureProperty.java
santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMTransform.java
santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMX509Data.java
santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMXMLObject.java
santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/XmlWriter.java
santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/XmlWriterToTree.java
santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/KeyInfo.java
santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/content/DEREncodedKeyValue.java
santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/content/KeyInfoReference.java
santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/content/X509Data.java
santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/keyresolver/implementations/KeyInfoReferenceResolver.java
santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/keyresolver/implementations/RetrievalMethodResolver.java
santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/keyresolver/implementations/SingleKeyResolver.java
santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/keyresolver/implementations/X509DigestResolver.java
santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/keyresolver/implementations/X509SubjectNameResolver.java
santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/stax/securityToken/InboundSecurityToken.java
santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/stax/securityToken/OutboundSecurityToken.java
santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/stax/securityToken/SecurityToken.java
santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/Base64.java
santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/ElementProxy.java
santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/resolver/ResourceResolver.java
santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/resolver/ResourceResolverSpi.java
santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/resolver/implementations/ResolverDirectHTTP.java
santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/resolver/implementations/ResolverFragment.java
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/BaseStructure.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/BaseStructure.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/BaseStructure.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/BaseStructure.java Mon Apr 7 05:12:23 2014
@@ -25,13 +25,10 @@ import org.w3c.dom.Node;
public abstract class BaseStructure implements XMLStructure {
/**
- * Since the behavior of {@link Model#getStringValue(Object)} returns the value
- * of all descendant text nodes of an element, whereas we just want the immediate children.
+ * Just return the text of the immediate child of a node.
*
- * @param <N>
- * @param model
* @param node
- * @return
+ * @return the text of a Node
*/
public static String textOfNode(Node node) {
return node.getFirstChild().getNodeValue();
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMCanonicalizationMethod.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMCanonicalizationMethod.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMCanonicalizationMethod.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMCanonicalizationMethod.java Mon Apr 7 05:12:23 2014
@@ -57,9 +57,8 @@ public class DOMCanonicalizationMethod e
}
/**
- * Creates a <code>DOMCanonicalizationMethod</code> from an element. This
- * ctor invokes the abstract {@link #unmarshalParams unmarshalParams}
- * method to unmarshal any algorithm-specific input parameters.
+ * Creates a <code>DOMCanonicalizationMethod</code> from an element. It unmarshals any
+ * algorithm-specific input parameters.
*
* @param cmElem a CanonicalizationMethod element
*/
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMKeyInfo.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMKeyInfo.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMKeyInfo.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMKeyInfo.java Mon Apr 7 05:12:23 2014
@@ -48,7 +48,7 @@ public final class DOMKeyInfo extends Ba
/**
* A utility function to suppress casting warnings.
* @param ki
- * @return
+ * @return the content of a KeyInfo Object
*/
@SuppressWarnings("unchecked")
public static List<XMLStructure> getContent(KeyInfo ki) {
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMReference.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMReference.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMReference.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMReference.java Mon Apr 7 05:12:23 2014
@@ -113,7 +113,6 @@ public final class DOMReference extends
* is defensively copied to protect against subsequent modification.
* May be <code>null</code> or empty.
* @param id the reference ID (may be <code>null</code>)
- * @return a <code>Reference</code>
* @throws NullPointerException if <code>dm</code> is <code>null</code>
* @throws ClassCastException if any of the <code>transforms</code> are
* not of type <code>Transform</code>
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMSignatureProperties.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMSignatureProperties.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMSignatureProperties.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMSignatureProperties.java Mon Apr 7 05:12:23 2014
@@ -51,7 +51,6 @@ public final class DOMSignaturePropertie
* @param properties a list of one or more {@link SignatureProperty}s. The
* list is defensively copied to protect against subsequent modification.
* @param id the Id (may be <code>null</code>)
- * @return a <code>DOMSignatureProperties</code>
* @throws ClassCastException if <code>properties</code> contains any
* entries that are not of type {@link SignatureProperty}
* @throws IllegalArgumentException if <code>properties</code> is empty
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMSignatureProperty.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMSignatureProperty.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMSignatureProperty.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMSignatureProperty.java Mon Apr 7 05:12:23 2014
@@ -52,7 +52,6 @@ public final class DOMSignatureProperty
* is defensively copied to protect against subsequent modification.
* @param target the target URI
* @param id the Id (may be <code>null</code>)
- * @return a <code>SignatureProperty</code>
* @throws ClassCastException if <code>content</code> contains any
* entries that are not of type {@link XMLStructure}
* @throws IllegalArgumentException if <code>content</code> is empty
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMTransform.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMTransform.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMTransform.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMTransform.java Mon Apr 7 05:12:23 2014
@@ -61,9 +61,8 @@ public class DOMTransform extends BaseSt
}
/**
- * Creates a <code>DOMTransform</code> from an element. This constructor
- * invokes the abstract {@link #unmarshalParams unmarshalParams} method to
- * unmarshal any algorithm-specific input parameters.
+ * Creates a <code>DOMTransform</code> from an element. It unmarshals any
+ * algorithm-specific input parameters.
*
* @param transElem a Transform element
*/
@@ -107,8 +106,7 @@ public class DOMTransform extends BaseSt
}
/**
- * This method invokes the abstract {@link #marshalParams marshalParams}
- * method to marshal any algorithm-specific parameters.
+ * This method marshals any algorithm-specific parameters.
*/
public void marshal(XmlWriter xwriter, String dsPrefix, XMLCryptoContext context)
throws MarshalException
@@ -128,7 +126,7 @@ public class DOMTransform extends BaseSt
* Transforms the specified data using the underlying transform algorithm.
*
* @param data the data to be transformed
- * @param sc the <code>XMLCryptoContext</code> containing
+ * @param xc the <code>XMLCryptoContext</code> containing
* additional context (may be <code>null</code> if not applicable)
* @return the transformed data
* @throws NullPointerException if <code>data</code> is <code>null</code>
@@ -146,7 +144,7 @@ public class DOMTransform extends BaseSt
* Transforms the specified data using the underlying transform algorithm.
*
* @param data the data to be transformed
- * @param sc the <code>XMLCryptoContext</code> containing
+ * @param xc the <code>XMLCryptoContext</code> containing
* additional context (may be <code>null</code> if not applicable)
* @param os the <code>OutputStream</code> that should be used to write
* the transformed data to
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMX509Data.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMX509Data.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMX509Data.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMX509Data.java Mon Apr 7 05:12:23 2014
@@ -55,10 +55,9 @@ public final class DOMX509Data extends B
* @param content a list of one or more X.509 data types. Valid types are
* {@link String} (subject names), <code>byte[]</code> (subject key ids),
* {@link java.security.cert.X509Certificate}, {@link X509CRL},
- * or {@link javax.xml.dsig.XMLStructure} ({@link X509IssuerSerial}
+ * or {@link javax.xml.dsig.XMLStructure}
* objects or elements from an external namespace). The list is
* defensively copied to protect against subsequent modification.
- * @return a <code>X509Data</code>
* @throws NullPointerException if <code>content</code> is <code>null</code>
* @throws IllegalArgumentException if <code>content</code> is empty
* @throws ClassCastException if <code>content</code> contains any entries
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMXMLObject.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMXMLObject.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMXMLObject.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/DOMXMLObject.java Mon Apr 7 05:12:23 2014
@@ -57,7 +57,6 @@ public final class DOMXMLObject extends
* @param id the Id (may be <code>null</code>)
* @param mimeType the mime type (may be <code>null</code>)
* @param encoding the encoding (may be <code>null</code>)
- * @return an <code>XMLObject</code>
* @throws ClassCastException if <code>content</code> contains any
* entries that are not of type {@link XMLStructure}
*/
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/XmlWriter.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/XmlWriter.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/XmlWriter.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/XmlWriter.java Mon Apr 7 05:12:23 2014
@@ -57,12 +57,12 @@ public interface XmlWriter {
* @param localName What local name to use?
* @param namespaceURI What namespace URI?
*
- * @see {@link XMLStreamWriter#writeStartElement(String, String, String)}
+ * See also {@link javax.xml.stream.XMLStreamWriter#writeStartElement(String, String, String)}
*/
void writeStartElement(String prefix, String localName, String namespaceURI);
/**
- * @see {@link XMLStreamWriter#writeEndElement()}
+ * See also {@link javax.xml.stream.XMLStreamWriter#writeEndElement()}
*/
void writeEndElement();
@@ -89,7 +89,7 @@ public interface XmlWriter {
/**
* Get the local name of the current element.
- * @return
+ * @return the local name of the current element.
*/
String getCurrentLocalName();
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/XmlWriterToTree.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/XmlWriterToTree.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/XmlWriterToTree.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/jcp/xml/dsig/internal/dom/XmlWriterToTree.java Mon Apr 7 05:12:23 2014
@@ -55,7 +55,7 @@ public class XmlWriterToTree implements
/**
* Get the root element created with this writer.
- * @return
+ * @return the root element created with this writer.
*/
public Element getCreatedElement() {
return m_createdElement;
@@ -63,10 +63,10 @@ public class XmlWriterToTree implements
/**
* In cases where the serialization is supposed to precede a specific
- * element, we add an extra paramter to capture that. Only affects the
+ * element, we add an extra parameter to capture that. Only affects the
* first element insertion (obviously?).
*
- * @param model
+ * @param marshallers
* @param parent
* @param nextSibling The first element created will be created *before* this element.
*/
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/KeyInfo.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/KeyInfo.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/KeyInfo.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/KeyInfo.java Mon Apr 7 05:12:23 2014
@@ -152,7 +152,7 @@ public class KeyInfo extends SignatureEl
/**
* Sets the <code>Id</code> attribute
*
- * @param Id ID
+ * @param id ID
*/
public void setId(String id) {
if (id != null) {
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/content/DEREncodedKeyValue.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/content/DEREncodedKeyValue.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/content/DEREncodedKeyValue.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/content/DEREncodedKeyValue.java Mon Apr 7 05:12:23 2014
@@ -68,7 +68,7 @@ public class DEREncodedKeyValue extends
* Constructor DEREncodedKeyValue
*
* @param doc
- * @param base64EncodedKey
+ * @param encodedKey
*/
public DEREncodedKeyValue(Document doc, byte[] encodedKey) {
super(doc);
@@ -79,7 +79,7 @@ public class DEREncodedKeyValue extends
/**
* Sets the <code>Id</code> attribute
*
- * @param Id ID
+ * @param id ID
*/
public void setId(String id) {
setLocalIdAttribute(Constants._ATT_ID, id);
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/content/KeyInfoReference.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/content/KeyInfoReference.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/content/KeyInfoReference.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/content/KeyInfoReference.java Mon Apr 7 05:12:23 2014
@@ -36,7 +36,7 @@ public class KeyInfoReference extends Si
* Constructor RetrievalMethod
*
* @param element
- * @param BaseURI
+ * @param baseURI
* @throws XMLSecurityException
*/
public KeyInfoReference(Element element, String baseURI) throws XMLSecurityException {
@@ -47,12 +47,12 @@ public class KeyInfoReference extends Si
* Constructor RetrievalMethod
*
* @param doc
- * @param URI
+ * @param uri
*/
- public KeyInfoReference(Document doc, String URI) {
+ public KeyInfoReference(Document doc, String uri) {
super(doc);
- setLocalAttribute(Constants._ATT_URI, URI);
+ setLocalAttribute(Constants._ATT_URI, uri);
}
/**
@@ -76,7 +76,7 @@ public class KeyInfoReference extends Si
/**
* Sets the <code>Id</code> attribute
*
- * @param Id ID
+ * @param id ID
*/
public void setId(String id) {
setLocalIdAttribute(Constants._ATT_ID, id);
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/content/X509Data.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/content/X509Data.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/content/X509Data.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/content/X509Data.java Mon Apr 7 05:12:23 2014
@@ -235,17 +235,17 @@ public class X509Data extends SignatureE
/**
* Method addDigest
*
- * @param x509CertificateDigestByes
+ * @param x509CertificateDigestBytes
* @param algorithmURI
*/
- public void addDigest(byte[] x509certificateDigestBytes, String algorithmURI) {
- this.add(new XMLX509Digest(getDocument(), x509certificateDigestBytes, algorithmURI));
+ public void addDigest(byte[] x509CertificateDigestBytes, String algorithmURI) {
+ this.add(new XMLX509Digest(getDocument(), x509CertificateDigestBytes, algorithmURI));
}
/**
* Method add
*
- * @param XMLX509Digest
+ * @param xmlX509Digest
*/
public void add(XMLX509Digest xmlX509Digest) {
appendSelf(xmlX509Digest);
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/keyresolver/implementations/KeyInfoReferenceResolver.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/keyresolver/implementations/KeyInfoReferenceResolver.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/keyresolver/implementations/KeyInfoReferenceResolver.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/keyresolver/implementations/KeyInfoReferenceResolver.java Mon Apr 7 05:12:23 2014
@@ -217,7 +217,7 @@ public class KeyInfoReferenceResolver ex
* @param uri
* @param baseURI
* @param secureValidation
- * @return
+ * @return the XML signature input represented by the specified URI.
* @throws XMLSecurityException
*/
private XMLSignatureInput resolveInput(Attr uri, String baseURI, boolean secureValidation)
@@ -230,7 +230,7 @@ public class KeyInfoReferenceResolver ex
* Resolve the Element effectively represented by the XML signature input source.
*
* @param resource
- * @return
+ * @return the Element effectively represented by the XML signature input source.
* @throws CanonicalizationException
* @throws ParserConfigurationException
* @throws IOException
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/keyresolver/implementations/RetrievalMethodResolver.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/keyresolver/implementations/RetrievalMethodResolver.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/keyresolver/implementations/RetrievalMethodResolver.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/keyresolver/implementations/RetrievalMethodResolver.java Mon Apr 7 05:12:23 2014
@@ -219,7 +219,7 @@ public class RetrievalMethodResolver ext
* @param e
* @param baseURI
* @param storage
- * @return
+ * @return a x509Certificate from the given information
* @throws KeyResolverException
*/
private static X509Certificate resolveCertificate(
@@ -241,7 +241,7 @@ public class RetrievalMethodResolver ext
* @param e
* @param baseURI
* @param storage
- * @return
+ * @return a PublicKey from the given information
* @throws KeyResolverException
*/
private static PublicKey resolveKey(
@@ -292,7 +292,7 @@ public class RetrievalMethodResolver ext
/**
* Resolves the input from the given retrieval method
- * @return
+ * @return the input from the given retrieval method
* @throws XMLSecurityException
*/
private static XMLSignatureInput resolveInput(
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/keyresolver/implementations/SingleKeyResolver.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/keyresolver/implementations/SingleKeyResolver.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/keyresolver/implementations/SingleKeyResolver.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/keyresolver/implementations/SingleKeyResolver.java Mon Apr 7 05:12:23 2014
@@ -58,7 +58,7 @@ public class SingleKeyResolver extends K
* This method returns whether the KeyResolverSpi is able to perform the requested action.
*
* @param element
- * @param BaseURI
+ * @param baseURI
* @param storage
* @return whether the KeyResolverSpi is able to perform the requested action.
*/
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/keyresolver/implementations/X509DigestResolver.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/keyresolver/implementations/X509DigestResolver.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/keyresolver/implementations/X509DigestResolver.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/keyresolver/implementations/X509DigestResolver.java Mon Apr 7 05:12:23 2014
@@ -91,7 +91,7 @@ public class X509DigestResolver extends
* @param element
* @param baseURI
* @param storage
- * @return
+ * @return the certificate represented by the digest.
* @throws XMLSecurityException
*/
private X509Certificate resolveCertificate(Element element, String baseURI, StorageResolver storage)
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/keyresolver/implementations/X509SubjectNameResolver.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/keyresolver/implementations/X509SubjectNameResolver.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/keyresolver/implementations/X509SubjectNameResolver.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/keys/keyresolver/implementations/X509SubjectNameResolver.java Mon Apr 7 05:12:23 2014
@@ -43,7 +43,7 @@ public class X509SubjectNameResolver ext
* Method engineResolvePublicKey
*
* @param element
- * @param BaseURI
+ * @param baseURI
* @param storage
* @return null if no {@link PublicKey} could be obtained
* @throws KeyResolverException
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/stax/securityToken/InboundSecurityToken.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/stax/securityToken/InboundSecurityToken.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/stax/securityToken/InboundSecurityToken.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/stax/securityToken/InboundSecurityToken.java Mon Apr 7 05:12:23 2014
@@ -78,7 +78,7 @@ public interface InboundSecurityToken ex
/**
* Returns the first XMLEvent for this token
*
- * @return
+ * @return the first XMLEvent for this token
*/
XMLSecEvent getXMLSecEvent();
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/stax/securityToken/OutboundSecurityToken.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/stax/securityToken/OutboundSecurityToken.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/stax/securityToken/OutboundSecurityToken.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/stax/securityToken/OutboundSecurityToken.java Mon Apr 7 05:12:23 2014
@@ -31,9 +31,9 @@ import org.apache.xml.security.exception
public interface OutboundSecurityToken extends SecurityToken {
/**
- * Returns the responsible processor for this token
+ * Returns the processor responsible for this token
*
- * @return
+ * @return the processor responsible for this token
*/
Object getProcessor();
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/stax/securityToken/SecurityToken.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/stax/securityToken/SecurityToken.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/stax/securityToken/SecurityToken.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/stax/securityToken/SecurityToken.java Mon Apr 7 05:12:23 2014
@@ -53,7 +53,7 @@ public interface SecurityToken {
/**
* Returns the public key if one exists and already initialized, null otherwise
- * @return
+ * @return the public key
* @throws org.apache.xml.security.exceptions.XMLSecurityException
*/
PublicKey getPublicKey() throws XMLSecurityException;
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/Base64.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/Base64.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/Base64.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/Base64.java Mon Apr 7 05:12:23 2014
@@ -209,7 +209,7 @@ public class Base64 {
/**
* Decode a base 64 string into a {@link BigInteger}
* @param base64str Base 64 encoded string.
- * @return
+ * @return a decoded BigInteger
* @throws Base64DecodingException
*/
public static BigInteger decodeBigIntegerFromString(String base64str)
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/ElementProxy.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/ElementProxy.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/ElementProxy.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/ElementProxy.java Mon Apr 7 05:12:23 2014
@@ -519,7 +519,7 @@ public abstract class ElementProxy {
*
* @param elem New element
*
- * @see #getWrappedElement()
+ * @see #getElement()
*/
protected void setElement(Element elem) {
wrappedElement = elem;
@@ -530,7 +530,7 @@ public abstract class ElementProxy {
*
* @param doc New document object being wrapped.
*
- * @see #getWrappedDocument()
+ * @see #getDocument()
*/
protected void setDocument(Document doc) {
wrappedDoc = doc;
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/resolver/ResourceResolver.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/resolver/ResourceResolver.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/resolver/ResourceResolver.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/resolver/ResourceResolver.java Mon Apr 7 05:12:23 2014
@@ -59,7 +59,7 @@ public class ResourceResolver {
/**
* Method getInstance
*
- * @param uri
+ * @param uriAttr
* @param baseURI
* @param secureValidation
* @return the instance
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/resolver/ResourceResolverSpi.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/resolver/ResourceResolverSpi.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/resolver/ResourceResolverSpi.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/resolver/ResourceResolverSpi.java Mon Apr 7 05:12:23 2014
@@ -100,8 +100,6 @@ public abstract class ResourceResolverSp
* This method helps the {@link ResourceResolver} to decide whether a
* {@link ResourceResolverSpi} is able to perform the requested action.
*
- * <p>New clients should override this method, and not override {@link #engineCanResolve(Attr, String)}
- * </p>
* @param context Context in which to do resolution.
* @return true if the engine can resolve the uri
*/
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/resolver/implementations/ResolverDirectHTTP.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/resolver/implementations/ResolverDirectHTTP.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/resolver/implementations/ResolverDirectHTTP.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/resolver/implementations/ResolverDirectHTTP.java Mon Apr 7 05:12:23 2014
@@ -91,14 +91,7 @@ public class ResolverDirectHTTP extends
}
/**
- * Method resolve
- *
- * @param uri
- * @param baseURI
- *
- * @throws ResourceResolverException
- * @return
- * $todo$ calculate the correct URI from the attribute and the baseURI
+ * @inheritDoc
*/
@Override
public XMLSignatureInput engineResolveURI(ResourceResolverContext context)
@@ -204,8 +197,7 @@ public class ResolverDirectHTTP extends
/**
* We resolve http URIs <I>without</I> fragment...
*
- * @param uri
- * @param baseURI
+ * @param context
* @return true if can be resolved
*/
public boolean engineCanResolveURI(ResourceResolverContext context) {
Modified: santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/resolver/implementations/ResolverFragment.java
URL: http://svn.apache.org/viewvc/santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/resolver/implementations/ResolverFragment.java?rev=1585385&r1=1585384&r2=1585385&view=diff
==============================================================================
--- santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/resolver/implementations/ResolverFragment.java (original)
+++ santuario/xml-security-java/trunk/src/main/java/org/apache/xml/security/utils/resolver/implementations/ResolverFragment.java Mon Apr 7 05:12:23 2014
@@ -46,11 +46,7 @@ public class ResolverFragment extends Re
}
/**
- * Method engineResolve
- *
* @inheritDoc
- * @param uri
- * @param baseURI
*/
@Override
public XMLSignatureInput engineResolveURI(ResourceResolverContext context)
@@ -118,8 +114,7 @@ public class ResolverFragment extends Re
/**
* Method engineCanResolve
* @inheritDoc
- * @param uri
- * @param baseURI
+ * @param context
*/
public boolean engineCanResolveURI(ResourceResolverContext context) {
if (context.uriToResolve == null) {