[jira] [Commented] (DERBY-6478) Fix language about supported DataSources for Compact Profiles

["Dag H. Wanvik (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/DERBY-6478?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13919830#comment-13919830 ] 

Dag H. Wanvik commented on DERBY-6478:
--------------------------------------

Hi Kim, just read this patch. Some nits which you may ignore or fix, your call:

{quote}
  ref/rrefattribtracelevel.html: "Use the
  org.apache.derby.jdbc.ClientDataSource class on all supported Java
  SE versions except Java SE 8 Compact Profile 2."
{quote}
  Strictly speaking, since we do not support Derby at all on CP1, we should
  perhaps say something like

  org.apache.derby.jdbc.ClientDataSource can be used on all Java SE
  versions supported for Derby except Java SE 8 Compact Profile 2,
  which can only use org.apache.derby.jdbc.BasicClientDataSource40
  which doesn not support JNDI naming.

  The latter is usable also with CP3 and full SE versions, though.
{quote}
{noformat}
* ref/rrefapi1003363.html:

"Embedded environment:

    org.apache.derby.jdbc.EmbeddedDataSource
    org.apache.derby.jdbc.EmbeddedConnectionPoolDataSource
    org.apache.derby.jdbc.EmbeddedXADataSource

 Embedded environment, for applications using Java SE 8 Compact Profile 2 or 3:

    org.apache.derby.jdbc.BasicEmbeddedDataSource40
    org.apache.derby.jdbc.BasicEmbeddedConnectionPoolDataSource40
    org.apache.derby.jdbc.BasicEmbeddedXADataSource40"
{noformat}
{quote}
Again, the "Basic*" classes are more limited and optional for all Java
SE except CP 2 for which they are the only offering. Normally, CP3 and
full SE would use the Embedded* variants.
{quote}
* ref/rrefjdbc4_2compactprofiles.html
{quote}  
  has the same issue: it implies the CP 3 needs to use the Basic*
  versions.
{quote}
* devguide/rdevresman79556.html

  "Applications that run on Compact Profile 3 may use either variant."
{quote}

  -> "Applications that run on Compact Profile 3 or full SE may use
     either variant."

The admin sections changed, all advise that the user should use
Embedded* variant except for on CP2.  I'd prefer the above wording
which shows that >= CP can use either variant, but CP can only use
Basic* variants.


> Fix language about supported DataSources for Compact Profiles
> -------------------------------------------------------------
>
>                 Key: DERBY-6478
>                 URL: https://issues.apache.org/jira/browse/DERBY-6478
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.11.0.0
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>            Priority: Minor
>             Fix For: 10.11.0.0
>
>         Attachments: DERBY-6478-2.diff, DERBY-6478-2.zip, DERBY-6478.diff, DERBY-6478.stat, DERBY-6478.zip
>
>
> Knut Anders Hatlen pointed out the following in his review of a patch for DERBY-6236:
> "One little inaccuracy in the changed text (existing problem, not introduced by the patch): It seems to imply that only the basic data sources work on Compact Profile 3. That is not the case. The ordinary data sources are supported on CP3. Only CP2 lacks the necessary classes (javax.naming.*) and need the basic data sources. (The basic data sources do work on CP3, though, so it's not a problem if applications choose to use them if they don't need the extra functionality of the ordinary data sources.)"
> This means that numerous topics in the Admin Guide, Reference Manual, and Developer's Guide probably need some fixes. For example, the topic "JDBC support for Java SE 8 Compact Profiles" in the Reference Manual should probably add something like the following at the end of the topic:
> "Users of Compact Profile 3 on the Java SE 8 platform can use either these DataSource classes or the Datasource classes for the full Java SE platform." 
> As another example, the topic "Network client security" in the Admin Guide should probably be changed to something like this:
> "Derby provides two ClientDataSource implementations. Use the org.apache.derby.jdbc.ClientDataSource class on all supported Java SE versions except Java SE 8 Compact Profiles 1 and 2. On Java SE 8 Compact Profile 2, use the org.apache.derby.jdbc.BasicClientDataSource40 class."
> Please let me know if these tweaks need further tweaking -- in the meantime I will start work on implementing them. Thanks.



--
This message was sent by Atlassian JIRA
(v6.2#6252)