1 /*******************************************************************************
\r
2 * Copyright (c) 2007, 2010 Association for Decentralized Information Management
\r
3 * in Industry THTH ry.
\r
4 * All rights reserved. This program and the accompanying materials
\r
5 * are made available under the terms of the Eclipse Public License v1.0
\r
6 * which accompanies this distribution, and is available at
\r
7 * http://www.eclipse.org/legal/epl-v10.html
\r
10 * VTT Technical Research Centre of Finland - initial API and implementation
\r
11 *******************************************************************************/
\r
12 package org.simantics.message.internal;
\r
14 import java.util.ArrayList;
\r
15 import java.util.Arrays;
\r
16 import java.util.HashMap;
\r
17 import java.util.HashSet;
\r
18 import java.util.Map;
\r
19 import java.util.Set;
\r
21 import org.eclipse.core.runtime.IConfigurationElement;
\r
22 import org.eclipse.core.runtime.IExtension;
\r
23 import org.eclipse.core.runtime.IExtensionPoint;
\r
24 import org.eclipse.core.runtime.Platform;
\r
25 import org.eclipse.core.runtime.dynamichelpers.ExtensionTracker;
\r
26 import org.eclipse.core.runtime.dynamichelpers.IExtensionChangeHandler;
\r
27 import org.eclipse.core.runtime.dynamichelpers.IExtensionTracker;
\r
28 import org.eclipse.core.runtime.dynamichelpers.IFilter;
\r
29 import org.simantics.message.IMessageDataSchemeExtension;
\r
30 import org.simantics.message.IMessageSchemeManager;
\r
33 * @author Tuukka Lehtonen
\r
35 public class MessageSchemeManager implements IExtensionChangeHandler, IMessageSchemeManager {
\r
37 public final static String NAMESPACE = "org.simantics.message";
\r
38 public final static String ELEMENT_NAME = "scheme";
\r
39 public final static String EP_NAME = "messageDataScheme";
\r
41 private ExtensionTracker tracker;
\r
43 private MessageDataSchemeExtension[] extensions = new MessageDataSchemeExtension[0];
\r
45 public MessageSchemeManager() {
\r
46 tracker = new ExtensionTracker();
\r
48 // Cache defined actions
\r
49 IExtensionPoint expt = Platform.getExtensionRegistry().getExtensionPoint(NAMESPACE, EP_NAME);
\r
50 loadExtensions(expt.getConfigurationElements());
\r
52 // Start tracking for new and removed extensions
\r
53 IFilter filter = ExtensionTracker.createExtensionPointFilter(expt);
\r
54 tracker.registerHandler(this, filter);
\r
57 private String getDescription(IConfigurationElement el) {
\r
58 for (IConfigurationElement desc : el.getChildren("description")) {
\r
59 return desc.getValue();
\r
64 private void loadExtensions(IConfigurationElement[] configurationElements) {
\r
65 Set<MessageDataSchemeExtension> newExtensions = new HashSet<MessageDataSchemeExtension>(Arrays.asList(extensions));
\r
67 // Initialize id -> extension lookup
\r
68 Map<String, MessageDataSchemeExtension> schemes = new HashMap<String, MessageDataSchemeExtension>();
\r
69 for (MessageDataSchemeExtension ext : newExtensions) {
\r
70 schemes.put(ext.getId(), ext);
\r
73 // 1st pass: load schemes
\r
74 for (IConfigurationElement el : configurationElements) {
\r
75 String name = el.getName();
\r
76 if ("scheme".equals(name)) {
\r
77 String id = el.getAttribute("id");
\r
80 String scheme = el.getAttribute("scheme");
\r
83 String description = getDescription(el);
\r
85 MessageDataSchemeExtension ext = schemes.get(id);
\r
87 // This scheme is already registered, two contributors are contributing the same scheme.
\r
88 StringBuilder msg = new StringBuilder();
\r
89 msg.append("Multiple contributors for message scheme '" + id + "':");
\r
90 msg.append("\n 1st: " + ext.getSchemeElement().getContributor().getName());
\r
91 msg.append("\n 2nd: " + el.getContributor().getName());
\r
92 msg.append("\nUsing the first one.");
\r
93 // TODO: proper logging
\r
94 System.err.println(msg.toString());
\r
98 ext = new MessageDataSchemeExtension(el, id, scheme, description);
\r
100 // Start tracking the new extension object, its removal will be notified of
\r
101 // with removeExtension(extension, Object[]).
\r
102 tracker.registerObject(el.getDeclaringExtension(), ext, IExtensionTracker.REF_STRONG);
\r
104 newExtensions.add(ext);
\r
105 schemes.put(id, ext);
\r
109 // 2nd pass: load handlers
\r
110 for (IConfigurationElement el : configurationElements) {
\r
111 String name = el.getName();
\r
112 if ("handler".equals(name)) {
\r
113 String id = el.getAttribute("schemeId");
\r
117 MessageDataSchemeExtension ext = schemes.get(id);
\r
119 // Unusable handler since there is no scheme to use it for.
\r
120 StringBuilder msg = new StringBuilder();
\r
121 msg.append("No scheme extension for message scheme id '" + id + "'. Ignoring handler '" + el.getAttribute("handler") + "'");
\r
122 msg.append("\nUsing the first one.");
\r
123 // TODO: proper logging
\r
124 System.err.println(msg.toString());
\r
128 IConfigurationElement prev = ext.getHandlerElement();
\r
129 if (prev != null) {
\r
130 // Unusable handler since there already exists a handler for this scheme.
\r
131 StringBuilder msg = new StringBuilder();
\r
132 msg.append("Multiple handler contributors for message scheme '" + id + "':\n");
\r
133 msg.append("\n 1st: " + prev.getContributor().getName());
\r
134 msg.append("\n 2nd: " + el.getContributor().getName());
\r
135 msg.append("\nUsing the first one.");
\r
136 // TODO: proper logging
\r
137 System.err.println(msg.toString());
\r
141 ext.setHandlerElement(el);
\r
145 // Atomic assignment
\r
146 this.extensions = newExtensions.toArray(new MessageDataSchemeExtension[newExtensions.size()]);
\r
150 public void addExtension(IExtensionTracker tracker, IExtension extension) {
\r
151 loadExtensions(extension.getConfigurationElements());
\r
155 public void removeExtension(IExtension extension, Object[] objects) {
\r
156 Set<MessageDataSchemeExtension> newExtensions = new HashSet<MessageDataSchemeExtension>(Arrays.asList(extensions));
\r
158 for (Object o : objects) {
\r
159 tracker.unregisterObject(extension, o);
\r
160 newExtensions.remove((IMessageDataSchemeExtension) o);
\r
163 // Atomic assignment
\r
164 this.extensions = newExtensions.toArray(new MessageDataSchemeExtension[newExtensions.size()]);
\r
168 public IMessageDataSchemeExtension[] getByScheme(String scheme) {
\r
169 if (scheme == null)
\r
170 throw new IllegalArgumentException("null scheme");
\r
172 ArrayList<MessageDataSchemeExtension> result = new ArrayList<MessageDataSchemeExtension>();
\r
173 for (MessageDataSchemeExtension ext : extensions) {
\r
174 if (scheme.equals(ext.getScheme()))
\r
177 return result.toArray(new MessageDataSchemeExtension[result.size()]);
\r