You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ra...@apache.org on 2020/08/28 14:25:48 UTC
[sling-org-apache-sling-scripting-sightly-models-provider] branch
master updated: deprecated module
This is an automated email from the ASF dual-hosted git repository.
radu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-scripting-sightly-models-provider.git
The following commit(s) were added to refs/heads/master by this push:
new ec27fc9 deprecated module
ec27fc9 is described below
commit ec27fc978534475f1061f0748548084fcc5b13a6
Author: Radu Cotescu <ra...@apache.org>
AuthorDate: Fri Aug 28 16:25:16 2020 +0200
deprecated module
---
.asf.yaml | 7 +
CODE_OF_CONDUCT.md | 22 ---
CONTRIBUTING.md | 24 ---
Jenkinsfile | 20 --
LICENSE | 202 ---------------------
README.md | 12 +-
bnd.bnd | 1 -
pom.xml | 135 --------------
.../models/impl/SlingModelsUseProvider.java | 179 ------------------
9 files changed, 11 insertions(+), 591 deletions(-)
diff --git a/.asf.yaml b/.asf.yaml
new file mode 100644
index 0000000..4ed80ee
--- /dev/null
+++ b/.asf.yaml
@@ -0,0 +1,7 @@
+github:
+ description: "Apache Sling Scripting HTL Sling Models Use Provider (deprecated)"
+ homepage: "https://sling.apache.org"
+ labels:
+ - java
+ - sling
+ - deprecated
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
deleted file mode 100644
index 0fa18e5..0000000
--- a/CODE_OF_CONDUCT.md
+++ /dev/null
@@ -1,22 +0,0 @@
-<!--/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- ~ 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
deleted file mode 100644
index ac82a1a..0000000
--- a/CONTRIBUTING.md
+++ /dev/null
@@ -1,24 +0,0 @@
-<!--/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- ~ 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
deleted file mode 100644
index f582519..0000000
--- a/Jenkinsfile
+++ /dev/null
@@ -1,20 +0,0 @@
-/**
- * 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
deleted file mode 100644
index d645695..0000000
--- a/LICENSE
+++ /dev/null
@@ -1,202 +0,0 @@
-
- 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
index 0474752..0eb84b3 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,9 @@
[](https://sling.apache.org)
- [](https://ci-builds.apache.org/job/Sling/job/modules/job/sling-org-apache-sling-scripting-sightly-models-provider/job/master/) [](https://sonarcloud.io/dashboard?id=apache_sling-org-a [...]
+# Apache Sling Scripting HTL Sling Models Use Provider (deprecated)
-# Apache Sling Scripting HTL Sling Models Use Provider
+This module is part of the [Apache Sling](https://sling.apache.org) project, but it is no longer maintained.
-This module is part of the [Apache Sling](https://sling.apache.org) project.
+Version 1.4.0-1.4.0 of the [`org.apache.sling.scripting.sightly`](https://github.com/apache/sling-org-apache-sling-scripting-sightly) module makes this module obsolete, since the functionality of the `SlingModelsUseProvider` has been fully integrated into the HTL Script Engine.
-The Apache Sling Scripting HTL Sling Models Use Provider adds support for accessing
-[Sling Models](https://sling.apache.org/documentation/bundles/models.html)
-from HTL's Use-API leveraging the `ModelFactory`.
-
-Version 1.4.0-1.4.0 of the `org.apache.sling.scripting.sightly` module makes this module obsolete, since the functionality of the `SlingModelsUseProvider` has been fully integrated into the HTL Script Engine.
+For reference or potential bugfix releases please use the [`maintenance`](https://github.com/apache/sling-org-apache-sling-scripting-sightly-models-provider/tree/maintenance) branch.
diff --git a/bnd.bnd b/bnd.bnd
deleted file mode 100644
index a1c2bda..0000000
--- a/bnd.bnd
+++ /dev/null
@@ -1 +0,0 @@
-Require-Capability: io.sightly.runtime; filter:="(&(version>=1.0)(!(version>=2.0)))", io.sightly; filter:="(&(version>=1.0)(!(version>=2.0)))"
diff --git a/pom.xml b/pom.xml
deleted file mode 100644
index bfe3d6c..0000000
--- a/pom.xml
+++ /dev/null
@@ -1,135 +0,0 @@
-<?xml version="1.0"?>
-<!--~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- ~ 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>
- <!-- ======================================================================= -->
- <!-- P A R E N T P R O J E C T -->
- <!-- ======================================================================= -->
- <parent>
- <groupId>org.apache.sling</groupId>
- <artifactId>sling-bundle-parent</artifactId>
- <version>35</version>
- <relativePath />
- </parent>
-
- <!-- ======================================================================= -->
- <!-- P R O J E C T -->
- <!-- ======================================================================= -->
- <artifactId>org.apache.sling.scripting.sightly.models.provider</artifactId>
- <version>1.0.11-SNAPSHOT</version>
-
- <name>Apache Sling Scripting HTL Sling Models Use Provider</name>
-
- <description>
- Apache Sling Scripting HTL Sling Models Use Provider adds support for accessing Sling Models from HTL's Use-API leveraging the
- ModelFactory.
- </description>
-
- <scm>
- <connection>scm:git:https://gitbox.apache.org/repos/asf/sling-org-apache-sling-scripting-sightly-models-provider.git</connection>
- <developerConnection>scm:git:https://gitbox.apache.org/repos/asf/sling-org-apache-sling-scripting-sightly-models-provider.git</developerConnection>
- <url>https://gitbox.apache.org/repos/asf?p=sling-org-apache-sling-scripting-sightly-models-provider.git</url>
- <tag>HEAD</tag>
- </scm>
-
- <!-- ======================================================================= -->
- <!-- B U I L D -->
- <!-- ======================================================================= -->
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <configuration>
- <!-- No javadocs -->
- <excludePackageNames>
- org.apache.sling.scripting.sightly.models.impl
- </excludePackageNames>
- </configuration>
- </plugin>
- </plugins>
- </build>
-
- <!-- ======================================================================= -->
- <!-- D E P E N D E N C I E S -->
- <!-- ======================================================================= -->
- <dependencies>
- <!-- OSGI -->
- <dependency>
- <groupId>org.osgi</groupId>
- <artifactId>osgi.core</artifactId>
- <scope>provided</scope>
- </dependency>
- <dependency>
- <groupId>org.osgi</groupId>
- <artifactId>org.osgi.service.component.annotations</artifactId>
- <scope>provided</scope>
- </dependency>
- <dependency>
- <groupId>org.osgi</groupId>
- <artifactId>org.osgi.service.metatype.annotations</artifactId>
- <scope>provided</scope>
- </dependency>
-
- <!-- Sling -->
- <dependency>
- <groupId>org.apache.sling</groupId>
- <artifactId>org.apache.sling.api</artifactId>
- <version>2.4.0</version>
- <scope>provided</scope>
- </dependency>
-
- <dependency>
- <groupId>org.apache.sling</groupId>
- <artifactId>org.apache.sling.models.api</artifactId>
- <version>1.2.2</version>
- <scope>provided</scope>
- </dependency>
-
- <!-- HTL -->
- <dependency>
- <groupId>org.apache.sling</groupId>
- <artifactId>org.apache.sling.scripting.sightly.runtime</artifactId>
- <version>1.1.3-1.4.0-SNAPSHOT</version>
- <scope>provided</scope>
- </dependency>
-
- <dependency>
- <groupId>org.apache.sling</groupId>
- <artifactId>org.apache.sling.commons.classloader</artifactId>
- <version>1.3.0</version>
- <scope>provided</scope>
- </dependency>
-
- <!-- Logging -->
- <dependency>
- <groupId>org.slf4j</groupId>
- <artifactId>slf4j-api</artifactId>
- <scope>provided</scope>
- </dependency>
-
- <dependency>
- <groupId>javax.servlet</groupId>
- <artifactId>javax.servlet-api</artifactId>
- <scope>provided</scope>
- </dependency>
-
- </dependencies>
-</project>
diff --git a/src/main/java/org/apache/sling/scripting/sightly/models/impl/SlingModelsUseProvider.java b/src/main/java/org/apache/sling/scripting/sightly/models/impl/SlingModelsUseProvider.java
deleted file mode 100644
index 248df4a..0000000
--- a/src/main/java/org/apache/sling/scripting/sightly/models/impl/SlingModelsUseProvider.java
+++ /dev/null
@@ -1,179 +0,0 @@
-/*******************************************************************************
- * 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
- * <p>
- * http://www.apache.org/licenses/LICENSE-2.0
- * <p>
- * 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.scripting.sightly.models.impl;
-
-import java.util.HashMap;
-import java.util.Map;
-import java.util.regex.Pattern;
-import javax.script.Bindings;
-import javax.servlet.ServletRequest;
-
-import org.apache.sling.api.SlingHttpServletRequest;
-import org.apache.sling.api.resource.Resource;
-import org.apache.sling.api.scripting.SlingBindings;
-import org.apache.sling.commons.classloader.DynamicClassLoaderManager;
-import org.apache.sling.models.factory.ModelFactory;
-import org.apache.sling.scripting.sightly.render.RenderContext;
-import org.apache.sling.scripting.sightly.use.ProviderOutcome;
-import org.apache.sling.scripting.sightly.use.UseProvider;
-import org.osgi.framework.Constants;
-import org.osgi.service.component.annotations.Component;
-import org.osgi.service.component.annotations.Reference;
-import org.osgi.service.metatype.annotations.AttributeDefinition;
-import org.osgi.service.metatype.annotations.Designate;
-import org.osgi.service.metatype.annotations.ObjectClassDefinition;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-/**
- * <p>
- * HTL {@link UseProvider} which will instantiate a referenced Sling Model.
- * </p>
- * <p>
- * For that it tries to use the {@link ModelFactory#createModel(Object, Class)} first with the adaptable {@link SlingHttpServletRequest}
- * then with the adaptable {@link Resource}. It will always fail with an exception (i.e. no other {@code UseProvider} is
- * asked afterwards and the exception is being rethrown) in case the following two preconditions are fulfilled:
- * </p>
- * <ol>
- * <li>the given identifier specifies a class which can be loaded by a {@link org.apache.sling.commons.classloader.DynamicClassLoader}</li>
- * <li>the loaded class has a {@link org.apache.sling.models.annotations.Model} annotation</li>
- * </ol>
- *
- * <p>
- * In case any of those preconditions are not fulfilled the other registered {@link UseProvider}s will be queried.
- * </p>
- *
- * @deprecated This service's functionality has been fully integrated into the
- * {@link org.apache.sling.scripting.sightly.impl.engine.extension.use.JavaUseProvider} starting from version 1.4.0-1.4.0 of the {@code
- * org.apache.sling.scripting.sightly} bundle.
- */
-@Component(
- service = UseProvider.class,
- configurationPid = "org.apache.sling.scripting.sightly.models.impl.SlingModelsUseProvider",
- property = {
- /**
- * Must have a higher priority than {@link org.apache.sling.scripting.sightly.impl.engine.extension.use.JavaUseProvider} but lower
- * than {@link org.apache.sling.scripting.sightly.impl.engine.extension.use.RenderUnitProvider} to kick in before the
- * JavaUseProvider but after the RenderUnitProvider.
- */
- Constants.SERVICE_RANKING + ":Integer=95"
- }
-)
-@Deprecated
-public class SlingModelsUseProvider implements UseProvider {
-
- @interface Configuration {
-
- @AttributeDefinition(
- name = "Service Ranking",
- description = "The Service Ranking value acts as the priority with which this Use Provider is queried to return an " +
- "Use-object. A higher value represents a higher priority."
- )
- int service_ranking() default 95;
- }
-
- private static final Logger LOGGER = LoggerFactory.getLogger(SlingModelsUseProvider.class);
- private static final Pattern JAVA_PATTERN = Pattern.compile(
- "([[\\p{L}&&[^\\p{Lu}]]_$][\\p{L}\\p{N}_$]*\\.)*[\\p{Lu}_$][\\p{L}\\p{N}_$]*");
-
-
- @Reference
- private ModelFactory modelFactory = null;
-
- @Reference
- private DynamicClassLoaderManager dynamicClassLoaderManager = null;
-
- @Override
- public ProviderOutcome provide(final String identifier, final RenderContext renderContext, final Bindings arguments) {
- if (!JAVA_PATTERN.matcher(identifier).matches()) {
- LOGGER.debug("Identifier {} does not match a Java class name pattern.", identifier);
- return ProviderOutcome.failure();
- }
- final Class<?> cls;
- try {
- cls = dynamicClassLoaderManager.getDynamicClassLoader().loadClass(identifier);
- } catch (ClassNotFoundException e) {
- LOGGER.debug("Could not find class with the given name {}.", identifier);
- // next use provider will be queried
- return ProviderOutcome.failure();
- }
- if (!modelFactory.isModelClass(cls)) {
- LOGGER.debug("{} is not a Sling Model.");
- // next use provider will be queried
- return ProviderOutcome.failure();
- }
- Bindings globalBindings = renderContext.getBindings();
- SlingHttpServletRequest request = (SlingHttpServletRequest) globalBindings.get(SlingBindings.REQUEST);
- if (request == null) {
- return ProviderOutcome.failure(new IllegalStateException("Could not get request from bindings."));
- }
- // pass parameters as request attributes
- Map<String, Object> overrides = setRequestAttributes(request, arguments);
-
- try {
- // try to instantiate class via Sling Models (first via request, then via resource)
- if (modelFactory.canCreateFromAdaptable(request, cls)) {
- LOGGER.debug("Trying to instantiate class {} as Sling Model from request.", cls);
- return ProviderOutcome.notNullOrFailure(modelFactory.createModel(request, cls));
- }
- Resource resource = (Resource) globalBindings.get(SlingBindings.RESOURCE);
- if (resource == null) {
- LOGGER.debug("Could not get resource from bindings.");
- return ProviderOutcome.failure(new IllegalStateException("Could not get resource from bindings."));
- }
- if (modelFactory.canCreateFromAdaptable(resource, cls)) {
- LOGGER.debug("Trying to instantiate class {} as Sling Model from resource.", cls);
- return ProviderOutcome.notNullOrFailure(modelFactory.createModel(resource, cls));
- }
- return ProviderOutcome.failure(
- new IllegalStateException("Could not adapt the given Sling Model from neither request nor resource: " + cls));
- } catch (Throwable e) {
- return ProviderOutcome.failure(e);
- } finally {
- resetRequestAttribute(request, overrides);
-
- }
- }
-
- private Map<String, Object> setRequestAttributes(final ServletRequest request, final Bindings arguments) {
- Map<String, Object> overrides = new HashMap<>();
- for (Map.Entry<String, Object> entry : arguments.entrySet()) {
- String key = entry.getKey();
- Object value = entry.getValue();
- Object oldValue = request.getAttribute(key);
- if (oldValue != null) {
- overrides.put(key, oldValue);
- } else {
- overrides.put(key, null);
- }
- request.setAttribute(key, value);
- }
- return overrides;
- }
-
- private void resetRequestAttribute(final ServletRequest request, final Map<String, Object> overrides) {
- for (Map.Entry<String, Object> entry : overrides.entrySet()) {
- String key = entry.getKey();
- Object value = entry.getValue();
- if (value == null) {
- request.removeAttribute(key);
- } else {
- request.setAttribute(key, value);
- }
- }
- }
-}