From 4bf1cf9199a61dcc5bc420bbc6b619868b718f4c Mon Sep 17 00:00:00 2001
From: Martin Oberhuber < martin.oberhuber@windriver.com>
Date: Fri, 11 May 2007 21:48:12 +0000
Subject: [PATCH] [181939] Deferred class loading for keystoreProviders
---
.../org/eclipse/rse/core/RSECorePlugin.java | 43 +++----
.../comm/SystemKeystoreProviderManager.java | 114 ++++++++++++++++--
2 files changed, 121 insertions(+), 36 deletions(-)
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/RSECorePlugin.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/RSECorePlugin.java
index 92e215ce7c4..2ed2f35625b 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/RSECorePlugin.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/RSECorePlugin.java
@@ -14,6 +14,7 @@
* David Dykstal (IBM) - added utility method for finding qualifiedHostNames
* Martin Oberhuber (Wind River) - [177523] Unify singleton getter methods
* Martin Oberhuber (Wind River) - [186525] Move keystoreProviders to core
+ * Martin Oberhuber (Wind River) - [181939] Deferred class loading for keystoreProviders
********************************************************************************/
package org.eclipse.rse.core;
@@ -24,7 +25,6 @@ import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.IExtensionRegistry;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.Plugin;
-import org.eclipse.rse.core.comm.ISystemKeystoreProvider;
import org.eclipse.rse.core.comm.SystemKeystoreProviderManager;
import org.eclipse.rse.core.model.ISystemRegistry;
import org.eclipse.rse.internal.core.RSECoreRegistry;
@@ -119,7 +119,7 @@ public class RSECorePlugin extends Plugin {
}
/**
- * Returns a qualified hostname given a potentially unqualified hostname
+ * Returns a qualified host name given a potentially unqualified host name
*/
public static String getQualifiedHostName(String hostName) {
try {
@@ -220,8 +220,11 @@ public class RSECorePlugin extends Plugin {
private void log(Throwable t) {
getLogger().logError("Unexpected Exception", t); //$NON-NLS-1$
}
-
- protected void registerKeystoreProviders()
+
+ /**
+ * Register declared keystore providers.
+ */
+ private void registerKeystoreProviders()
{
// Get reference to the plug-in registry
IExtensionRegistry registry = Platform.getExtensionRegistry();
@@ -231,28 +234,16 @@ public class RSECorePlugin extends Plugin {
for (int i = 0; i < systemTypeExtensions.length; i++)
{
- try
- {
- // get the name space of the declaring extension
- String nameSpace = systemTypeExtensions[i].getDeclaringExtension().getNamespaceIdentifier();
-
- String keystoreProviderType = systemTypeExtensions[i].getAttribute("class"); //$NON-NLS-1$
-
- // use the name space to get the bundle
- Bundle bundle = Platform.getBundle(nameSpace);
-
- if (bundle.getState() != Bundle.UNINSTALLED)
- {
- Class keystoreProvider = bundle.loadClass(keystoreProviderType);
-
- ISystemKeystoreProvider extension = (ISystemKeystoreProvider)keystoreProvider.getConstructors()[0].newInstance(null);
- SystemKeystoreProviderManager.getInstance().registerKeystoreProvider(extension);
- }
- }
- catch (Exception e)
- {
- e.printStackTrace();
- }
+ // get the name space of the declaring extension
+ String nameSpace = systemTypeExtensions[i].getDeclaringExtension().getNamespaceIdentifier();
+ String keystoreProviderType = systemTypeExtensions[i].getAttribute("class"); //$NON-NLS-1$
+
+ // use the name space to get the bundle
+ Bundle bundle = Platform.getBundle(nameSpace);
+ if (bundle.getState() != Bundle.UNINSTALLED)
+ {
+ SystemKeystoreProviderManager.getInstance().registerKeystoreProvider(bundle, keystoreProviderType);
+ }
}
}
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/comm/SystemKeystoreProviderManager.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/comm/SystemKeystoreProviderManager.java
index 223edeb7466..f61ad8f89e4 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/comm/SystemKeystoreProviderManager.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/comm/SystemKeystoreProviderManager.java
@@ -12,6 +12,7 @@
*
* Contributors:
* Martin Oberhuber (Wind River) - [186525] Move keystoreProviders to core
+ * Martin Oberhuber (Wind River) - [181939] Deferred class loading for keystoreProviders
********************************************************************************/
package org.eclipse.rse.core.comm;
@@ -19,48 +20,141 @@ package org.eclipse.rse.core.comm;
import java.util.ArrayList;
import java.util.List;
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.Status;
+import org.eclipse.rse.core.RSECorePlugin;
+import org.osgi.framework.Bundle;
+
+/**
+ * A Registry of keystore providers, with the ability to instantiate
+ * providers lazily when needed.
+ */
public class SystemKeystoreProviderManager
{
private static SystemKeystoreProviderManager _instance = new SystemKeystoreProviderManager();
private List _extensions;
+ private static class ExtensionInfo {
+ public Bundle bundle;
+ public String className;
+ public ExtensionInfo(Bundle bundle, String className) {
+ this.bundle = bundle;
+ this.className = className;
+ }
+ }
+
private SystemKeystoreProviderManager()
{
_extensions= new ArrayList();
}
+ /**
+ * Return the SystemKeystoreProviderManager Instance.
+ * @return the singleton instance.
+ */
public static SystemKeystoreProviderManager getInstance()
{
return _instance;
}
+ /**
+ * Register a keystore provider.
+ * @param ext keystore provider to register.
+ */
public void registerKeystoreProvider(ISystemKeystoreProvider ext)
{
_extensions.add(ext);
}
+
+ /**
+ * Register a keystore provider for deferred (lazy) loading.
+ *
+ * @param bundle the bundle that declares the extension. The bundle
+ * must be installed and will be activated lazily when trying
+ * to load the given class name.
+ * @param className fully qualified classname of the keystore provider
+ * declared in the given bundle.
+ */
+ public void registerKeystoreProvider(Bundle bundle, String className)
+ {
+ _extensions.add(new ExtensionInfo(bundle, className));
+ }
public boolean hasProvider()
{
return !_extensions.isEmpty();
}
-
+
+ /**
+ * Return the keystore provider at the given index in the registry,
+ * or null if there is no provider at the given index
+ * or it cannot be loaded.
+ * @return An ISystemKeystoreProvider instance, or null
+ * if no provider is found at the given index.
+ */
+ public ISystemKeystoreProvider getProviderAt(int idx)
+ {
+ if (idx >= 0 && idx < _extensions.size()) {
+ Object o = _extensions.get(idx);
+ if (o instanceof ISystemKeystoreProvider) {
+ return (ISystemKeystoreProvider)o;
+ } else if (o instanceof ExtensionInfo) {
+ ExtensionInfo info = (ExtensionInfo)o;
+ try {
+ Class keystoreProvider = info.bundle.loadClass(info.className);
+ ISystemKeystoreProvider extension = (ISystemKeystoreProvider)keystoreProvider.getConstructors()[0].newInstance(null);
+ _extensions.set(idx, extension);
+ return extension;
+ } catch(Exception e) {
+ RSECorePlugin.getDefault().getLog().log(
+ new Status(IStatus.ERROR, info.bundle.getSymbolicName(), -1, e.getMessage(), e));
+ }
+ }
+ }
+ return null;
+ }
+
+ /**
+ * Return the default keystore provider.
+ * The default provider is the one which was added last by the
+ * extension registry, and loads properly.
+ * @return An ISystemKeystoreProvider instance, or null
+ * if no provider is found at the given index.
+ */
public ISystemKeystoreProvider getDefaultProvider()
{
- if (_extensions.size() > 0)
- {
- return (ISystemKeystoreProvider)_extensions.get(_extensions.size() - 1);
- }
+ int idx = _extensions.size()-1;
+ while (idx>=0) {
+ ISystemKeystoreProvider provider = getProviderAt(idx);
+ if (provider!=null) {
+ return provider;
+ }
+ _extensions.remove(idx);
+ idx--;
+ }
return null;
}
+ /**
+ * Return an array of all registered keystore providers.
+ * The default provider is the one which was added last by the
+ * extension registry, and loads properly.
+ * @return An array of all registered keystore providers
+ * that load properly.
+ */
public ISystemKeystoreProvider[] getProviders()
{
- ISystemKeystoreProvider[] providers = new ISystemKeystoreProvider[_extensions.size()];
- for (int i = 0; i < _extensions.size(); i++)
- {
- providers[i] = (ISystemKeystoreProvider)_extensions.get(i);
+ List providers = new ArrayList();
+ for (int i = _extensions.size()-1; i>=0; i--) {
+ ISystemKeystoreProvider provider = getProviderAt(i);
+ if (provider!=null) {
+ providers.add(0, provider);
+ } else {
+ _extensions.remove(i);
+ }
}
- return providers;
+ ISystemKeystoreProvider[] result = (ISystemKeystoreProvider[])providers.toArray(new ISystemKeystoreProvider[providers.size()]);
+ return result;
}
}
\ No newline at end of file