Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSteffen Pingel2013-06-26 16:26:27 -0400
committerSteffen Pingel2013-06-28 05:16:20 -0400
commit6f2fb1fab8edcec43f683dda4e5e96f722d3daa6 (patch)
tree66decaf9947887382fbf6388591942dd1aa89372 /org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/internal
parent97b3af427feb039f8e55d273ab09852effaff025 (diff)
downloadorg.eclipse.mylyn.tasks-6f2fb1fab8edcec43f683dda4e5e96f722d3daa6.tar.gz
org.eclipse.mylyn.tasks-6f2fb1fab8edcec43f683dda4e5e96f722d3daa6.tar.xz
org.eclipse.mylyn.tasks-6f2fb1fab8edcec43f683dda4e5e96f722d3daa6.zip
408511: [api] move connector extension point reader into core
Change-Id: I28c285f9ab9f7d0e3b4e80ad79dec9cb148f7db9 Task-Url: https://bugs.eclipse.org/bugs/show_bug.cgi?id=408511
Diffstat (limited to 'org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/internal')
-rw-r--r--org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/internal/tasks/core/util/RepositoryConnectorExtensionReader.java333
1 files changed, 333 insertions, 0 deletions
diff --git a/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/internal/tasks/core/util/RepositoryConnectorExtensionReader.java b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/internal/tasks/core/util/RepositoryConnectorExtensionReader.java
new file mode 100644
index 000000000..d4103c7ec
--- /dev/null
+++ b/org.eclipse.mylyn.tasks.core/src/org/eclipse/mylyn/internal/tasks/core/util/RepositoryConnectorExtensionReader.java
@@ -0,0 +1,333 @@
+/*******************************************************************************
+ * Copyright (c) 2013 Tasktop Technologies and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Tasktop Technologies - initial API and implementation
+ *******************************************************************************/
+
+package org.eclipse.mylyn.internal.tasks.core.util;
+
+import java.util.ArrayList;
+import java.util.HashSet;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import org.eclipse.core.runtime.Assert;
+import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.IConfigurationElement;
+import org.eclipse.core.runtime.IExtension;
+import org.eclipse.core.runtime.IExtensionPoint;
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.MultiStatus;
+import org.eclipse.core.runtime.Status;
+import org.eclipse.mylyn.commons.core.StatusHandler;
+import org.eclipse.mylyn.internal.tasks.core.ITasksCoreConstants;
+import org.eclipse.mylyn.internal.tasks.core.TaskRepositoryManager;
+import org.eclipse.mylyn.internal.tasks.core.externalization.TaskListExternalizer;
+import org.eclipse.mylyn.tasks.core.AbstractRepositoryConnector;
+import org.eclipse.mylyn.tasks.core.AbstractRepositoryMigrator;
+import org.eclipse.mylyn.tasks.core.AbstractTaskListMigrator;
+import org.eclipse.mylyn.tasks.core.RepositoryConnectorDescriptor;
+import org.eclipse.osgi.util.NLS;
+
+public class RepositoryConnectorExtensionReader {
+
+ public static final String ELMNT_MIGRATOR = "taskListMigrator"; //$NON-NLS-1$
+
+ public static final String ELMNT_REPOSITORY_MIGRATOR = "repositoryMigrator"; //$NON-NLS-1$
+
+ public static final String ELMNT_REPOSITORY_CONNECTOR = "connectorCore"; //$NON-NLS-1$
+
+ public static final String ATTR_ID = "id"; //$NON-NLS-1$
+
+ public static final String ATTR_CLASS = "class"; //$NON-NLS-1$
+
+ private static class ConnectorFactory {
+
+ private AbstractRepositoryConnector connector;
+
+ private AbstractTaskListMigrator taskListMigrator;
+
+ private AbstractRepositoryMigrator repositoryMigrator;
+
+ private final RepositoryConnectorDescriptor descriptor;
+
+ private final String pluginId;
+
+ public ConnectorFactory(RepositoryConnectorDescriptor descriptor, String pluginId) {
+ this.descriptor = descriptor;
+ this.pluginId = pluginId;
+ }
+
+ public String getConnectorKind() {
+ return (getConnector() != null) ? getConnector().getConnectorKind() : null;
+ }
+
+ public AbstractRepositoryConnector getConnector() {
+ return connector;
+ }
+
+ public String getPluginId() {
+ return pluginId;
+ }
+
+ public AbstractTaskListMigrator getTaskListMigrator() {
+ return taskListMigrator;
+ }
+
+ public AbstractRepositoryMigrator getRepositoryMigrator() {
+ return repositoryMigrator;
+ }
+
+ public IStatus createConnector() {
+ Assert.isTrue(connector == null);
+ try {
+ connector = descriptor.createRepositoryConnector();
+ if (connector != null) {
+ return Status.OK_STATUS;
+ } else {
+ return new Status(IStatus.ERROR, ITasksCoreConstants.ID_PLUGIN, NLS.bind(
+ "Could not load connector core contributed by ''{0}''", getPluginId())); //$NON-NLS-1$
+ }
+ } catch (Throwable e) {
+ return new Status(IStatus.ERROR, ITasksCoreConstants.ID_PLUGIN, NLS.bind(
+ "Could not load connector core contributed by ''{0}''", getPluginId()), e); //$NON-NLS-1$
+ }
+ }
+
+ public IStatus createTaskListMigrator() {
+ try {
+ taskListMigrator = descriptor.createTaskListMigrator();
+ if (taskListMigrator != null) {
+ return Status.OK_STATUS;
+ } else {
+ return Status.CANCEL_STATUS;
+ }
+ } catch (Throwable e) {
+ return new Status(IStatus.ERROR, ITasksCoreConstants.ID_PLUGIN, NLS.bind(
+ "Could not load task list migrator extension contributed by ''{0}''", getPluginId()), e); //$NON-NLS-1$
+ }
+ }
+
+ public IStatus createRepositoryMigrator() {
+ Assert.isTrue(repositoryMigrator == null);
+ try {
+ repositoryMigrator = descriptor.createRepositoryMigrator();
+ if (repositoryMigrator != null) {
+ return Status.OK_STATUS;
+ } else {
+ return Status.CANCEL_STATUS;
+ }
+ } catch (Throwable e) {
+ return new Status(IStatus.ERROR, ITasksCoreConstants.ID_PLUGIN, NLS.bind(
+ "Could not load repository migrator extension contributed by ''{0}''", getPluginId()), e); //$NON-NLS-1$
+ }
+ }
+
+ }
+
+ private static class ExtensionPointBasedConnectorDescriptor extends RepositoryConnectorDescriptor {
+
+ IConfigurationElement element;
+
+ IConfigurationElement taskListMigratorElement;
+
+ IConfigurationElement repositoryMigratorElement;
+
+ public ExtensionPointBasedConnectorDescriptor(IConfigurationElement element) {
+ this.element = element;
+ }
+
+ @Override
+ public AbstractRepositoryConnector createRepositoryConnector() {
+ try {
+ return (AbstractRepositoryConnector) element.createExecutableExtension(ATTR_CLASS);
+ } catch (CoreException e) {
+ throw new RuntimeException(e);
+ }
+ }
+
+ @Override
+ public AbstractTaskListMigrator createTaskListMigrator() {
+ if (taskListMigratorElement == null) {
+ return null;
+ }
+ try {
+ return (AbstractTaskListMigrator) taskListMigratorElement.createExecutableExtension(ATTR_CLASS);
+ } catch (CoreException e) {
+ throw new RuntimeException(e);
+ }
+ }
+
+ @Override
+ public AbstractRepositoryMigrator createRepositoryMigrator() {
+ if (repositoryMigratorElement == null) {
+ return null;
+ }
+ try {
+ return (AbstractRepositoryMigrator) repositoryMigratorElement.createExecutableExtension(ATTR_CLASS);
+ } catch (CoreException e) {
+ throw new RuntimeException(e);
+ }
+ }
+
+ public String getPluginId() {
+ return element.getContributor().getName();
+ }
+
+ public String getId() {
+ return element.getAttribute(ATTR_ID);
+ }
+
+ }
+
+ /**
+ * Plug-in ids of connector extensions that failed to load.
+ */
+ private final Set<String> disabledContributors = new HashSet<String>();
+
+ private final TaskListExternalizer taskListExternalizer;
+
+ private final TaskRepositoryManager repositoryManager;
+
+ public RepositoryConnectorExtensionReader(TaskListExternalizer taskListExternalizer,
+ TaskRepositoryManager repositoryManager) {
+ this.taskListExternalizer = taskListExternalizer;
+ this.repositoryManager = repositoryManager;
+ }
+
+ public void registerConnectors(IExtensionPoint repositoriesExtensionPoint) {
+ List<ConnectorFactory> descriptors = new ArrayList<ConnectorFactory>();
+ MultiStatus result = new MultiStatus(ITasksCoreConstants.ID_PLUGIN, 0,
+ "Repository connectors failed to load.", null); //$NON-NLS-1$
+
+ Map<String, List<ConnectorFactory>> factoryById = readFromRepositoriesExtensionPoint(
+ repositoriesExtensionPoint, descriptors);
+ checkForConflicts(descriptors, result, factoryById);
+
+ Map<String, List<ConnectorFactory>> factoryByConnectorKind = createConnectorInstances(descriptors, result);
+ checkForConflicts(descriptors, result, factoryByConnectorKind);
+
+ registerConnectorInstances(descriptors, result);
+
+ if (!result.isOK()) {
+ StatusHandler.log(result);
+ }
+ }
+
+ public Map<String, List<ConnectorFactory>> createConnectorInstances(List<ConnectorFactory> descriptors,
+ MultiStatus result) {
+ Map<String, List<ConnectorFactory>> factoryByConnectorKind = new LinkedHashMap<String, List<ConnectorFactory>>();
+ for (ConnectorFactory descriptor : descriptors) {
+ IStatus status = descriptor.createConnector();
+ if (status.isOK() && descriptor.getConnector() != null) {
+ add(factoryByConnectorKind, descriptor.getConnectorKind(), descriptor);
+ } else {
+ result.add(status);
+ }
+ }
+ return factoryByConnectorKind;
+ }
+
+ private void registerConnectorInstances(List<ConnectorFactory> descriptors, MultiStatus result) {
+ List<AbstractTaskListMigrator> taskListmigrators = new ArrayList<AbstractTaskListMigrator>();
+ List<AbstractRepositoryMigrator> repositoryMigrators = new ArrayList<AbstractRepositoryMigrator>();
+
+ for (ConnectorFactory descriptor : descriptors) {
+ if (descriptor.getConnector() != null) {
+ repositoryManager.addRepositoryConnector(descriptor.getConnector());
+
+ IStatus status = descriptor.createTaskListMigrator();
+ if (status.isOK() && descriptor.getTaskListMigrator() != null) {
+ taskListmigrators.add(descriptor.getTaskListMigrator());
+ } else if (status.getSeverity() == IStatus.CANCEL) {
+ // ignore
+ } else {
+ result.add(status);
+ }
+
+ status = descriptor.createRepositoryMigrator();
+ if (status.isOK() && descriptor.getRepositoryMigrator() != null) {
+ repositoryMigrators.add(descriptor.getRepositoryMigrator());
+ } else if (status.getSeverity() == IStatus.CANCEL) {
+ // ignore
+ } else {
+ result.add(status);
+ }
+ }
+ }
+
+ repositoryManager.initialize(repositoryMigrators);
+ taskListExternalizer.initialize(taskListmigrators);
+ }
+
+ private Map<String, List<ConnectorFactory>> readFromRepositoriesExtensionPoint(
+ IExtensionPoint repositoriesExtensionPoint, List<ConnectorFactory> descriptors) {
+ // read core and migrator extensions to check for id conflicts
+ Map<String, List<ConnectorFactory>> factoryById = new LinkedHashMap<String, List<ConnectorFactory>>();
+
+ IExtension[] repositoryExtensions = repositoriesExtensionPoint.getExtensions();
+ for (IExtension repositoryExtension : repositoryExtensions) {
+ IConfigurationElement[] elements = repositoryExtension.getConfigurationElements();
+ ExtensionPointBasedConnectorDescriptor descriptor = null;
+ IConfigurationElement tasklistMigratorElement = null;
+ IConfigurationElement repositoryMigratorElement = null;
+ for (IConfigurationElement element : elements) {
+ if (element.getName().equals(ELMNT_REPOSITORY_CONNECTOR)) {
+ descriptor = new ExtensionPointBasedConnectorDescriptor(element);
+ } else if (element.getName().equals(ELMNT_MIGRATOR)) {
+ tasklistMigratorElement = element;
+ } else if (element.getName().equals(ELMNT_REPOSITORY_MIGRATOR)) {
+ repositoryMigratorElement = element;
+ }
+ }
+ if (descriptor != null) {
+ descriptor.taskListMigratorElement = tasklistMigratorElement;
+ descriptor.repositoryMigratorElement = repositoryMigratorElement;
+ ConnectorFactory factory = new ConnectorFactory(descriptor, descriptor.getPluginId());
+ descriptors.add(factory);
+ if (descriptor.getId() != null) {
+ add(factoryById, descriptor.getId(), factory);
+ }
+ }
+ }
+ return factoryById;
+ }
+
+ private void checkForConflicts(List<ConnectorFactory> descriptors, MultiStatus result,
+ Map<String, List<ConnectorFactory>> descriptorById) {
+ for (Map.Entry<String, List<ConnectorFactory>> entry : descriptorById.entrySet()) {
+ if (entry.getValue().size() > 1) {
+ MultiStatus status = new MultiStatus(ITasksCoreConstants.ID_PLUGIN, 0, NLS.bind(
+ "Connector ''{0}'' registered by multiple extensions.", entry.getKey()), null); //$NON-NLS-1$
+ for (ConnectorFactory factory : entry.getValue()) {
+ status.add(new Status(IStatus.ERROR, ITasksCoreConstants.ID_PLUGIN, NLS.bind(
+ "All extensions contributed by ''{0}'' have been disabled.", factory.getPluginId()), null)); //$NON-NLS-1$
+ disabledContributors.add(factory.getPluginId());
+ descriptors.remove(factory);
+ }
+ result.add(status);
+ }
+ }
+ }
+
+ private void add(Map<String, List<ConnectorFactory>> descriptorById, String id, ConnectorFactory descriptor) {
+ List<ConnectorFactory> list = descriptorById.get(id);
+ if (list == null) {
+ list = new ArrayList<ConnectorFactory>();
+ descriptorById.put(id, list);
+ }
+ list.add(descriptor);
+ }
+
+ public Set<String> getDisabledContributors() {
+ return new HashSet<String>(disabledContributors);
+ }
+
+}

Back to the top