You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@harmony.apache.org by "Jesse Wilson (JIRA)" <ji...@apache.org> on 2009/04/28 02:47:30 UTC

[jira] Created: (HARMONY-6185) Javadocs for java.security.* and javax.security.cert.*

Javadocs for java.security.* and javax.security.cert.*
------------------------------------------------------

                 Key: HARMONY-6185
                 URL: https://issues.apache.org/jira/browse/HARMONY-6185
             Project: Harmony
          Issue Type: Improvement
          Components: Classlib
         Environment: SVN Revision: 769151
            Reporter: Jesse Wilson
            Priority: Minor
             Fix For: 5.0M10


Improvements to security Javadocs from Android.
http://developer.android.com/reference/java/security/package-summary.html
http://developer.android.com/reference/javax/security/cert/package-summary.html

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Resolved: (HARMONY-6185) Javadocs for java.security.* and javax.security.cert.*

Posted by "Tim Ellison (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HARMONY-6185?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tim Ellison resolved HARMONY-6185.
----------------------------------

    Resolution: Fixed

I agree that the comment isn't particularly helpful to the end users.  If anything it is an implementation note for the curious.

I've made a slight modification to the patch, simply to change:

Index: modules/security/src/main/java/common/java/security/Permission.java
===================================================================
--- modules/security/src/main/java/common/java/security/Permission.java	(revision 769464)
+++ modules/security/src/main/java/common/java/security/Permission.java	(working copy)
@@ -63,8 +63,8 @@
      * this permission. The returned actions are in canonical form. For example:
      *
      * <pre>
-     * sp0 = new SocketPermission(&quot;www.google.com&quot;, &quot;connect,resolve&quot;)
-     * sp1 = new SocketPermission(&quot;www.google.com&quot;, &quot;resolve,connect&quot;)
+     * sp0 = new SocketPermission(&quot;www.example.com&quot;, &quot;connect,resolve&quot;)
+     * sp1 = new SocketPermission(&quot;www.example.com&quot;, &quot;resolve,connect&quot;)
      * sp0.getActions().equals(sp1.getActions()) //yields true
      * </pre>
      *

so the code remains 'generic'.

FYI I spotted a few places where the 'spec_ref' tags still exist in the security module.  I'll go and fix them after this commit.

The patch was applied to the SECURITY module at repo revision r769463.

> Javadocs for java.security.* and javax.security.cert.*
> ------------------------------------------------------
>
>                 Key: HARMONY-6185
>                 URL: https://issues.apache.org/jira/browse/HARMONY-6185
>             Project: Harmony
>          Issue Type: Improvement
>          Components: Classlib
>         Environment: SVN Revision: 769151
>            Reporter: Jesse Wilson
>            Assignee: Tim Ellison
>            Priority: Minor
>             Fix For: 5.0M10
>
>         Attachments: Security_Javadoc_from_Android.patch
>
>   Original Estimate: 1h
>  Remaining Estimate: 1h
>
> Improvements to security Javadocs from Android.
> http://developer.android.com/reference/java/security/package-summary.html
> http://developer.android.com/reference/javax/security/cert/package-summary.html

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (HARMONY-6185) Javadocs for java.security.* and javax.security.cert.*

Posted by "Jesse Wilson (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HARMONY-6185?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Jesse Wilson updated HARMONY-6185:
----------------------------------

    Attachment: Security_Javadoc_from_Android.patch

There's a few places where the previous Javadoc pointed out a problem with the 1.4 implementation. For example, KeyPairGenerator#getInstance() had this doc:

    /**
     * @com.intel.drl.spec_ref
     * 
     * throws NullPointerException if algorithm is null (instead of
     * NoSuchAlgorithmException) as in 1.4 release
     */
    public static KeyPairGenerator getInstance(String algorithm,

I've omitted mention of what the previous releases did. My reasoning is that there's many classlib versions and implementations, and it's almost impossible to document the bugs in each.

If you'd like me to restore these notes as they were, please let me know and I'll prepare another patch.

> Javadocs for java.security.* and javax.security.cert.*
> ------------------------------------------------------
>
>                 Key: HARMONY-6185
>                 URL: https://issues.apache.org/jira/browse/HARMONY-6185
>             Project: Harmony
>          Issue Type: Improvement
>          Components: Classlib
>         Environment: SVN Revision: 769151
>            Reporter: Jesse Wilson
>            Priority: Minor
>             Fix For: 5.0M10
>
>         Attachments: Security_Javadoc_from_Android.patch
>
>   Original Estimate: 1h
>  Remaining Estimate: 1h
>
> Improvements to security Javadocs from Android.
> http://developer.android.com/reference/java/security/package-summary.html
> http://developer.android.com/reference/javax/security/cert/package-summary.html

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Assigned: (HARMONY-6185) Javadocs for java.security.* and javax.security.cert.*

Posted by "Tim Ellison (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HARMONY-6185?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tim Ellison reassigned HARMONY-6185:
------------------------------------

    Assignee: Tim Ellison

> Javadocs for java.security.* and javax.security.cert.*
> ------------------------------------------------------
>
>                 Key: HARMONY-6185
>                 URL: https://issues.apache.org/jira/browse/HARMONY-6185
>             Project: Harmony
>          Issue Type: Improvement
>          Components: Classlib
>         Environment: SVN Revision: 769151
>            Reporter: Jesse Wilson
>            Assignee: Tim Ellison
>            Priority: Minor
>             Fix For: 5.0M10
>
>         Attachments: Security_Javadoc_from_Android.patch
>
>   Original Estimate: 1h
>  Remaining Estimate: 1h
>
> Improvements to security Javadocs from Android.
> http://developer.android.com/reference/java/security/package-summary.html
> http://developer.android.com/reference/javax/security/cert/package-summary.html

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Closed: (HARMONY-6185) Javadocs for java.security.* and javax.security.cert.*

Posted by "Jesse Wilson (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HARMONY-6185?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Jesse Wilson closed HARMONY-6185.
---------------------------------


Looks good to me.

> Javadocs for java.security.* and javax.security.cert.*
> ------------------------------------------------------
>
>                 Key: HARMONY-6185
>                 URL: https://issues.apache.org/jira/browse/HARMONY-6185
>             Project: Harmony
>          Issue Type: Improvement
>          Components: Classlib
>         Environment: SVN Revision: 769151
>            Reporter: Jesse Wilson
>            Assignee: Tim Ellison
>            Priority: Minor
>             Fix For: 5.0M10
>
>         Attachments: Security_Javadoc_from_Android.patch
>
>   Original Estimate: 1h
>  Remaining Estimate: 1h
>
> Improvements to security Javadocs from Android.
> http://developer.android.com/reference/java/security/package-summary.html
> http://developer.android.com/reference/javax/security/cert/package-summary.html

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.