You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by js...@apache.org on 2020/04/16 10:44:04 UTC
[sling-whiteboard] 01/01: initial commit of resource grafting bundle
This is an automated email from the ASF dual-hosted git repository.
jsedding pushed a commit to branch feature/sling-resource-graft
in repository https://gitbox.apache.org/repos/asf/sling-whiteboard.git
commit a7e25dcdb23bcf1ed7dcda491ed34ff33124d46e
Author: Julian Sedding <js...@apache.org>
AuthorDate: Thu Apr 16 12:43:15 2020 +0200
initial commit of resource grafting bundle
---
.asf.yaml | 6 +
.gitignore | 12 ++
CODE_OF_CONDUCT.md | 22 +++
CONTRIBUTING.md | 24 +++
Jenkinsfile | 20 ++
LICENSE | 202 ++++++++++++++++++++
README.md | 37 ++++
pom.xml | 73 +++++++
.../common/resource/graft/GraftedResource.java | 199 ++++++++++++++++++++
.../graft/impl/AbstractDelegatingResource.java | 118 ++++++++++++
.../impl/AbstractDelegatingResourceResolver.java | 209 +++++++++++++++++++++
.../sling/common/resource/graft/package-info.java | 22 +++
12 files changed, 944 insertions(+)
diff --git a/.asf.yaml b/.asf.yaml
new file mode 100644
index 0000000..4172e3a
--- /dev/null
+++ b/.asf.yaml
@@ -0,0 +1,6 @@
+github:
+ description: Apache Sling Resource Graft - utility for grafting resource trees onto existing resources
+ labels:
+ - java
+ - sling
+ - experimental
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..08082a5
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,12 @@
+.project
+.classpath
+.settings
+target
+bin
+*.iml
+.idea
+.DS_Store
+dependency-reduced-pom.xml
+.vscode
+node_modules
+openwhisk_action.zip
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000..0fa18e5
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,22 @@
+<!--/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ ~ 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.
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/-->
+Apache Software Foundation Code of Conduct
+====
+
+Being an Apache project, Apache Sling adheres to the Apache Software Foundation's [Code of Conduct](https://www.apache.org/foundation/policies/conduct.html).
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..ac82a1a
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,24 @@
+<!--/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ ~ 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.
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/-->
+Contributing
+====
+
+Thanks for choosing to contribute!
+
+You will find all the necessary details about how you can do this at https://sling.apache.org/contributing.html.
diff --git a/Jenkinsfile b/Jenkinsfile
new file mode 100644
index 0000000..f582519
--- /dev/null
+++ b/Jenkinsfile
@@ -0,0 +1,20 @@
+/**
+ * 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.
+ */
+
+slingOsgiBundleBuild()
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..d645695
--- /dev/null
+++ b/LICENSE
@@ -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.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9d82fc5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+[<img src="https://sling.apache.org/res/logos/sling.png"/>](https://sling.apache.org)
+
+ [](https://builds.apache.org/job/Sling/job/sling-whiteboard/job/master) [](https://www.apache.org/licenses/LICENSE-2.0)
+
+# Apache Sling Resource Graft
+
+This module is part of the [Apache Sling](https://sling.apache.org) project.
+
+## Grafting
+> Grafting or graftage is a horticultural technique whereby tissues of plants are joined so as to continue their growth together. The upper part of the combined plant is called the scion while the lower part is called the rootstock.
+
+_Source: https://en.wikipedia.org/wiki/Grafting_
+
+## Description
+
+This bundle contains utilities for grafting resource trees (scions) onto existing resources (rootstocks). It is intended to be used with Sling's ResourecDecorator API.
+
+## Example
+
+```java
+@Component
+public class ExampleResourceDecorator implements ResourceDecorator {
+
+ public Resource decorate(final Resource rootstock) {
+ GraftedResource scion = GraftedResource.graftOnto(rootstock);
+ scion.appendChild("foo") // see also appendChild() and insertBefore()
+ .setProperty("bar", this is foo")
+ .parent() // navigate back from "foo" to scion
+ .setProperty("virtual-property", "I'm not persisted')
+ .removeProperty("existing") // hide existing property
+ .removeChild("subtree"); // remove a complete subtree
+
+ return scion;
+ }
+ ...
+}
+```
\ No newline at end of file
diff --git a/pom.xml b/pom.xml
new file mode 100644
index 0000000..1916bf6
--- /dev/null
+++ b/pom.xml
@@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ 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-bundle-parent</artifactId>
+ <version>35</version>
+ <relativePath/>
+ </parent>
+
+ <artifactId>sling-resource-graft</artifactId>
+ <version>0.0.1-SNAPSHOT</version>
+
+ <name>Apache Sling Resource Graft</name>
+ <description>
+ This bundle contains utilities for grafting resource trees (scions) onto existing
+ resources (rootstocks).
+ </description>
+
+ <properties>
+ <!-- skip baseline until the first release -->
+ <bnd.baseline.skip>true</bnd.baseline.skip>
+ </properties>
+
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.api</artifactId>
+ <version>2.20.0</version>
+ <scope>provided</scope>
+ </dependency>
+
+ <dependency>
+ <groupId>javax.servlet</groupId>
+ <artifactId>javax.servlet-api</artifactId>
+ <version>3.1.0</version>
+ <scope>provided</scope>
+ </dependency>
+
+ <dependency>
+ <groupId>org.osgi</groupId>
+ <artifactId>org.osgi.annotation.versioning</artifactId>
+ <version>1.1.0</version>
+ <scope>provided</scope>
+ </dependency>
+
+ <dependency>
+ <groupId>org.jetbrains</groupId>
+ <artifactId>annotations</artifactId>
+ <version>19.0.0</version>
+ <scope>provided</scope>
+ </dependency>
+ </dependencies>
+</project>
diff --git a/src/main/java/org/apache/sling/common/resource/graft/GraftedResource.java b/src/main/java/org/apache/sling/common/resource/graft/GraftedResource.java
new file mode 100644
index 0000000..c67162f
--- /dev/null
+++ b/src/main/java/org/apache/sling/common/resource/graft/GraftedResource.java
@@ -0,0 +1,199 @@
+/*
+ * 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.common.resource.graft;
+
+import org.apache.sling.api.resource.Resource;
+import org.apache.sling.api.resource.ResourceResolver;
+import org.apache.sling.api.resource.ResourceUtil;
+import org.apache.sling.api.resource.SyntheticResource;
+import org.apache.sling.api.resource.ValueMap;
+import org.apache.sling.common.resource.graft.impl.AbstractDelegatingResource;
+import org.apache.sling.common.resource.graft.impl.AbstractDelegatingResourceResolver;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * This is not a general purpose implementation. It is sufficient for covering the
+ * execution path taken when the default GET servlet renders a dialog (as JSON).
+ */
+public class GraftedResource extends AbstractDelegatingResource {
+
+ private final GraftingResourceResolver resolver;
+
+ private final Map<String, Object> properties = new LinkedHashMap<>();
+
+ public static GraftedResource graftOnto(Resource rootstock) {
+ // Resource implementations inheriting from AbstractResource
+ // delegate all child related calls to their ResourceResolver
+ return new GraftedResource(new GraftingResourceResolver(rootstock.getResourceResolver()), rootstock);
+ }
+
+ private GraftedResource(final GraftingResourceResolver resolver, final Resource rootstock) {
+ super(rootstock);
+ this.resolver = resolver;
+ ValueMap props = rootstock.getValueMap();
+ if (!props.isEmpty()) {
+ this.properties.putAll(props);
+ }
+ }
+
+ @Nullable
+ public GraftedResource parent() {
+ return resolver.getGraftedParent(this);
+ }
+
+ public GraftedResource appendChild(@NotNull final String name) {
+ return addChildBefore(null, name);
+ }
+
+ public GraftedResource addChildBefore(@Nullable final String beforeName, @NotNull final String name) {
+ SyntheticResource syntheticResource = new SyntheticResource(getDelegate().getResourceResolver(), getPath() + "/" + name, null);
+ return insertBefore(beforeName, syntheticResource);
+ }
+
+ public GraftedResource setProperty(String name, Object value) {
+ properties.put(name, value);
+ return this;
+ }
+
+ public GraftedResource removeProperty(String name) {
+ properties.remove(name);
+ return this;
+ }
+
+ public GraftedResource insertBefore(@Nullable final String beforeName, @NotNull final Resource child) {
+ return resolver.insertBefore(this, beforeName, child);
+ }
+
+ public void removeChild(@NotNull final String name) {
+ resolver.removeChild(this, name);
+ }
+
+ @NotNull
+ @Override
+ public ResourceResolver getResourceResolver() {
+ return resolver;
+ }
+
+ @Override @SuppressWarnings("unchecked")
+ public <AdapterType> AdapterType adaptTo(@NotNull final Class<AdapterType> type) {
+ if (type == Map.class) {
+ return (AdapterType) properties;
+ }
+ return super.adaptTo(type);
+ }
+
+ private static class GraftingResourceResolver extends AbstractDelegatingResourceResolver {
+
+ private final Map<String, List<Resource>> childrenByParent = new LinkedHashMap<>();
+
+ private GraftingResourceResolver(final ResourceResolver delegate) {
+ super(delegate);
+ }
+
+ @Override @NotNull
+ public Iterator<Resource> listChildren(@NotNull final Resource parent) {
+ List<Resource> children = childrenByParent.get(parent.getPath());
+ if (children != null) {
+ return children.iterator();
+ } else {
+ return getDelegate().listChildren(parent);
+ }
+ }
+
+ private GraftedResource insertBefore(@NotNull final Resource parent, @Nullable final String beforeName, @NotNull final Resource child) {
+ List<Resource> children = getOrInitializeChildren(parent);
+ GraftedResource decoratedChild = decorate(child);
+ for (int i = 0; i < children.size(); i++) {
+ if (children.get(i).getName().equals(beforeName)) {
+ children.add(i, decoratedChild);
+ return decoratedChild;
+ }
+ }
+
+ // add to the end if "beforeName" is not found
+ children.add(decoratedChild);
+ return decoratedChild;
+ }
+
+ public void removeChild(@NotNull final Resource parent, @NotNull final String name) {
+ String parentPath = parent.getPath();
+ if (!isInitialized(parentPath)) {
+ Resource childToRemove = parent.getChild(name);
+ if (childToRemove == null) {
+ // parent does not have this child, nothing to do
+ return;
+ }
+ }
+ List<Resource> children = getOrInitializeChildren(parent);
+ Iterator<Resource> childIterator = children.iterator();
+ while (childIterator.hasNext()) {
+ if (childIterator.next().getName().equals(name)) {
+ childIterator.remove();
+ return;
+ }
+ }
+ }
+
+ private boolean isInitialized(@NotNull final String parentPath) {
+ return childrenByParent.containsKey(parentPath);
+ }
+
+ @NotNull
+ private List<Resource> getOrInitializeChildren(@NotNull final Resource parent) {
+ String parentPath = parent.getPath();
+ if (!isInitialized(parentPath)) {
+ ArrayList<Resource> children = new ArrayList<>();
+ for (final Resource child : getDelegate().getChildren(parent)) {
+ children.add(decorate(child));
+ }
+ childrenByParent.put(parentPath, children);
+ }
+ return childrenByParent.get(parentPath);
+ }
+
+ private GraftedResource decorate(Resource resource) {
+ // Resource implementations inheriting from AbstractResource
+ // delegate all child related calls to their ResourceResolver
+ return new GraftedResource(this, resource);
+ }
+
+ @Nullable
+ private GraftedResource getGraftedParent(final GraftedResource child) {
+ String parentPath = ResourceUtil.getParent(child.getPath());
+ String grandParentPath = ResourceUtil.getParent(parentPath);
+ if (isInitialized(grandParentPath)) {
+ String parentName = ResourceUtil.getName(parentPath);
+ List<Resource> resources = childrenByParent.get(grandParentPath);
+ for (final Resource resource : resources) {
+ if (resource.getName().equals(parentName)) {
+ return (GraftedResource) resource;
+ }
+ }
+ }
+ return null;
+ }
+ }
+}
diff --git a/src/main/java/org/apache/sling/common/resource/graft/impl/AbstractDelegatingResource.java b/src/main/java/org/apache/sling/common/resource/graft/impl/AbstractDelegatingResource.java
new file mode 100644
index 0000000..0c3234e
--- /dev/null
+++ b/src/main/java/org/apache/sling/common/resource/graft/impl/AbstractDelegatingResource.java
@@ -0,0 +1,118 @@
+/*
+ * 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.common.resource.graft.impl;
+
+import org.apache.sling.api.resource.Resource;
+import org.apache.sling.api.resource.ResourceMetadata;
+import org.apache.sling.api.resource.ResourceResolver;
+import org.apache.sling.api.resource.ValueMap;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.Iterator;
+
+/**
+ * Custom AbstractDelegatingResource implementation to avoid the automatic
+ * unwrapping that is applied to Sling's ResourceWrapper deep down in
+ * Sling's request processing.
+ * <br>
+ * This class simply delegates all calls to the delegate resource.
+ */
+public abstract class AbstractDelegatingResource implements Resource {
+
+ private Resource delegate;
+
+ protected AbstractDelegatingResource(Resource delegate) {
+ this.delegate = delegate;
+ }
+
+ protected final Resource getDelegate() {
+ return delegate;
+ }
+
+ @Override @Nullable
+ public Resource getChild(@NotNull final String relPath) {
+ return getDelegate().getChild(relPath);
+ }
+
+ @Override @NotNull
+ public Iterable<Resource> getChildren() {
+ return getDelegate().getChildren();
+ }
+
+ @Override @NotNull
+ public String getName() {
+ return getDelegate().getName();
+ }
+
+ @Override @Nullable
+ public Resource getParent() {
+ return getDelegate().getParent();
+ }
+
+ @Override @NotNull
+ public String getPath() {
+ return getDelegate().getPath();
+ }
+
+ @Override @NotNull
+ public ResourceMetadata getResourceMetadata() {
+ return getDelegate().getResourceMetadata();
+ }
+
+ @Override @NotNull
+ public ResourceResolver getResourceResolver() {
+ return getDelegate().getResourceResolver();
+ }
+
+ @Override @Nullable
+ public String getResourceSuperType() {
+ return getDelegate().getResourceSuperType();
+ }
+
+ @Override @NotNull
+ public String getResourceType() {
+ return getDelegate().getResourceType();
+ }
+
+ @Override @NotNull
+ public ValueMap getValueMap() {
+ return getDelegate().getValueMap();
+ }
+
+ @Override
+ public boolean hasChildren() {
+ return getDelegate().hasChildren();
+ }
+
+ @Override
+ public boolean isResourceType(final String resourceType) {
+ return getDelegate().isResourceType(resourceType);
+ }
+
+ @Override @NotNull
+ public Iterator<Resource> listChildren() {
+ return getDelegate().listChildren();
+ }
+
+ @Override @Nullable
+ public <AdapterType> AdapterType adaptTo(@NotNull final Class<AdapterType> type) {
+ return getDelegate().adaptTo(type);
+ }
+}
diff --git a/src/main/java/org/apache/sling/common/resource/graft/impl/AbstractDelegatingResourceResolver.java b/src/main/java/org/apache/sling/common/resource/graft/impl/AbstractDelegatingResourceResolver.java
new file mode 100644
index 0000000..c1c4984
--- /dev/null
+++ b/src/main/java/org/apache/sling/common/resource/graft/impl/AbstractDelegatingResourceResolver.java
@@ -0,0 +1,209 @@
+/*
+ * 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.common.resource.graft.impl;
+
+import org.apache.sling.api.resource.LoginException;
+import org.apache.sling.api.resource.PersistenceException;
+import org.apache.sling.api.resource.Resource;
+import org.apache.sling.api.resource.ResourceResolver;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import javax.servlet.http.HttpServletRequest;
+import java.util.Iterator;
+import java.util.Map;
+
+/**
+ * Simple abstract ResourceResolver implementation that delegates all calls
+ * to the delegate ResourceResolver.
+ */
+public abstract class AbstractDelegatingResourceResolver implements ResourceResolver {
+
+ private final ResourceResolver delegate;
+
+ protected AbstractDelegatingResourceResolver(ResourceResolver delegate) {
+ this.delegate = delegate;
+ }
+
+ protected final ResourceResolver getDelegate() {
+ return delegate;
+ }
+
+ @Override @NotNull
+ public ResourceResolver clone(final Map<String, Object> authenticationInfo) throws LoginException {
+ return getDelegate().clone(authenticationInfo);
+ }
+
+ @Override
+ public void close() {
+ getDelegate().close();
+ }
+
+ @Override
+ public void commit() throws PersistenceException {
+ getDelegate().commit();
+ }
+
+ @Override @NotNull
+ public Resource create(@NotNull final Resource parent, @NotNull final String name, final Map<String, Object> properties) throws PersistenceException {
+ return getDelegate().create(parent, name, properties);
+ }
+
+ @Override
+ public void delete(@NotNull final Resource resource) throws PersistenceException {
+ getDelegate().delete(resource);
+ }
+
+ @Override @NotNull
+ public Iterator<Resource> findResources(@NotNull final String query, final String language) {
+ return getDelegate().findResources(query, language);
+ }
+
+ @Override
+ public Object getAttribute(@NotNull final String name) {
+ return getDelegate().getAttribute(name);
+ }
+
+ @Override @NotNull
+ public Iterator<String> getAttributeNames() {
+ return getDelegate().getAttributeNames();
+ }
+
+ @Override @NotNull
+ public Iterable<Resource> getChildren(@NotNull final Resource parent) {
+ return getDelegate().getChildren(parent);
+ }
+
+ @Override
+ public String getParentResourceType(final Resource resource) {
+ return getDelegate().getParentResourceType(resource);
+ }
+
+ @Override
+ public String getParentResourceType(final String resourceType) {
+ return getDelegate().getParentResourceType(resourceType);
+ }
+
+ @Override @Nullable
+ public Resource getResource(final Resource base, @NotNull final String path) {
+ return getDelegate().getResource(base, path);
+ }
+
+ @Override @Nullable
+ public Resource getResource(@NotNull final String path) {
+ return getDelegate().getResource(path);
+ }
+
+ @Override @NotNull
+ public String[] getSearchPath() {
+ return getDelegate().getSearchPath();
+ }
+
+ @Override
+ public String getUserID() {
+ return getDelegate().getUserID();
+ }
+
+ @Override
+ public boolean hasChanges() {
+ return getDelegate().hasChanges();
+ }
+
+ @Override
+ public boolean hasChildren(@NotNull final Resource resource) {
+ return getDelegate().hasChildren(resource);
+ }
+
+ @Override
+ public boolean isLive() {
+ return getDelegate().isLive();
+ }
+
+ @Override
+ public boolean isResourceType(final Resource resource, final String resourceType) {
+ return getDelegate().isResourceType(resource, resourceType);
+ }
+
+ @Override @NotNull
+ public Iterator<Resource> listChildren(@NotNull final Resource parent) {
+ return getDelegate().listChildren(parent);
+ }
+
+ @Override @Nullable
+ public String map(@NotNull final HttpServletRequest request,@NotNull final String resourcePath) {
+ return getDelegate().map(request, resourcePath);
+ }
+
+ @Override @NotNull
+ public String map(@NotNull final String resourcePath) {
+ return getDelegate().map(resourcePath);
+ }
+
+ @Override @NotNull
+ public Iterator<Map<String, Object>> queryResources(@NotNull final String query, final String language) {
+ return getDelegate().queryResources(query, language);
+ }
+
+ @Override
+ public void refresh() {
+ getDelegate().refresh();
+ }
+
+ @Override @NotNull
+ public Resource resolve(@NotNull final String absPath) {
+ return getDelegate().resolve(absPath);
+ }
+
+ @Override
+ @Deprecated
+ @NotNull
+ public Resource resolve(@NotNull final HttpServletRequest request) {
+ return getDelegate().resolve(request);
+ }
+
+ @Override @NotNull
+ public Resource resolve(@NotNull final HttpServletRequest request, @NotNull final String absPath) {
+ return getDelegate().resolve(request, absPath);
+ }
+
+ @Override
+ public void revert() {
+ getDelegate().revert();
+ }
+
+ @Override @Nullable
+ public <AdapterType> AdapterType adaptTo(@NotNull final Class<AdapterType> type) {
+ return getDelegate().adaptTo(type);
+ }
+
+ @Override
+ public Resource getParent(@NotNull final Resource child) {
+ return getDelegate().getParent(child);
+ }
+
+ @Override
+ public Resource move(final String srcAbsPath, final String destAbsPath) throws PersistenceException {
+ return getDelegate().move(srcAbsPath, destAbsPath);
+ }
+
+ @Override
+ public Resource copy(final String srcAbsPath, final String destAbsPath) throws PersistenceException {
+ return getDelegate().copy(srcAbsPath, destAbsPath);
+ }
+}
diff --git a/src/main/java/org/apache/sling/common/resource/graft/package-info.java b/src/main/java/org/apache/sling/common/resource/graft/package-info.java
new file mode 100644
index 0000000..3e1cabc
--- /dev/null
+++ b/src/main/java/org/apache/sling/common/resource/graft/package-info.java
@@ -0,0 +1,22 @@
+/*
+ * 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.
+ */
+@Version("1.0.0")
+package org.apache.sling.common.resource.graft;
+
+import org.osgi.annotation.versioning.Version;
\ No newline at end of file