This is an automated email from the ASF dual-hosted git repository. kwin pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-servlets-annotations.git
commit 8892698aeae1439653e9c43493f56589a545d41f Author: Konrad Windszus <[email protected]> AuthorDate: Sun May 13 11:16:30 2018 +0200 SLING-7624 initial commit --- .gitignore | 4 + LICENSE | 202 +++++++++++++++++++++ README.md | 3 + pom.xml | 57 ++++++ .../servlets/annotations/SlingServletByPath.java | 84 +++++++++ .../annotations/SlingServletByResourceType.java | 101 +++++++++++ 6 files changed, 451 insertions(+) diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4c06d21 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +/target/ +/.project +/.settings/ +/.classpath \ No newline at end of file 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..5fcce6b --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# Apache Sling Servlet Annotations + +This module is part of the [Apache Sling](https://sling.apache.org) project. diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..8903fa0 --- /dev/null +++ b/pom.xml @@ -0,0 +1,57 @@ +<?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</artifactId> + <version>33</version> + <relativePath/> + </parent> + + <artifactId>sling-org-apache-sling-servlets-annotations</artifactId> + <version>1.0.0-SNAPSHOT</version> + + <name>Apache Sling Servlets Annotations</name> + <description> + OSGi DS 1.4 component property type annotations for Sling servlets and filters + </description> + + <scm> + <connection>scm:git:https://gitbox.apache.org/repos/asf/sling-org-apache-sling-servlets-annotations.git</connection> + <developerConnection>scm:git:https://gitbox.apache.org/repos/asf/sling-org-apache-sling-servlets-annotations.git</developerConnection> + <url>https://gitbox.apache.org/repos/asf?p=sling-org-apache-sling-servlets-annotations.git</url> + <tag>HEAD</tag> + </scm> + + <!-- compile with java 7 --> + <properties> + <sling.java.version>7</sling.java.version> + </properties> + + <dependencies> + <dependency> + <groupId>org.osgi</groupId> + <artifactId>org.osgi.service.component.annotations</artifactId> + <version>1.4.0</version><!-- for annotation @ComponentPropertyType --> + </dependency> + <dependency> + <groupId>org.apache.sling</groupId> + <artifactId>org.apache.sling.api</artifactId> + <!-- https://issues.apache.org/jira/browse/SLING-6249, only for link in javadoc --> + <version>2.16.0</version> + </dependency> + </dependencies> + +</project> diff --git a/src/main/java/org/apache/sling/servlets/annotations/SlingServletByPath.java b/src/main/java/org/apache/sling/servlets/annotations/SlingServletByPath.java new file mode 100644 index 0000000..82c1609 --- /dev/null +++ b/src/main/java/org/apache/sling/servlets/annotations/SlingServletByPath.java @@ -0,0 +1,84 @@ +/* + * 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.servlets.annotations; + +import org.apache.sling.api.servlets.ServletResolverConstants; +import org.osgi.service.component.annotations.ComponentPropertyType; +/** + * Component Property Type (as defined by OSGi DS 1.4) for Sling Servlets. + * Takes care of writing the relevant component properties as being used by the Sling Servlet Resolver ({@link ServletResolverConstants}) + * to register the annotated servlet component as Sling servlet for a specific path. + * Preferably register Sling servlets by resource type ({@link SlingServletByResourceType}) though + * for reasons outlined at <a href="https://sling.apache.org/documentation/the-sling-engine/servlets.html#caveats-when-binding-servlets-by-path";> + * Caveats when binding servlets by path</a> + * + * @see <a href="https://github.com/apache/felix/blob/trunk/tools/org.apache.felix.scr.annotations/src/main/java/org/apache/felix/scr/annotations/sling/SlingServlet.java";>Felix SCR annotations</a> + * @see ServletResolverConstants + */ +@ComponentPropertyType +public @interface SlingServletByPath { + + /** + * The absolute paths under which the servlet is accessible as a resource. + * A relative path is made absolute by prefixing it with the value set through the + * {@link #sling_servlet_prefix()} element. + * <p> + * Either this property or the {@link #SLING_SERVLET_RESOURCE_TYPES} + * property must be set or the servlet is ignored. + * If both are set the servlet is registered using both ways. + * <p> + * A servlet using this property might be ignored unless its path is included + * in the Execution Paths {@code servletresolver.paths} configuration setting of the + * {@code org.apache.sling.servlets.resolver.internal.SlingServletResolver} service. + * + * @see ServletResolverConstants#SLING_SERVLET_PATHS + */ + String[] sling_servlet_paths(); + + /** + * The prefix/index to be used to register this servlet. + * It only is applied as prefix to {@link #sling_servlet_paths()} and + * in case they do not start with a "/". + * </p> + * <ul> + * <li>If the value of this element is a number, it defines the index of the search + * path entries from the resource resolver. The defined search path is used as + * a prefix to mount this servlet. The number can be -1 which always points to the + * last search entry. If the specified value is higher than than the highest index + * of the search paths, the last entry is used. The index starts with 0. + * If the value of this property is a string and parseable as a number, the above + * logic is used.</li> + * <li>If the value of this element is a string starting with "/", this value is applied + * as a prefix, regardless of the configured search paths!</li> + * <li>If the value is anything else, it is ignored.</li> + * </ul> + * If this property is empty, the configuration of the {@code org.apache.sling.servlets.resolver.internal.SlingServletResolver} + * service is used. + * In case even that one is not set "/" is used as prefix. + * @see ServletResolverConstants#SLING_SERVLET_PREFIX + */ + String sling_servlet_prefix() default ""; + + /** + * Containing the name of the servlet. If this is empty, the + * <code>component.name</code> property or the <code>service.pid</code> + * is used. If none of the three properties is defined, the Servlet is + * ignored. + * @see ServletResolverConstants#SLING_SERVLET_NAME + */ + String sling_core_servletName() default ""; +} diff --git a/src/main/java/org/apache/sling/servlets/annotations/SlingServletByResourceType.java b/src/main/java/org/apache/sling/servlets/annotations/SlingServletByResourceType.java new file mode 100644 index 0000000..f7e62b5 --- /dev/null +++ b/src/main/java/org/apache/sling/servlets/annotations/SlingServletByResourceType.java @@ -0,0 +1,101 @@ +/* + * 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.servlets.annotations; + +import org.apache.sling.api.servlets.ServletResolverConstants; +import org.osgi.service.component.annotations.ComponentPropertyType; +/** + * Component Property Type (as defined by OSGi DS 1.4) for Sling Servlets. + * Takes care of writing the relevant component properties as being used by the Sling Servlet Resolver ({@link ServletResolverConstants}) + * to register the annotated servlet component as Sling servlet for a specific resource type. + * + * @see <a href="https://github.com/apache/felix/blob/trunk/tools/org.apache.felix.scr.annotations/src/main/java/org/apache/felix/scr/annotations/sling/SlingServlet.java";>Felix SCR annotations</a> + * @see ServletResolverConstants + */ +@ComponentPropertyType +public @interface SlingServletByResourceType { + + /** + * The resource type(s) supported by the servlet (value + * is "sling.servlet.resourceTypes"). + * A relative resource type is made absolute by prefixing it with the value set through the + * {@link #sling_servlet_prefix()} property. + * <p> + */ + String[] sling_servlet_resourceTypes(); + + /** + * One ore more request URL selectors supported by the servlet. The + * selectors must be configured in the order as they would be specified in the URL that + * is as a list of dot-separated strings such as <em>print.a4</em>. + * In case this is not empty all selectors must match, otherwise the servlet is not executed. + * @see ServletResolverConstants#SLING_SERVLET_SELECTORS + */ + String[] sling_servlet_selectors() default {}; + + /** + * The request URL extensions supported by the servlet + * for GET requests. + * <p> + * It this is not set, the servlet is not limited to certain extensions. + * @see ServletResolverConstants#SLING_SERVLET_EXTENSIONS + */ + String[] sling_servlet_extensions() default {}; + + /** + * The request methods supported by the servlet. The value may be one of the HTTP + * methods or "*" for all methods. + * <p> + * If this is not set (i.e. empty array) it is assumed to be {@code GET} and {@code HEAD}. + * @see ServletResolverConstants#SLING_SERVLET_METHODS + * @see <a href="https://tools.ietf.org/html/rfc7231#section-4.3";>HTTP 1.1 Spec Methods</a> + */ + String[] sling_servlet_methods() default {}; + + /** + * The prefix/index to be used to register this servlet. + * It only is applied as prefix to {@link #sling_servlet_paths()} and + * in case they do not start with a "/". + * </p> + * <ul> + * <li>If the value of this element is a number, it defines the index of the search + * path entries from the resource resolver. The defined search path is used as + * a prefix to mount this servlet. The number can be -1 which always points to the + * last search entry. If the specified value is higher than than the highest index + * of the search paths, the last entry is used. The index starts with 0. + * If the value of this property is a string and parseable as a number, the above + * logic is used.</li> + * <li>If the value of this element is a string starting with "/", this value is applied + * as a prefix, regardless of the configured search paths!</li> + * <li>If the value is anything else, it is ignored.</li> + * </ul> + * If this property is empty, the configuration of the {@code org.apache.sling.servlets.resolver.internal.SlingServletResolver} + * service is used. + * In case even that one is not set "/" is used as prefix. + * @see ServletResolverConstants#SLING_SERVLET_PREFIX + */ + String sling_servlet_prefix() default ""; + + /** + * Containing the name of the servlet. If this is empty, the + * <code>component.name</code> property or the <code>service.pid</code> + * is used. If none of the three properties is defined, the Servlet is + * ignored. + * @see ServletResolverConstants#SLING_SERVLET_NAME + */ + String sling_core_servletName() default ""; +} -- To stop receiving notification emails like this one, please contact [email protected].
