You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by cz...@apache.org on 2009/08/07 13:40:54 UTC
svn commit: r801955 - in /sling/trunk/contrib: ./ jcr/prefs/ jcr/prefs/src/
jcr/prefs/src/main/ jcr/prefs/src/main/java/ jcr/prefs/src/main/java/org/
jcr/prefs/src/main/java/org/apache/
jcr/prefs/src/main/java/org/apache/sling/ jcr/prefs/src/main/java/...
Author: cziegeler
Date: Fri Aug 7 11:40:53 2009
New Revision: 801955
URL: http://svn.apache.org/viewvc?rev=801955&view=rev
Log:
Add new module which contains support to store OSGi preferences in the repository.
Added:
sling/trunk/contrib/jcr/prefs/
sling/trunk/contrib/jcr/prefs/LICENSE (with props)
sling/trunk/contrib/jcr/prefs/NOTICE (with props)
sling/trunk/contrib/jcr/prefs/pom.xml (with props)
sling/trunk/contrib/jcr/prefs/src/
sling/trunk/contrib/jcr/prefs/src/main/
sling/trunk/contrib/jcr/prefs/src/main/java/
sling/trunk/contrib/jcr/prefs/src/main/java/org/
sling/trunk/contrib/jcr/prefs/src/main/java/org/apache/
sling/trunk/contrib/jcr/prefs/src/main/java/org/apache/sling/
sling/trunk/contrib/jcr/prefs/src/main/java/org/apache/sling/jcr/
sling/trunk/contrib/jcr/prefs/src/main/java/org/apache/sling/jcr/prefs/
sling/trunk/contrib/jcr/prefs/src/main/java/org/apache/sling/jcr/prefs/impl/
sling/trunk/contrib/jcr/prefs/src/main/java/org/apache/sling/jcr/prefs/impl/JcrBackingStore.java (with props)
sling/trunk/contrib/jcr/prefs/src/main/resources/
sling/trunk/contrib/jcr/prefs/src/main/resources/META-INF/
sling/trunk/contrib/jcr/prefs/src/main/resources/META-INF/LICENSE (with props)
sling/trunk/contrib/jcr/prefs/src/main/resources/META-INF/NOTICE (with props)
Modified:
sling/trunk/contrib/pom.xml
Added: sling/trunk/contrib/jcr/prefs/LICENSE
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/jcr/prefs/LICENSE?rev=801955&view=auto
==============================================================================
--- sling/trunk/contrib/jcr/prefs/LICENSE (added)
+++ sling/trunk/contrib/jcr/prefs/LICENSE Fri Aug 7 11:40:53 2009
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed 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.
Propchange: sling/trunk/contrib/jcr/prefs/LICENSE
------------------------------------------------------------------------------
svn:eol-style = native
Added: sling/trunk/contrib/jcr/prefs/NOTICE
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/jcr/prefs/NOTICE?rev=801955&view=auto
==============================================================================
--- sling/trunk/contrib/jcr/prefs/NOTICE (added)
+++ sling/trunk/contrib/jcr/prefs/NOTICE Fri Aug 7 11:40:53 2009
@@ -0,0 +1,9 @@
+Apache Sling JCR Implementation for OSGi Preferences
+Copyright 2009 The Apache Software Foundation
+
+Apache Sling is based on source code originally developed
+by Day Software (http://www.day.com/).
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
+
Propchange: sling/trunk/contrib/jcr/prefs/NOTICE
------------------------------------------------------------------------------
svn:eol-style = native
Added: sling/trunk/contrib/jcr/prefs/pom.xml
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/jcr/prefs/pom.xml?rev=801955&view=auto
==============================================================================
--- sling/trunk/contrib/jcr/prefs/pom.xml (added)
+++ sling/trunk/contrib/jcr/prefs/pom.xml Fri Aug 7 11:40:53 2009
@@ -0,0 +1,96 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+ 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.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+
+ <modelVersion>4.0.0</modelVersion>
+ <parent>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>sling</artifactId>
+ <version>6</version>
+ <relativePath>../../../parent/pom.xml</relativePath>
+ </parent>
+
+ <artifactId>org.apache.sling.jcr.prefs</artifactId>
+ <version>0.9.0-SNAPSHOT</version>
+ <packaging>bundle</packaging>
+
+ <name>Apache Sling JCR Prefs</name>
+ <description>
+ Apache Sling JCR Implementation for OSGi Preferences
+ </description>
+
+ <scm>
+ <connection>scm:svn:http://svn.apache.org/repos/asf/sling/trunk/contrib/jcr/prefs</connection>
+ <developerConnection>scm:svn:https://svn.apache.org/repos/asf/sling/trunk/contrib/jcr/prefs</developerConnection>
+ <url>http://svn.apache.org/viewvc/sling/trunk/contrib/jcr/prefs</url>
+ </scm>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.felix</groupId>
+ <artifactId>maven-scr-plugin</artifactId>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.felix</groupId>
+ <artifactId>maven-bundle-plugin</artifactId>
+ <extensions>true</extensions>
+ <configuration>
+ <instructions>
+ <Private-Package>
+ org.apache.sling.jcr.prefs.impl
+ </Private-Package>
+ </instructions>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <skip>true</skip>
+ </configuration>
+ </plugin>
+ </plugins>
+ </reporting>
+
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.felix</groupId>
+ <artifactId>org.apache.felix.prefs</artifactId>
+ <version>1.0.2</version>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.jcr.api</artifactId>
+ <version>2.0.2-incubator</version>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>javax.jcr</groupId>
+ <artifactId>jcr</artifactId>
+ </dependency>
+ </dependencies>
+</project>
Propchange: sling/trunk/contrib/jcr/prefs/pom.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: sling/trunk/contrib/jcr/prefs/pom.xml
------------------------------------------------------------------------------
svn:keywords = Id
Propchange: sling/trunk/contrib/jcr/prefs/pom.xml
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added: sling/trunk/contrib/jcr/prefs/src/main/java/org/apache/sling/jcr/prefs/impl/JcrBackingStore.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/jcr/prefs/src/main/java/org/apache/sling/jcr/prefs/impl/JcrBackingStore.java?rev=801955&view=auto
==============================================================================
--- sling/trunk/contrib/jcr/prefs/src/main/java/org/apache/sling/jcr/prefs/impl/JcrBackingStore.java (added)
+++ sling/trunk/contrib/jcr/prefs/src/main/java/org/apache/sling/jcr/prefs/impl/JcrBackingStore.java Fri Aug 7 11:40:53 2009
@@ -0,0 +1,431 @@
+/*
+ * 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.sling.jcr.prefs.impl;
+
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+
+import javax.jcr.NamespaceException;
+import javax.jcr.Node;
+import javax.jcr.NodeIterator;
+import javax.jcr.Property;
+import javax.jcr.PropertyIterator;
+import javax.jcr.RepositoryException;
+import javax.jcr.Session;
+
+import org.apache.felix.prefs.BackingStore;
+import org.apache.felix.prefs.BackingStoreManager;
+import org.apache.felix.prefs.PreferencesDescription;
+import org.apache.felix.prefs.PreferencesImpl;
+import org.apache.sling.jcr.api.SlingRepository;
+import org.osgi.service.component.ComponentContext;
+import org.osgi.service.prefs.BackingStoreException;
+
+/**
+ * @scr.component metatype="false"
+ * @scr.service interface="org.apache.felix.prefs.BackingStore"
+ *
+ * @scr.property name="sling.preferences.jcr.path" value="/preferences";
+ * @scr.property name="sling.preferences.jcr.namespace" value="http://osgi.org/service/prefs/Preferences/1.1";
+ * @scr.property name="sling.preferences.jcr.prefix" value="osgipref";
+ */
+public class JcrBackingStore implements BackingStore {
+
+ protected static final String NS_URI = "http://osgi.org/service/prefs/Preferences/1.1";
+
+ protected static final String PATH_PROPERTY = "sling.preferences.jcr.path";
+ protected static final String NAMESPACE_PROPERTY = "sling.preferences.jcr.namespace";
+ protected static final String NAMESPACE_PREFIX_PROPERTY = "sling.preferences.jcr.prefix";
+
+ /** @scr.reference */
+ protected SlingRepository repository;
+
+ protected boolean initialized = false;
+
+ protected String rootNodePath = "/preferences";
+
+ protected String namespacePrefix = "osgipref";
+
+ protected String namespacePrefixSep = this.namespacePrefix + ':';
+
+ protected String namespace = NS_URI;
+
+ protected Session getSession() throws RepositoryException {
+ return this.repository.loginAdministrative(null);
+ }
+
+ /**
+ * Activate this component and get the property configuration.
+ * @param componentContext
+ */
+ protected void activate(ComponentContext componentContext) {
+ Object value = componentContext.getProperties().get(PATH_PROPERTY);
+ if ( value != null ) {
+ this.rootNodePath = value.toString();
+ }
+ value = componentContext.getProperties().get(NAMESPACE_PROPERTY);
+ if ( value != null ) {
+ this.namespace = value.toString();
+ }
+ value = componentContext.getProperties().get(NAMESPACE_PREFIX_PROPERTY);
+ if ( value != null ) {
+ this.namespacePrefix = value.toString();
+ this.namespacePrefixSep = this.namespacePrefix + ':';
+ }
+ }
+
+ /**
+ * Check if the repository is already initialized and return a fresh user session
+ * This method should be called by every service method before anything else.
+ */
+ protected Session checkInitialized() {
+ if ( !this.initialized ) {
+ this.initRepository();
+ }
+ try {
+ return this.repository.loginAdministrative(null);
+ } catch (RepositoryException e) {
+ throw new RuntimeException("Unable to login and create a new session.", e);
+ }
+ }
+
+ protected void createNodePath(Node parent, String relPath) throws RepositoryException{
+ int pos = relPath.indexOf('/');
+ String nodeName = (pos == -1 ? relPath : relPath.substring(0, pos));
+ if ( !parent.hasNode(nodeName) ) {
+ parent.addNode(nodeName, "nt:unstructured");
+ }
+ if ( pos != -1 ) {
+ this.createNodePath(parent.getNode(nodeName), relPath.substring(pos+1));
+ }
+ }
+
+ /**
+ * Initialize the repository:
+ * - register this component as an event listener
+ * - create the root node
+ */
+ protected synchronized void initRepository() {
+ if ( !this.initialized ) {
+ Session session = null;
+ try {
+ session = this.repository.loginAdministrative(null);
+ if ( !session.itemExists(this.rootNodePath) ) {
+ this.createNodePath(session.getRootNode(), this.rootNodePath.substring(1));
+ session.save();
+ }
+ try {
+ String prefix = session.getWorkspace().getNamespaceRegistry().getPrefix(this.namespace);
+ this.namespacePrefix = prefix;
+ this.namespacePrefixSep = prefix + ':';
+ } catch (NamespaceException ne) {
+ // mapping does not exist
+ session.getWorkspace().getNamespaceRegistry().registerNamespace(this.namespacePrefix, this.namespace);
+ }
+ } catch (RepositoryException e) {
+ throw new RuntimeException("Unable to get root node or to create new root node.", e);
+ } finally {
+ if ( session != null ) {
+ session.logout();
+ }
+ }
+ this.initialized = true;
+ }
+ }
+
+ /**
+ * Get the node path for the preferences tree.
+ * @param desc
+ * @return
+ */
+ protected String getNodePath(PreferencesImpl prefs) {
+ final PreferencesDescription desc = prefs.getDescription();
+ final StringBuffer buffer = new StringBuffer(this.rootNodePath);
+ buffer.append('/');
+ buffer.append(desc.getBundleId());
+ buffer.append('/');
+ if ( desc.getIdentifier() != null ) {
+ buffer.append("users");
+ buffer.append('/');
+ buffer.append(desc.getIdentifier());
+ } else {
+ buffer.append("system");
+ }
+ buffer.append('/');
+ buffer.append("preferences");
+ final String absPath = prefs.absolutePath();
+ if ( absPath.length() > 1 ) {
+ buffer.append(absPath);
+ }
+ return buffer.toString();
+ }
+
+ /**
+ * Get the node path for the preferences tree.
+ * @param desc
+ * @return
+ */
+ protected String getNodePath(PreferencesDescription desc) {
+ final StringBuffer buffer = new StringBuffer(this.rootNodePath);
+ buffer.append('/');
+ buffer.append(desc.getBundleId());
+ buffer.append('/');
+ if ( desc.getIdentifier() != null ) {
+ buffer.append("users");
+ buffer.append('/');
+ buffer.append(desc.getIdentifier());
+ } else {
+ buffer.append("system");
+ }
+ buffer.append('/');
+ buffer.append("preferences");
+ return buffer.toString();
+ }
+
+ /**
+ * Load this preferences from a node.
+ */
+ @SuppressWarnings("unchecked")
+ protected void readPreferences(PreferencesImpl prefs, Session session, Node node) throws RepositoryException {
+ final PropertyIterator iterator = node.getProperties();
+ while ( iterator.hasNext() ) {
+ final Property prop = iterator.nextProperty();
+ if ( prop.getName().startsWith(this.namespacePrefixSep) ) {
+ prefs.getProperties().put(prop.getName(), prop.getString());
+ }
+ }
+ }
+
+ /**
+ * Save this preferences to a node.
+ */
+ @SuppressWarnings("unchecked")
+ protected void writePreferences(PreferencesImpl prefs, Session session) throws RepositoryException {
+ final String path = this.getNodePath(prefs);
+ if ( !session.itemExists(path) ) {
+ this.createNodePath(session.getRootNode(), path.substring(1));
+ }
+
+ final Node node = (Node)session.getItem(path);
+ // process the change set
+ final Map properties = prefs.getProperties();
+ Iterator<String> i;
+
+ // remove properties
+ i = prefs.getChangeSet().getRemovedProperties().iterator();
+ while ( i.hasNext() ) {
+ final String name = i.next();
+ if ( node.hasProperty(this.namespacePrefixSep + name) ) {
+ node.getProperty(this.namespacePrefixSep + name).remove();
+ }
+ }
+ // update properties
+ i = prefs.getChangeSet().getChangedProperties().iterator();
+ while ( i.hasNext() ) {
+ final String name = i.next();
+ node.setProperty(this.namespacePrefixSep + name, (String)properties.get(name));
+ }
+ // remove children
+ i = prefs.getChangeSet().getRemovedChildren().iterator();
+ while ( i.hasNext() ) {
+ final String name = i.next();
+ if ( node.hasNode(name) ) {
+ node.getNode(name).remove();
+ }
+ }
+ // adding children is done by writing the child preferences!
+
+ session.save();
+ }
+
+ /**
+ * Read the preferences from the repository.
+ */
+ protected void readTree(PreferencesImpl prefs, Session session, Node node)
+ throws RepositoryException {
+ this.readPreferences(prefs, session, node);
+ final NodeIterator iterator = node.getNodes();
+ while ( iterator.hasNext() ) {
+ final Node current = iterator.nextNode();
+ final PreferencesImpl impl = (PreferencesImpl)prefs.node(current.getName());
+ this.readTree(impl, session, current);
+ }
+ }
+
+ /**
+ * @see org.apache.felix.prefs.BackingStore#availableBundles()
+ */
+ public Long[] availableBundles() {
+ final Session session = this.checkInitialized();
+ Long[] result = new Long[0];
+ try {
+ try {
+ final List<Long> bundleIds = new ArrayList<Long>();
+ final NodeIterator iterator = session.getRootNode().getNodes(this.rootNodePath);
+ while ( iterator.hasNext() ) {
+ final Node current = iterator.nextNode();
+ try {
+ final Long id = Long.valueOf(current.getName());
+ bundleIds.add(id);
+ } catch (NumberFormatException nfe) {
+ // we ignore this as this just indicates a wrong node in the tree
+ }
+ }
+ result = bundleIds.toArray(new Long[bundleIds.size()]);
+ } catch (RepositoryException e) {
+ // we ignore this for now
+ }
+ } finally {
+ session.logout();
+ }
+ return result;
+ }
+
+ /**
+ * @see org.apache.felix.prefs.BackingStore#load(org.apache.felix.prefs.BackingStoreManager, org.apache.felix.prefs.PreferencesDescription)
+ */
+ public PreferencesImpl load(BackingStoreManager manager, PreferencesDescription desc) throws BackingStoreException {
+ final Session session = this.checkInitialized();
+ try {
+ final String path = this.getNodePath(desc);
+ if ( session.itemExists(path) ) {
+ final PreferencesImpl root = new PreferencesImpl(desc, manager);
+ this.readTree(root, session, (Node)session.getItem(path));
+
+ return root;
+ }
+ } catch (RepositoryException re) {
+ throw new BackingStoreException("Unable to load preferences.", re);
+ } finally {
+ session.logout();
+ }
+ return null;
+ }
+
+ /**
+ * @see org.apache.felix.prefs.BackingStore#loadAll(org.apache.felix.prefs.BackingStoreManager, java.lang.Long)
+ */
+ public PreferencesImpl[] loadAll(BackingStoreManager manager, Long bundleId) throws BackingStoreException {
+ final Session session = this.checkInitialized();
+ try {
+ final List<PreferencesImpl> list = new ArrayList<PreferencesImpl>();
+ // check for system preferences
+ final PreferencesDescription systemDesc = new PreferencesDescription(bundleId, null);
+ final String systemPath = this.getNodePath(systemDesc);
+ if ( session.itemExists(systemPath) ) {
+ final Node rootNode = (Node)session.getItem(systemPath);
+ final PreferencesImpl root = new PreferencesImpl(systemDesc, manager);
+ this.readTree(root, session, rootNode);
+ }
+ // user preferences
+ final String userPath = this.rootNodePath + '/' + bundleId + '/' + "users";
+ if ( session.itemExists(userPath) ) {
+ final NodeIterator iterator = ((Node)session.getItem(userPath)).getNodes();
+ while ( iterator.hasNext() ) {
+ final Node current = iterator.nextNode();
+ final PreferencesDescription desc = new PreferencesDescription(bundleId, current.getName());
+ final PreferencesImpl root = new PreferencesImpl(desc, manager);
+
+ this.readTree(root, session, current);
+
+ list.add(root);
+ }
+ }
+ return list.toArray(new PreferencesImpl[list.size()]);
+ } catch (RepositoryException re) {
+ throw new BackingStoreException("Unable to load preferences.", re);
+ } finally {
+ session.logout();
+ }
+ }
+
+ /**
+ * @see org.apache.felix.prefs.BackingStore#remove(java.lang.Long)
+ */
+ public void remove(Long bundleId) throws BackingStoreException {
+ final Session session = this.checkInitialized();
+ try {
+ final String nodePath = this.rootNodePath + '/' + bundleId;
+ if ( session.itemExists(nodePath) ) {
+ final Node node = ((Node)session).getNode(nodePath);
+ final Node parent = node.getParent();
+ node.remove();
+ parent.save();
+ }
+ } catch (RepositoryException re) {
+ throw new BackingStoreException("Unable to remove preferences.", re);
+ } finally {
+ session.logout();
+ }
+ }
+
+ /**
+ * @see org.apache.felix.prefs.BackingStore#store(org.apache.felix.prefs.PreferencesImpl)
+ */
+ public void store(PreferencesImpl prefs) throws BackingStoreException {
+ final Session session = this.checkInitialized();
+ try {
+ this.store(prefs, session);
+ } catch (RepositoryException re) {
+ throw new BackingStoreException("Unable to store preferences.", re);
+ } finally {
+ session.logout();
+ }
+ }
+
+ protected void store(PreferencesImpl prefs, Session session)
+ throws BackingStoreException, RepositoryException {
+ // do we need to store at all?
+ if ( prefs.getChangeSet().hasChanges() ) {
+ // load existing data
+ final PreferencesImpl savedData = this.load(prefs.getBackingStoreManager(), prefs.getDescription());
+ if ( savedData != null ) {
+ // merge with saved version
+ final PreferencesImpl n = savedData.getOrCreateNode(prefs.absolutePath());
+ n.applyChanges(prefs);
+ prefs = n;
+ }
+ this.writePreferences(prefs, session);
+ }
+ // now process children
+ @SuppressWarnings("unchecked")
+ final Iterator<PreferencesImpl> i = prefs.getChildren().iterator();
+ while ( i.hasNext() ) {
+ final PreferencesImpl p = i.next();
+ this.store(p, session);
+ }
+
+ }
+
+ /**
+ * @see org.apache.felix.prefs.BackingStore#update(org.apache.felix.prefs.PreferencesImpl)
+ */
+ public void update(PreferencesImpl prefs) throws BackingStoreException {
+ final PreferencesImpl root = this.load(prefs.getBackingStoreManager(), prefs.getDescription());
+ if ( root != null ) {
+ // and now update
+ if ( root.nodeExists(prefs.absolutePath()) ) {
+ final PreferencesImpl updated = (PreferencesImpl)root.node(prefs.absolutePath());
+ prefs.update(updated);
+ }
+ }
+ }
+}
Propchange: sling/trunk/contrib/jcr/prefs/src/main/java/org/apache/sling/jcr/prefs/impl/JcrBackingStore.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: sling/trunk/contrib/jcr/prefs/src/main/java/org/apache/sling/jcr/prefs/impl/JcrBackingStore.java
------------------------------------------------------------------------------
svn:keywords = author date id revision rev url
Propchange: sling/trunk/contrib/jcr/prefs/src/main/java/org/apache/sling/jcr/prefs/impl/JcrBackingStore.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added: sling/trunk/contrib/jcr/prefs/src/main/resources/META-INF/LICENSE
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/jcr/prefs/src/main/resources/META-INF/LICENSE?rev=801955&view=auto
==============================================================================
--- sling/trunk/contrib/jcr/prefs/src/main/resources/META-INF/LICENSE (added)
+++ sling/trunk/contrib/jcr/prefs/src/main/resources/META-INF/LICENSE Fri Aug 7 11:40:53 2009
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed 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.
Propchange: sling/trunk/contrib/jcr/prefs/src/main/resources/META-INF/LICENSE
------------------------------------------------------------------------------
svn:eol-style = native
Added: sling/trunk/contrib/jcr/prefs/src/main/resources/META-INF/NOTICE
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/jcr/prefs/src/main/resources/META-INF/NOTICE?rev=801955&view=auto
==============================================================================
--- sling/trunk/contrib/jcr/prefs/src/main/resources/META-INF/NOTICE (added)
+++ sling/trunk/contrib/jcr/prefs/src/main/resources/META-INF/NOTICE Fri Aug 7 11:40:53 2009
@@ -0,0 +1,9 @@
+Apache Sling JCR Implementation for OSGi Preferences
+Copyright 2009 The Apache Software Foundation
+
+Apache Sling is based on source code originally developed
+by Day Software (http://www.day.com/).
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
+
Propchange: sling/trunk/contrib/jcr/prefs/src/main/resources/META-INF/NOTICE
------------------------------------------------------------------------------
svn:eol-style = native
Modified: sling/trunk/contrib/pom.xml
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/pom.xml?rev=801955&r1=801954&r2=801955&view=diff
==============================================================================
--- sling/trunk/contrib/pom.xml (original)
+++ sling/trunk/contrib/pom.xml Fri Aug 7 11:40:53 2009
@@ -93,6 +93,7 @@
<module>jcr/jackrabbit-api</module>
<module>jcr/jackrabbit-client</module>
<module>jcr/compiler</module>
+ <module>jcr/prefs</module>
<module>scripting/jsp-taglib-atom</module>
<module>scripting/freemarker</module>
<module>scripting/java</module>