+ * As the (Sun) Java Preferences implementation only creates a PreferencesFactory instance *once* per JVM + * (as static final), reloading the Jetspeed Portal (using a new classloader) requires a wrapper solution + * to prevent ClassCastExceptions and/or out-of-sync kept proxies and caches. + *
+ *+ * As a newly created Jetspeed Portal classloader can no longer cast a previous Preferences root to its + * own PreferencesImpl, a "trick" is used by also implementing the Observer interface (which is provided by + * the Java system classloader). The Observer interface is used because it is very lightweight and allows + * passing an Object instance through its update method. That update method is used to "inject" the newly + * created Preferences root instance. + *
+ * @author Ate Douma + * @version $Id$ + */ +public class PreferencesRootWrapper extends Preferences implements Observer +{ + + private Preferences root; + + public String absolutePath() + { + return root.absolutePath(); + } + + public void addNodeChangeListener(NodeChangeListener ncl) + { + root.addNodeChangeListener(ncl); + } + + public void addPreferenceChangeListener(PreferenceChangeListener pcl) + { + root.addPreferenceChangeListener(pcl); + } + + public String[] childrenNames() throws BackingStoreException + { + return root.childrenNames(); + } + + public void clear() throws BackingStoreException + { + root.clear(); + } + + public boolean equals(Object obj) + { + return root.equals(obj); + } + + public void exportNode(OutputStream os) throws IOException, + BackingStoreException + { + root.exportNode(os); + } + + public void exportSubtree(OutputStream os) throws IOException, + BackingStoreException + { + root.exportSubtree(os); + } + + public void flush() throws BackingStoreException + { + root.flush(); + } + + public String get(String key, String def) + { + return root.get(key, def); + } + + public boolean getBoolean(String key, boolean def) + { + return root.getBoolean(key, def); + } + + public byte[] getByteArray(String key, byte[] def) + { + return root.getByteArray(key, def); + } + + public double getDouble(String key, double def) + { + return root.getDouble(key, def); + } + + public float getFloat(String key, float def) + { + return root.getFloat(key, def); + } + + public int getInt(String key, int def) + { + return root.getInt(key, def); + } + + public long getLong(String key, long def) + { + return root.getLong(key, def); + } + + public int hashCode() + { + return root.hashCode(); + } + + public boolean isUserNode() + { + return root.isUserNode(); + } + + public String[] keys() throws BackingStoreException + { + return root.keys(); + } + + public String name() + { + return root.name(); + } + + public Preferences node(String pathName) + { + return root.node(pathName); + } + + public boolean nodeExists(String pathName) throws BackingStoreException + { + return root.nodeExists(pathName); + } + + public Preferences parent() + { + return root.parent(); + } + + public void put(String key, String value) + { + root.put(key, value); + } + + public void putBoolean(String key, boolean value) + { + root.putBoolean(key, value); + } + + public void putByteArray(String key, byte[] value) + { + root.putByteArray(key, value); + } + + public void putDouble(String key, double value) + { + root.putDouble(key, value); + } + + public void putFloat(String key, float value) + { + root.putFloat(key, value); + } + + public void putInt(String key, int value) + { + root.putInt(key, value); + } + + public void putLong(String key, long value) + { + root.putLong(key, value); + } + + public void remove(String key) + { + root.remove(key); + } + + public void removeNode() throws BackingStoreException + { + root.removeNode(); + } + + public void removeNodeChangeListener(NodeChangeListener ncl) + { + root.removeNodeChangeListener(ncl); + } + + public void removePreferenceChangeListener(PreferenceChangeListener pcl) + { + root.removePreferenceChangeListener(pcl); + } + + public void sync() throws BackingStoreException + { + root.sync(); + } + + public String toString() + { + return root.toString(); + } + + public void update(Observable o, Object arg) + { + root = (Preferences) arg; + } +} Modified: pal-portal/branches/pal-portal-1.x/portal/jetspeed-2/components/page-manager/project.xml =================================================================== --- pal-portal/branches/pal-portal-1.x/portal/jetspeed-2/components/page-manager/project.xml 2009-03-04 04:36:19 UTC (rev 1787) +++ pal-portal/branches/pal-portal-1.x/portal/jetspeed-2/components/page-manager/project.xml 2009-03-04 05:38:03 UTC (rev 1788) @@ -96,6 +96,7 @@@@ -36,15 +38,35 @@ public class PreferencesFactoryImpl implements PreferencesFactory { - // TODO Findbugs protected static PreferencesProvider prefsProvider; + private Preferences userRootWrapper; + + private Preferences systemRootWrapper; + + private PreferencesImpl userRoot; + + private PreferencesImpl systemRoot; + + private PreferencesProvider preferencesProvider; + protected static final Log log = LogFactory .getLog(PreferencesFactoryImpl.class); public PreferencesFactoryImpl() { - super(); + userRootWrapper = new PreferencesRootWrapper(); + systemRootWrapper = new PreferencesRootWrapper(); + } + + /** + * Spring invoked constructor with a dummy parameter to distinguish it from + * the default constructor invoked by the Java Preferences + * + * @param dummy + */ + public PreferencesFactoryImpl(int dummy) + { System.setProperty("java.util.prefs.PreferencesFactory", getClass() .getName()); } @@ -54,7 +76,7 @@ */ public Preferences systemRoot() { - return PreferencesImpl.systemRoot; + return systemRootWrapper; } /** @@ -62,7 +84,7 @@ */ public Preferences userRoot() { - return PreferencesImpl.userRoot; + return userRootWrapper; } /** @@ -76,29 +98,37 @@ { try { - PreferencesImpl.setPreferencesProvider(prefsProvider); - // TODO Findbugs - PreferencesImpl.systemRoot = new PreferencesImpl(null, "", + // Wrap the PreferencesProvider to provide a single instance to be stored in the Preferences nodes + // which can be disposed at once for all + PreferencesProviderWrapper ppw = new PreferencesProviderWrapper( + preferencesProvider); + preferencesProvider = null; + userRoot = new PreferencesImpl(null, ppw, "", + PreferencesImpl.USER_NODE_TYPE); + systemRoot = new PreferencesImpl(null, ppw, "", PreferencesImpl.SYSTEM_NODE_TYPE); - // TODO Findbugs - PreferencesImpl.userRoot = new PreferencesImpl(null, "", - PreferencesImpl.USER_NODE_TYPE); + // set/update the Java Preferences userRoot and systeRoot PreferencesRootWrapper instances + ((Observer) Preferences.userRoot()).update(null, userRoot); + ((Observer) Preferences.systemRoot()).update(null, systemRoot); } catch (Throwable e) { //e.printStackTrace(); log.log("1500002", e); // REPLACED throw new PreferencesException("Failed to initialize prefs api. " - + e.toString()); + + e.getMessage(), e); } } - /** - * @return The {@link PreferencesProvider} - */ - public PreferencesProvider getPrefsProvider() + public void destroy() { - return prefsProvider; + ((Observer) Preferences.userRoot()).update(null, null); + ((Observer) Preferences.systemRoot()).update(null, null); + userRoot.disposeNode(); + systemRoot.disposeNode(); + userRoot.ppw.dispose(); + userRoot = null; + systemRoot = null; } /** @@ -106,12 +136,11 @@ * Set the preferences provider. *
* - * @param prefsProvider + * @param preferencesProvider * The {@link PreferencesProvider} */ - public void setPrefsProvider(PreferencesProvider prefsProvider) + public void setPrefsProvider(PreferencesProvider preferencesProvider) { - // TODO Findbugs - PreferencesFactoryImpl.prefsProvider = prefsProvider; + this.preferencesProvider = preferencesProvider; } } Modified: pal-portal/branches/pal-portal-1.x/portal/jetspeed-2/components/prefs/src/java/org/apache/jetspeed/prefs/impl/PreferencesImpl.java =================================================================== --- pal-portal/branches/pal-portal-1.x/portal/jetspeed-2/components/prefs/src/java/org/apache/jetspeed/prefs/impl/PreferencesImpl.java 2009-03-04 04:36:19 UTC (rev 1787) +++ pal-portal/branches/pal-portal-1.x/portal/jetspeed-2/components/prefs/src/java/org/apache/jetspeed/prefs/impl/PreferencesImpl.java 2009-03-04 05:38:03 UTC (rev 1788) @@ -30,7 +30,6 @@ import org.apache.jetspeed.prefs.FailedToCreateNodeException; import org.apache.jetspeed.prefs.NodeAlreadyExistsException; import org.apache.jetspeed.prefs.NodeDoesNotExistException; -import org.apache.jetspeed.prefs.PreferencesProvider; import org.apache.jetspeed.prefs.om.Node; import org.apache.jetspeed.prefs.om.Property; import org.apache.jetspeed.prefs.om.impl.PropertyImpl; @@ -42,6 +41,7 @@ * * * @author David Le Strat + * @author Ate Douma */ public class PreferencesImpl extends AbstractPreferences { @@ -58,13 +58,13 @@ /** Logger. */ private static final Log log = LogFactory.getLog(PreferencesImpl.class); - // TODO Findbugs - protected static PreferencesProvider prefsProvider; + PreferencesProviderWrapper ppw; - static PreferencesImpl systemRoot; + void disposeNode() + { + node = null; + } - static PreferencesImpl userRoot; - /** ** Constructs a root node in the underlying datastore if they have not yet @@ -81,13 +81,14 @@ * @param nodeType * The node type. */ - public PreferencesImpl(PreferencesImpl parent, String nodeName, int nodeType) - throws IllegalStateException + PreferencesImpl(PreferencesImpl parent, PreferencesProviderWrapper ppw, + String nodeName, int nodeType) throws IllegalStateException { super(parent, nodeName); + this.ppw = ppw; try { - node = prefsProvider.getNode(this.absolutePath(), nodeType); + node = ppw.provider().getNode(this.absolutePath(), nodeType); newNode = false; } catch (NodeDoesNotExistException e1) @@ -96,12 +97,12 @@ { if (parent != null) { - this.node = prefsProvider.createNode(parent.getNode(), + this.node = ppw.provider().createNode(parent.getNode(), nodeName, nodeType, this.absolutePath()); } else { - this.node = prefsProvider.createNode(null, nodeName, + this.node = ppw.provider().createNode(null, nodeName, nodeType, this.absolutePath()); } @@ -119,7 +120,8 @@ { try { - node = prefsProvider.getNode(this.absolutePath(), nodeType); + node = ppw.provider() + .getNode(this.absolutePath(), nodeType); newNode = false; } catch (NodeDoesNotExistException e2) @@ -143,7 +145,7 @@ */ public String[] childrenNamesSpi() throws BackingStoreException { - Collection nodes = prefsProvider.getChildren(getNode()); + Collection nodes = ppw.provider().getChildren(getNode()); if (null != nodes) { @@ -168,7 +170,7 @@ */ public AbstractPreferences childSpi(String name) { - return new PreferencesImpl(this, name, node.getNodeType()); + return new PreferencesImpl(this, ppw, name, node.getNodeType()); } /** @@ -176,7 +178,7 @@ */ public void flushSpi() throws BackingStoreException { - prefsProvider.storeNode(this.node); + ppw.provider().storeNode(this.node); } /** @@ -190,8 +192,8 @@ Node targetNode = null; try { - targetNode = prefsProvider.getNode(node.getFullPath(), node - .getNodeType()); + targetNode = ppw.provider().getNode(node.getFullPath(), + node.getNodeType()); } catch (NodeDoesNotExistException e) { @@ -287,7 +289,7 @@ properties.add(new PropertyImpl(node.getNodeId(), key, value)); } - prefsProvider.storeNode(node); + ppw.provider().storeNode(node); } /** @@ -301,7 +303,7 @@ { parentNode = ((PreferencesImpl) parent).getNode(); } - prefsProvider.removeNode(parentNode, node); + ppw.provider().removeNode(parentNode, node); } /** @@ -321,7 +323,7 @@ } } // Update node. - prefsProvider.storeNode(node); + ppw.provider().storeNode(node); } /** @@ -344,20 +346,4 @@ { return node; } - - /** - * - *
- * setPreferencesProvider - *
- * Sets theorg.apache.jetspeed.prefs.PreferencesProvider
- * that will support backing store operations for all
- * PreferencesImpls
- *
- * @param prefsProvider
- */
- public static void setPreferencesProvider(PreferencesProvider prefsProvider)
- {
- PreferencesImpl.prefsProvider = prefsProvider;
- }
}
Added: pal-portal/branches/pal-portal-1.x/portal/jetspeed-2/components/prefs/src/java/org/apache/jetspeed/prefs/impl/PreferencesProviderWrapper.java
===================================================================
--- pal-portal/branches/pal-portal-1.x/portal/jetspeed-2/components/prefs/src/java/org/apache/jetspeed/prefs/impl/PreferencesProviderWrapper.java (rev 0)
+++ pal-portal/branches/pal-portal-1.x/portal/jetspeed-2/components/prefs/src/java/org/apache/jetspeed/prefs/impl/PreferencesProviderWrapper.java 2009-03-04 05:38:03 UTC (rev 1788)
@@ -0,0 +1,44 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.jetspeed.prefs.impl;
+
+import org.apache.jetspeed.prefs.PreferencesProvider;
+
+/**
+ * @author Ate Douma
+ * @version $Id$
+ */
+public class PreferencesProviderWrapper
+{
+
+ PreferencesProvider provider;
+
+ PreferencesProviderWrapper(PreferencesProvider provider)
+ {
+ this.provider = provider;
+ }
+
+ PreferencesProvider provider()
+ {
+ return provider;
+ }
+
+ void dispose()
+ {
+ provider = null;
+ }
+}
Modified: pal-portal/branches/pal-portal-1.x/portal/jetspeed-2/src/webapp/WEB-INF/assembly/prefs.xml
===================================================================
--- pal-portal/branches/pal-portal-1.x/portal/jetspeed-2/src/webapp/WEB-INF/assembly/prefs.xml 2009-03-04 04:36:19 UTC (rev 1787)
+++ pal-portal/branches/pal-portal-1.x/portal/jetspeed-2/src/webapp/WEB-INF/assembly/prefs.xml 2009-03-04 05:38:03 UTC (rev 1788)
@@ -19,7 +19,7 @@