[WICKET-7080] 1) make default events delivery machinery pluggable 2) … #682

reiern70 · 2023-10-16T17:21:03Z

make default events delivery machinery plug-gable
allow to disabled sending events
defines a reflection based machinery to deliver events

reiern70 · 2023-10-17T16:31:19Z

wicket-core/src/main/java/org/apache/wicket/event/ReflectionEventDispatcher.java

+/**
+ * IEventDispatcher that uses reflection in order to locate events methods.
+ */
+public class ReflectionEventDispatcher implements IEventDispatcher {


Maybe we should add here a class to method map cache. As a similar project on wicket stuff have. One main difference is we don't have a component instantiation listener=> this will only happen at runtime when event is delivered.

reiern70 · 2023-10-17T16:32:13Z

wicket-core/src/main/java/org/apache/wicket/event/ReflectionEventDispatcher.java

+	 * Probably, this should be set to true in most applications and enforce the use of either @{@link EventAwareObject}
+	 * annotation or the marker interface @{@link IEventAwareObject}
+	 */
+	private final boolean restrictToEventAware;


This flag should make event's processing faster and only marked classes will be scanned.

reiern70 · 2023-10-17T19:22:40Z

This PR still needs some more work and care

reiern70 · 2023-10-17T20:47:25Z

I have added more tests and allow to use more that one eventType

reiern70 · 2023-10-18T14:08:24Z

Any volunteers to review this PR?

martin-g · 2023-10-20T14:52:35Z

https://github.com/wicketstuff/core/tree/master/annotationeventdispatcher-parent

reiern70 · 2023-10-20T20:59:21Z

https://github.com/wicketstuff/core/tree/master/annotationeventdispatcher-parent

@martin-g I'm aware of that work. This PR is 2 things

Make "default" event delivery plug-able. This means replacing it by something else (or disabling it)
Some simple event annotation based events delivery. Where you can get protected or private or public methods injected with an event,

@OnEvent(XXX.class)
protected onXXX(IEvent<XXX>  event) {
}

This allows to still work with event and programmatically cancel it.

or

@OnEvent(XXX.class)
protected onXXX(XXX  payload) {
}

will both work. No restrictions on XXX are imposed.

IMHO, 1. would be nice to have in wicket. As for 2. I can understand can be implemented in many different ways.

This approach does not require a component listener and only marked classes are scanned (by annotation or implementing an interface)

reiern70 · 2023-10-20T20:59:58Z

@martin-g My last commits adds caching

reiern70 · 2023-11-01T15:02:06Z

Ok, I have reverted the part related to adding a reflection based machinery. What remains is:

Allow to plug your own default "event handler"
As a side effect it is possible to disable events delivery

martin-g

Please add a test case with disabled default event dispatcher.

martin-g · 2023-11-01T16:29:28Z

wicket-core/src/main/java/org/apache/wicket/settings/FrameworkSettings.java

@@ -45,8 +45,28 @@
 */
 public class FrameworkSettings implements IEventDispatcher
 {
+	/**
+	 *  Does the standard delivery of events. Override and do nothing if you want to disable it.


Since it is private it is not possible to override it

/**
* Does the standard delivery of events. Events can be disabled at application level by setting a null
* {@link IEventDispatcher} via {@link #setDefaultEventDispatcher(IEventDispatcher)} and setting no additional
* {@link IEventDispatcher}s (via {@link #add(IEventDispatcher)}).
*/

martin-g · 2023-11-01T16:30:39Z

wicket-core/src/main/java/org/apache/wicket/settings/FrameworkSettings.java

@@ -68,7 +88,7 @@ public FrameworkSettings(final Application application)
 	 * Gets the Wicket version. The Wicket version is in the same format as the version element in
 	 * the pom.xml file (project descriptor). The version is generated by maven in the build/release
 	 * cycle and put in the /META-INF/MANIFEST.MF file located in the root folder of the Wicket jar.
-	 *
+	 * <p></p>


Most probably you want the closing </p> to be at the end of the paragraph.

Or. create an empty paragraph to separate from next IJ complains here

martin-g · 2023-11-01T16:31:12Z

wicket-core/src/main/java/org/apache/wicket/settings/FrameworkSettings.java

+	/**
+	 * @return Returns <code>true</code> if there is at least one event dispatcher
+	 */
+	public final boolean hasAnyAnyEventDispatchers()


one too many any

…allow to disabled sending events

reiern70 force-pushed the reiern70/WICKET-7080 branch from 6fd7ce9 to e0066f2 Compare October 16, 2023 17:25

reiern70 requested review from martin-g and bitstorm October 16, 2023 17:25

reiern70 commented Oct 17, 2023

View reviewed changes

reiern70 force-pushed the reiern70/WICKET-7080 branch 2 times, most recently from 44d559e to 3f2fb29 Compare October 17, 2023 20:44

reiern70 force-pushed the reiern70/WICKET-7080 branch 2 times, most recently from eadd46b to 756ff28 Compare November 1, 2023 14:51

martin-g reviewed Nov 1, 2023

View reviewed changes

reiern70 force-pushed the reiern70/WICKET-7080 branch from a1d0228 to d55432f Compare November 1, 2023 18:38

[WICKET-7080] 1) make default events delivery machinery pluggable 2) …

7d40ce7

…allow to disabled sending events

reiern70 requested a review from martin-g November 1, 2023 18:52

reiern70 force-pushed the reiern70/WICKET-7080 branch from d55432f to 7d40ce7 Compare November 1, 2023 18:54

reiern70 merged commit 7d40ce7 into wicket-9.x Nov 1, 2023
2 checks passed

reiern70 deleted the reiern70/WICKET-7080 branch November 1, 2023 18:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WICKET-7080] 1) make default events delivery machinery pluggable 2) … #682

[WICKET-7080] 1) make default events delivery machinery pluggable 2) … #682

reiern70 commented Oct 16, 2023 •

edited

Loading

reiern70 Oct 17, 2023

reiern70 Oct 17, 2023

reiern70 commented Oct 17, 2023

reiern70 commented Oct 17, 2023

reiern70 commented Oct 18, 2023

martin-g commented Oct 20, 2023

reiern70 commented Oct 20, 2023

reiern70 commented Oct 20, 2023

reiern70 commented Nov 1, 2023

martin-g left a comment

martin-g Nov 1, 2023

reiern70 Nov 1, 2023

martin-g Nov 1, 2023

reiern70 Nov 1, 2023

reiern70 Nov 1, 2023

martin-g Nov 1, 2023

reiern70 Nov 1, 2023

[WICKET-7080] 1) make default events delivery machinery pluggable 2) … #682

[WICKET-7080] 1) make default events delivery machinery pluggable 2) … #682

Conversation

reiern70 commented Oct 16, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

reiern70 commented Oct 17, 2023

reiern70 commented Oct 17, 2023

reiern70 commented Oct 18, 2023

martin-g commented Oct 20, 2023

reiern70 commented Oct 20, 2023

reiern70 commented Oct 20, 2023

reiern70 commented Nov 1, 2023

martin-g left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

reiern70 commented Oct 16, 2023 •

edited

Loading