Uploaded image for project: 'Cayenne'
  1. Cayenne
  2. CAY-1559

Use Lifecycle Annotations as markers on PersistentObject methods

    Details

    • Type: Improvement
    • Status: Reopened
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: 3.1M3, 3.1, Undefined future
    • Fix Version/s: None
    • Component/s: Core Library

      Description

      In my current project I have various abstract classes that my persistent objects inherit from. While experimenting with various new ways of using lifecycle listeners and their corresponding annotations available in 3.1, I found myself wanting to annotate a method on one of those abstract classes (say with @PostAdd) and have it act as a callback on all of its subclasses. Out of the box, I could get this to work the way I wanted by doing something like:

      public class SomeAbstractPersistantObject {

      ...

      @PostAdd(SomeAbstractPersistantObject.class)
      public void onPostAdd(Object object)

      { object.getObjectId() ... }

      }

      And then later on registering the listener by doing something like:

      serverRuntime.getDataDomain().getEntityResolver().getCallbackRegistry().addListener(new SomePersistentObject());

      The problem was that I didn't what to have to instantiate an object just to register it, or for that matter even have to register the listener in the first place. My callback is already part of the PersistentObject that it applies to and as such should "just work" for that object or anything that extends it. I wanted to be able to do something like:

      public class SomeAbstractPersistantObject {

      ...

      @PostAdd
      public void onPostAdd()

      { this.getObjectId() ... }

      }

      And that's it. Listeners/Callbacks defined in this manner are registered when lazy initialization of the callback registry occurs within the EntityResolver. All I have to do now is annotate a method within the persistent object that I want it to act on and don't have to worry about anything else.

      I don't know if this sort of thing would be useful to anyone but I have attached a patch that I believe does just that. I have been using it for a couple of days now and it seems to be working as intended without breaking the other available means of using lifecycle listeners.

        Attachments

        1. 0001-x.patch
          5 kB
          Andrus Adamchik
        2. LifecycleAnnotationMarker.patch
          3 kB
          Mike M Pestorich

          Activity

            People

            • Assignee:
              andrus Andrus Adamchik
              Reporter:
              mmpestorich Mike M Pestorich
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated: