JDK 9 RFR of doclint fixes in javax.xml.crypto.dsig

Thu Jan 2 14:17:20 UTC 2014

Looks good.

--Sean

On 12/30/2013 01:26 PM, Joe Darcy wrote:
> Hello,
>
> In the course of working on some further doclint cleanup for JDK 9, I
> came across a variety of minor issues in javax.xml.crypto.dsig. Please
> review the patch below for JDK 9.
>
> Thanks,
>
> -Joe
>
> ---
> old/src/share/classes/javax/xml/crypto/dsig/CanonicalizationMethod.java
> 2013-12-30 10:22:50.000000000 -
> 0800
> +++
> new/src/share/classes/javax/xml/crypto/dsig/CanonicalizationMethod.java
> 2013-12-30 10:22:50.000000000 -
> 0800
> @@ -1,5 +1,5 @@
>   /*
> - * Copyright (c) 2005, Oracle and/or its affiliates. All rights reserved.
> + * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights
> reserved.
>    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
>    *
>    * This code is free software; you can redistribute it and/or modify it
> @@ -36,7 +36,6 @@
>    * <a href="http://www.w3.org/TR/xmldsig-core/">
>    * W3C Recommendation for XML-Signature Syntax and Processing</a>. The
> XML
>    * Schema Definition is defined as:
> - * <p>
>    * <pre>
>    *   <element name="CanonicalizationMethod"
> type="ds:CanonicalizationMethodType"/>
>    *     <complexType name="CanonicalizationMethodType" mixed="true">
> --- old/src/share/classes/javax/xml/crypto/dsig/DigestMethod.java
> 2013-12-30 10:22:51.000000000 -0800
> +++ new/src/share/classes/javax/xml/crypto/dsig/DigestMethod.java
> 2013-12-30 10:22:51.000000000 -0800
> @@ -1,5 +1,5 @@
>   /*
> - * Copyright (c) 2005, Oracle and/or its affiliates. All rights reserved.
> + * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights
> reserved.
>    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
>    *
>    * This code is free software; you can redistribute it and/or modify it
> @@ -37,7 +37,6 @@
>    * defined in the <a href="http://www.w3.org/TR/xmldsig-core/">
>    * W3C Recommendation for XML-Signature Syntax and Processing</a>.
>    * The XML Schema Definition is defined as:
> - * <p>
>    * <pre>
>    *   <element name="DigestMethod" type="ds:DigestMethodType"/>
>    *     <complexType name="DigestMethodType" mixed="true">
> --- old/src/share/classes/javax/xml/crypto/dsig/Reference.java
> 2013-12-30 10:22:51.000000000 -0800
> +++ new/src/share/classes/javax/xml/crypto/dsig/Reference.java
> 2013-12-30 10:22:51.000000000 -0800
> @@ -1,5 +1,5 @@
>   /*
> - * Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights
> reserved.
> + * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights
> reserved.
>    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
>    *
>    * This code is free software; you can redistribute it and/or modify it
> @@ -38,7 +38,7 @@
>    * <a href="http://www.w3.org/TR/xmldsig-core/">
>    * W3C Recommendation for XML-Signature Syntax and Processing</a>.
>    * The XML schema is defined as:
> - * <code><pre>
> + * <pre>
>    * <element name="Reference" type="ds:ReferenceType"/>
>    * <complexType name="ReferenceType">
>    *   <sequence>
> @@ -55,7 +55,7 @@
>    * <simpleType name="DigestValueType">
>    *   <restriction base="base64Binary"/>
>    * </simpleType>
> - * </pre></code>
> + * </pre>
>    *
>    * <p>A <code>Reference</code> instance may be created by invoking one
> of the
>    * {@link XMLSignatureFactory#newReference newReference} methods of the
> @@ -145,7 +145,7 @@
>
>       /**
>        * Returns the dereferenced data, if
> -     * <a href="XMLSignContext.html#Supported Properties">reference
> caching</a>
> +     * <a href="XMLSignContext.html#Supported%20Properties">reference
> caching</a>
>        * is enabled. This is the result of dereferencing the URI of this
>        * reference during a validation or generation operation.
>        *
> @@ -157,7 +157,7 @@
>
>       /**
>        * Returns the pre-digested input stream, if
> -     * <a href="XMLSignContext.html#Supported Properties">reference
> caching</a>
> +     * <a href="XMLSignContext.html#Supported%20Properties">reference
> caching</a>
>        * is enabled. This is the input to the digest operation during a
>        * validation or signing operation.
>        *
> --- old/src/share/classes/javax/xml/crypto/dsig/SignatureMethod.java
> 2013-12-30 10:22:52.000000000 -0800
> +++ new/src/share/classes/javax/xml/crypto/dsig/SignatureMethod.java
> 2013-12-30 10:22:52.000000000 -0800
> @@ -1,5 +1,5 @@
>   /*
> - * Copyright (c) 2005, Oracle and/or its affiliates. All rights reserved.
> + * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights
> reserved.
>    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
>    *
>    * This code is free software; you can redistribute it and/or modify it
> @@ -37,7 +37,6 @@
>    * as defined in the <a href="http://www.w3.org/TR/xmldsig-core/">
>    * W3C Recommendation for XML-Signature Syntax and Processing</a>.
>    * The XML Schema Definition is defined as:
> - * <p>
>    * <pre>
>    *   <element name="SignatureMethod"
> type="ds:SignatureMethodType"/>
>    *     <complexType name="SignatureMethodType" mixed="true">
> --- old/src/share/classes/javax/xml/crypto/dsig/TransformService.java
> 2013-12-30 10:22:52.000000000 -0800
> +++ new/src/share/classes/javax/xml/crypto/dsig/TransformService.java
> 2013-12-30 10:22:52.000000000 -0800
> @@ -1,5 +1,5 @@
>   /*
> - * Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights
> reserved.
> + * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights
> reserved.
>    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
>    *
>    * This code is free software; you can redistribute it and/or modify it
> @@ -71,9 +71,9 @@
>    * <code>TransformService</code> implementations that support the DOM
>    * mechanism type must abide by the DOM interoperability requirements
> defined
>    * in the
> - * <a
> href="../../../../../technotes/guides/security/xmldsig/overview.html#DOM
> Mechanism Requirements">
> + * <a
> href="../../../../../technotes/guides/security/xmldsig/overview.html#DOM%20Mechanism%20Requirements">
>
>    * DOM Mechanism Requirements</a> section of the API overview. See the
> - * <a
> href="../../../../../technotes/guides/security/xmldsig/overview.html#Service
> Provider">
> + * <a
> href="../../../../../technotes/guides/security/xmldsig/overview.html#Service%20Provider">
>
>    * Service Providers</a> section of the API overview for a list of
> standard
>    * mechanism types.
>    * <p>
> --- old/src/share/classes/javax/xml/crypto/dsig/XMLSignContext.java
> 2013-12-30 10:22:53.000000000 -0800
> +++ new/src/share/classes/javax/xml/crypto/dsig/XMLSignContext.java
> 2013-12-30 10:22:53.000000000 -0800
> @@ -1,5 +1,5 @@
>   /*
> - * Copyright (c) 2005, Oracle and/or its affiliates. All rights reserved.
> + * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights
> reserved.
>    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
>    *
>    * This code is free software; you can redistribute it and/or modify it
> @@ -41,7 +41,7 @@
>    * (for example, you should not use the same <code>XMLSignContext</code>
>    * instance to sign two different {@link XMLSignature} objects).
>    * <p>
> - * <b><a name="Supported Properties"></a>Supported Properties</b>
> + * <b><a name="SupportedProperties"></a>Supported Properties</b>
>    * <p>The following properties can be set using the
>    * {@link #setProperty setProperty} method.
>    * <ul>
> --- old/src/share/classes/javax/xml/crypto/dsig/XMLSignature.java
> 2013-12-30 10:22:53.000000000 -0800
> +++ new/src/share/classes/javax/xml/crypto/dsig/XMLSignature.java
> 2013-12-30 10:22:53.000000000 -0800
> @@ -1,5 +1,5 @@
>   /*
> - * Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights
> reserved.
> + * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights
> reserved.
>    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
>    *
>    * This code is free software; you can redistribute it and/or modify it
> @@ -187,7 +187,6 @@
>        * defined in the <a href="http://www.w3.org/TR/xmldsig-core/">
>        * W3C Recommendation for XML-Signature Syntax and Processing</a>.
>        * The XML Schema Definition is defined as:
> -     * <p>
>        * <pre>
>        *   <element name="SignatureValue"
> type="ds:SignatureValueType"/>
>        *     <complexType name="SignatureValueType">
> --- old/src/share/classes/javax/xml/crypto/dsig/XMLSignatureFactory.java
> 2013-12-30 10:22:54.000000000 -
> 0800
> +++ new/src/share/classes/javax/xml/crypto/dsig/XMLSignatureFactory.java
> 2013-12-30 10:22:53.000000000 -
> 0800
> @@ -1,5 +1,5 @@
>   /*
> - * Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights
> reserved.
> + * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights
> reserved.
>    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
>    *
>    * This code is free software; you can redistribute it and/or modify it
> @@ -67,9 +67,9 @@
>    *
>    * <p>The objects that this factory produces will be based
>    * on DOM and abide by the DOM interoperability requirements as
> defined in the
> - * <a
> href="../../../../../technotes/guides/security/xmldsig/overview.html#DOM
> Mechanism Requirements">
> + * <a
> href="../../../../../technotes/guides/security/xmldsig/overview.html#DOM%20Mechanism%20Requirements">
>
>    * DOM Mechanism Requirements</a> section of the API overview. See the
> - * <a
> href="../../../../../technotes/guides/security/xmldsig/overview.html#Service
> Provider">
> + * <a
> href="../../../../../technotes/guides/security/xmldsig/overview.html#Service%20Provider">
>
>    * Service Providers</a> section of the API overview for a list of
> standard
>    * mechanism types.
>    *
> @@ -175,7 +175,7 @@
>        *
>        * @param mechanismType the type of the XML processing mechanism and
>        *    representation. See the <a
> -     *
> href="../../../../../technotes/guides/security/xmldsig/overview.html#Service
> Provider">
> +     *
> href="../../../../../technotes/guides/security/xmldsig/overview.html#Service%20Provider">
>
>        *    Service Providers</a> section of the API overview for a list of
>        *    standard mechanism types.
>        * @return a new <code>XMLSignatureFactory</code>
> @@ -212,7 +212,7 @@
>        *
>        * @param mechanismType the type of the XML processing mechanism and
>        *    representation. See the <a
> -     *
> href="../../../../../technotes/guides/security/xmldsig/overview.html#Service
> Provider">
> +     *
> href="../../../../../technotes/guides/security/xmldsig/overview.html#Service%20Provider">
>
>        *    Service Providers</a> section of the API overview for a list of
>        *    standard mechanism types.
>        * @param provider the <code>Provider</code> object
> @@ -256,7 +256,7 @@
>        *
>        * @param mechanismType the type of the XML processing mechanism and
>        *    representation. See the <a
> -     *
> href="../../../../../technotes/guides/security/xmldsig/overview.html#Service
> Provider">
> +     *
> href="../../../../../technotes/guides/security/xmldsig/overview.html#Service%20Provider">
>
>        *    Service Providers</a> section of the API overview for a list of
>        *    standard mechanism types.
>        * @param provider the string name of the provider
> --- old/src/share/classes/javax/xml/crypto/dsig/XMLValidateContext.java
> 2013-12-30 10:22:54.000000000 -0800
> +++ new/src/share/classes/javax/xml/crypto/dsig/XMLValidateContext.java
> 2013-12-30 10:22:54.000000000 -0800
> @@ -1,5 +1,5 @@
>   /*
> - * Copyright (c) 2005, Oracle and/or its affiliates. All rights reserved.
> + * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights
> reserved.
>    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
>    *
>    * This code is free software; you can redistribute it and/or modify it
> @@ -40,7 +40,7 @@
>    * (for example, you should not use the same
> <code>XMLValidateContext</code>
>    * instance to validate two different {@link XMLSignature} objects).
>    * <p>
> - * <b><a name="Supported Properties"></a>Supported Properties</b>
> + * <b><a name="SupportedProperties"></a>Supported Properties</b>
>    * <p>The following properties can be set by an application using the
>    * {@link #setProperty setProperty} method.
>    * <ul>
> ---
> old/src/share/classes/javax/xml/crypto/dsig/keyinfo/KeyInfoFactory.java
> 2013-12-30 10:22:55.000000000 -
> 0800
> +++
> new/src/share/classes/javax/xml/crypto/dsig/keyinfo/KeyInfoFactory.java
> 2013-12-30 10:22:55.000000000 -
> 0800
> @@ -1,5 +1,5 @@
>   /*
> - * Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights
> reserved.
> + * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights
> reserved.
>    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
>    *
>    * This code is free software; you can redistribute it and/or modify it
> @@ -62,9 +62,9 @@
>    *
>    * <p>The objects that this factory produces will be based
>    * on DOM and abide by the DOM interoperability requirements as
> defined in the
> - * <a
> href="../../../../../../technotes/guides/security/xmldsig/overview.html#DOM
> Mechanism Requirements">
> + * <a
> href="../../../../../../technotes/guides/security/xmldsig/overview.html#DOM%20Mechanism%20Requirements">
>
>    * DOM Mechanism Requirements</a> section of the API overview. See the
> - * <a
> href="../../../../../../technotes/guides/security/xmldsig/overview.html#Service
> Provider">
> + * <a
> href="../../../../../../technotes/guides/security/xmldsig/overview.html#Service%20Provider">
>
>    * Service Providers</a> section of the API overview for a list of
> standard
>    * mechanism types.
>    *
> @@ -131,7 +131,7 @@
>        *
>        * @param mechanismType the type of the XML processing mechanism and
>        *    representation. See the <a
> -     *
> href="../../../../../../technotes/guides/security/xmldsig/overview.html#Service
> Provider">
> +     *
> href="../../../../../../technotes/guides/security/xmldsig/overview.html#Service%20Provider">
>
>        *    Service Providers</a> section of the API overview for a list of
>        *    standard mechanism types.
>        * @return a new <code>KeyInfoFactory</code>
> @@ -167,7 +167,7 @@
>        *
>        * @param mechanismType the type of the XML processing mechanism and
>        *    representation. See the <a
> -     *
> href="../../../../../../technotes/guides/security/xmldsig/overview.html#Service
> Provider">
> +     *
> href="../../../../../../technotes/guides/security/xmldsig/overview.html#Service%20Provider">
>
>        *    Service Providers</a> section of the API overview for a list of
>        *    standard mechanism types.
>        * @param provider the <code>Provider</code> object
> @@ -211,7 +211,7 @@
>        *
>        * @param mechanismType the type of the XML processing mechanism and
>        *    representation. See the <a
> -     *
> href="../../../../../../technotes/guides/security/xmldsig/overview.html#Service
> Provider">
> +     *
> href="../../../../../../technotes/guides/security/xmldsig/overview.html#Service%20Provider">
>
>        *    Service Providers</a> section of the API overview for a list of
>        *    standard mechanism types.
>        * @param provider the string name of the provider
>