Skip to content

Recommend OSGi EventHandler for APP_STARTUP_COMPLETE over IStartup #1362

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 13, 2023
Merged

Recommend OSGi EventHandler for APP_STARTUP_COMPLETE over IStartup #1362

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6cd93f1
Mention OSGi EventHandler of APP_STARTUP_COMPLETE as IStartup
HannesWell Dec 3, 2023
e9b5ee4
Migrate MonitoringStartup to use OSGi EventHandler instead of IStartup
HannesWell Dec 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions bundles/org.eclipse.ui.monitoring/.project
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@
<arguments>
</arguments>
</buildCommand>
<buildCommand>
<name>org.eclipse.pde.ds.core.builder</name>
<arguments>
</arguments>
</buildCommand>
</buildSpec>
<natures>
<nature>org.eclipse.m2e.core.maven2Nature</nature>
Expand Down
7 changes: 7 additions & 0 deletions bundles/org.eclipse.ui.monitoring/.settings/org.eclipse.pde.ds.annotations.prefs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
dsVersion=V1_4
eclipse.preferences.version=1
enabled=true
generateBundleActivationPolicyLazy=true
path=OSGI-INF
validationErrorLevel=error
validationErrorLevel.missingImplicitUnbindMethod=error
6 changes: 5 additions & 1 deletion bundles/org.eclipse.ui.monitoring/META-INF/MANIFEST.MF
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,9 @@ Export-Package: org.eclipse.ui.internal.monitoring;x-internal:=true,
org.eclipse.ui.monitoring;x-internal:=true
Require-Bundle: org.eclipse.core.runtime;bundle-version="[3.29.0,4.0.0)",
org.eclipse.jface;bundle-version="[3.10.0,4.0.0)",
org.eclipse.ui;bundle-version="[3.106.0,4.0.0)"
org.eclipse.ui;bundle-version="[3.106.0,4.0.0)",
org.eclipse.e4.ui.workbench;bundle-version="[1.15.300,2.0.0)"
Service-Component: OSGI-INF/org.eclipse.ui.internal.monitoring.MonitoringStartup.xml
Automatic-Module-Name: org.eclipse.ui.monitoring
Import-Package: org.osgi.service.event;version="[1.4.0,2.0.0)",
org.osgi.service.event.propertytypes;version="[1.4.0,2.0.0)"
1 change: 1 addition & 0 deletions bundles/org.eclipse.ui.monitoring/build.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ output.. = bin/
bin.includes = META-INF/,\
.,\
plugin.properties,\
OSGI-INF/,\
plugin.xml,\
about.html,\
.options
Expand Down
3 changes: 0 additions & 3 deletions bundles/org.eclipse.ui.monitoring/plugin.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,6 @@
name="%UiFreezeEventLogger.name"
schema="schema/org.eclipse.ui.monitoring.logger.exsd"/>

<extension point="org.eclipse.ui.startup">
<startup class="org.eclipse.ui.internal.monitoring.MonitoringStartup"/>
</extension>
<extension
point="org.eclipse.core.runtime.preferences">
<initializer
Expand Down
14 changes: 10 additions & 4 deletions ...s/org.eclipse.ui.monitoring/src/org/eclipse/ui/internal/monitoring/MonitoringStartup.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*******************************************************************************
* Copyright (C) 2014, 2019 Google Inc and others.
* Copyright (C) 2014, 2023 Google Inc and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
Expand All @@ -17,21 +17,27 @@
package org.eclipse.ui.internal.monitoring;

import org.eclipse.core.runtime.Platform;
import org.eclipse.e4.ui.workbench.UIEvents;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.swt.widgets.Display;
import org.eclipse.ui.IStartup;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.internal.monitoring.preferences.MonitoringPreferenceListener;
import org.eclipse.ui.monitoring.PreferenceConstants;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.event.Event;
import org.osgi.service.event.EventHandler;
import org.osgi.service.event.propertytypes.EventTopics;

/**
* Starts the event loop monitoring thread. Initializes preferences from {@link IPreferenceStore}.
*/
public class MonitoringStartup implements IStartup {
@Component(service = EventHandler.class)
@EventTopics(UIEvents.UILifeCycle.APP_STARTUP_COMPLETE)
public class MonitoringStartup implements EventHandler {
Copy link
Contributor

@laeubi laeubi Dec 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can even define a new composite annotation like this

@Component(service = EventHandler.class)
@EventTopics(value = UIEvents.UILifeCycle.APP_STARTUP_COMPLETE)
public @interface StartupComponent {

}

what the can be used like this

Suggested change
public class MonitoringStartup implements EventHandler {
@StartupComponent
public class MonitoringStartup implements EventHandler {

Copy link
Member Author

@HannesWell HannesWell Dec 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I try to add for example to the UILifeCycle class:

@Component(service = EventHandler.class)
@EventTopics(value = APP_STARTUP_COMPLETE)
public static @interface StartupCompleted {
}

I get the error Invalid component implementation class 'StartupCompleted': annotation type.

Copy link
Contributor

@laeubi laeubi Dec 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe @Component can't be placed on meta annotation, maybe its just a bug in PDE-DS ...

private EventLoopMonitorThread monitoringThread;

@Override
public void earlyStartup() {
public void handleEvent(Event event) {
if (monitoringThread != null) {
return;
}
Expand Down
49 changes: 48 additions & 1 deletion bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IStartup.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*******************************************************************************
* Copyright (c) 2000, 2015 IBM Corporation and others.
* Copyright (c) 2000, 2023 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
Expand All @@ -17,6 +17,53 @@
* Plug-ins that register a startup extension will be activated after the
* Workbench initializes and have an opportunity to run code that can't be
* implemented using the normal contribution mechanisms.
* <p>
* Users can disable the execution of specific extensions in their workspace's
* preferences via<br>
* {@code General -> Startup and Shutdown -> Plug-ins activated on startup}.
* </p>
* <p>
* Instead of implementing this interface and registering the implementation as
* Eclipse-Extension, handlers that want to be notified upon application
* start-up can be registered declaratively as OSGi
* {@link org.osgi.service.event.EventHandler} service for the
* {@link org.eclipse.e4.ui.workbench.UIEvents.UILifeCycle#APP_STARTUP_COMPLETE}
* event.<br>
* Such an event-handler is always executed and cannot be disabled via a
* preferences.
* <p>
* For example a class
*
* <pre>
* public class MyStartupHandler implements IStartup {
* &#64;Override
* public void earlyStartup() {
* // do handling...
* }
* }
* </pre>
*
* can be rewritten to
*
* <pre>
* &#64;Component(service = EventHandler.class)
* &#64;EventTopics(UIEvents.UILifeCycle.APP_STARTUP_COMPLETE)
* public class MyStartupHandler implements EventHandler {
* &#64;Override
* public void handleEvent(Event event) {
* // do handling...
* }
* }
* </pre>
*
* Processing of OSGi declarative services annotations has to be enabled for the
* containing Plug-in and it has to import the package
* {@code org.osgi.service.event} and
* {@code org.osgi.service.event.propertytypes} as well as a dependency to
* {@code org.eclipse.e4.ui.workbench}. At the same time the registration of the
* handler as Eclipse Extension for the {@code org.eclipse.ui.startup}
* extension-point can be removed.
* </p>
*
* @since 2.0
*/
Expand Down