OpenJPA
  1. OpenJPA
  2. OPENJPA-927

Fix definition of javax.persistence.query.timeout property

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 2.0.0-M2
    • Fix Version/s: 2.0.0-M2
    • Component/s: kernel
    • Labels:
      None

      Description

      This was originally reported by Pinaki in OPENJPA-849. It is being moved to this new JIRA. Here's Pinaki's original comment:

      queryTimeout.setLoadKey("javax.persistence.query.timeout");
      queryTimeout.setDefault("-1");
      queryTimeout.set(-1);
      queryTimeout.setDynamic(true);

      does not seem kosher for the following reason:

      1. loadKey is the key with which a property is loaded from configuration artifacts. At this point of execution, no property has been actually loaded, they are merely being declared to exist. Hence we should not be setting load key.
      2. configuration declares a Value. But does not assign its value. So setting its value to -1 does not look alright. Setting default value is OK.

      These issues gain significance in the light of the fact the configuration's hashcode is the key to a factory in JNDI. And computation of hashcode depends on the actual value of the Values.
      As an extreme example, assume two Configuration C1 and C2 nearly identical but differs only in their query.timeout value. The requirement is hash code for C1 and C2 must not be equal. And that is what Configuration.hashCode() ensures. But, because we are setting query timeout to -1 (that is not what the user's p.xml sets) and it is marked as dynamic, in both cases Configuration hashcode will treat query.timeout value to be -1 and will end up computing same hashcode for C1 and C2.

      1. OPENJPA-927-trunk.patch
        104 kB
        Donald Woods
      2. patch.txt
        7 kB
        Dianne Richards

        Issue Links

          Activity

          Hide
          Dianne Richards added a comment -

          Thanks for checking this out Pinaki.

          >1. loadKey is the key with which a property is loaded from configuration artifacts. At this point of execution, no property has been >actually loaded, they are merely being declared to exist. Hence we should not be setting load key.

          I now understand this and will change it. But, we have to solve a problem if we don't do this. The getProperties() methods return all defined properties, even if they have not been explicitly set. This calls the Configuration .toProperties() method which calls the setValue() method. By default, if we don't do anything, the value javax.persistence.query.timeout will be prefixed with "openjpa.", which is not good. We can get around this doing a setEquivalentKey() instead. But, now I'm wondering what we'll get with the getSupportedProperties() with this change. I'll have to investigat that. But, if that's ok, is this a reasonable alternative? Or, should I figure out something else?

          The other option is to define a new openjpa property, such as openjpa.QueryTimeout. I was trying to avoid that option. I'm not sure we want to define a new openjpa property for every new spec property.

          >2. configuration declares a Value. But does not assign its value. So setting its value to -1 does not look alright. Setting default >value is OK.

          ok - But, I modeled this after the openjpa.LockTimeout definition. So, does this one need to be corrected too?

          Show
          Dianne Richards added a comment - Thanks for checking this out Pinaki. >1. loadKey is the key with which a property is loaded from configuration artifacts. At this point of execution, no property has been > actually loaded, they are merely being declared to exist. Hence we should not be setting load key. I now understand this and will change it. But, we have to solve a problem if we don't do this. The getProperties() methods return all defined properties, even if they have not been explicitly set. This calls the Configuration .toProperties() method which calls the setValue() method. By default, if we don't do anything, the value javax.persistence.query.timeout will be prefixed with "openjpa.", which is not good. We can get around this doing a setEquivalentKey() instead. But, now I'm wondering what we'll get with the getSupportedProperties() with this change. I'll have to investigat that. But, if that's ok, is this a reasonable alternative? Or, should I figure out something else? The other option is to define a new openjpa property, such as openjpa.QueryTimeout. I was trying to avoid that option. I'm not sure we want to define a new openjpa property for every new spec property. >2. configuration declares a Value. But does not assign its value. So setting its value to -1 does not look alright. Setting default >value is OK. ok - But, I modeled this after the openjpa.LockTimeout definition. So, does this one need to be corrected too?
          Hide
          Dianne Richards added a comment -

          Here's a patch that does the following:

          1 - Changes the setLoadKey() for javax.persistence.query.timeout to setEquivalentKey()
          2 - Removes the set(-1) for the query timeout and lock timeout properties
          3 - Removes from the EM getProperties Map the Connection2Password property

          Show
          Dianne Richards added a comment - Here's a patch that does the following: 1 - Changes the setLoadKey() for javax.persistence.query.timeout to setEquivalentKey() 2 - Removes the set(-1) for the query timeout and lock timeout properties 3 - Removes from the EM getProperties Map the Connection2Password property
          Hide
          Donald Woods added a comment -

          Thanks Dianne. Here is a version of the unmodified patch for non-Eclipse users.

          Show
          Donald Woods added a comment - Thanks Dianne. Here is a version of the unmodified patch for non-Eclipse users.
          Hide
          Donald Woods added a comment -

          Note: my patch is a lot larger, as it removes the Windows ^M chars off every line of EntityManagerImpl.java, since I have my svn config properties setup as suggested by the ASF....

          Show
          Donald Woods added a comment - Note: my patch is a lot larger, as it removes the Windows ^M chars off every line of EntityManagerImpl.java, since I have my svn config properties setup as suggested by the ASF....
          Hide
          Donald Woods added a comment -

          Dianne, your patch is working for me. Can you commit it?

          Show
          Donald Woods added a comment - Dianne, your patch is working for me. Can you commit it?
          Hide
          Jeremy Bauer added a comment -

          Committed Dianne's patch (with modifications) under revisions 750112 750113 750115 750117.

          Show
          Jeremy Bauer added a comment - Committed Dianne's patch (with modifications) under revisions 750112 750113 750115 750117.
          Hide
          Donald Woods added a comment -

          Dianne, can this be marked as resolved now?

          Show
          Donald Woods added a comment - Dianne, can this be marked as resolved now?
          Hide
          Alan Raison added a comment -

          The test org.apache.openjpa.persistence.simple.TestPropertiesMethods contains a derby connection string. This is problematic if Derby is not being used to test.

          I think removing the setting of the openjpa.ConnectionURL property will fix this - but I'm not sure if this nullifies the test!

          Show
          Alan Raison added a comment - The test org.apache.openjpa.persistence.simple.TestPropertiesMethods contains a derby connection string. This is problematic if Derby is not being used to test. I think removing the setting of the openjpa.ConnectionURL property will fix this - but I'm not sure if this nullifies the test!

            People

            • Assignee:
              Dianne Richards
              Reporter:
              Dianne Richards
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development