Adding @CurrentPage, @PageTemplate annotations (#3)

* Adding @CurrentPage, @PageTemplate annotations
- Adding new annotations
- Removing non needed dependencies
- Updating pom.xml
- Updating README.md

* Adding version to 0.0.2

Author: jmigac

README.md

@@ -70,6 +70,16 @@ private LocalDateTime date;
 private LocalDatetime date;
 ```
 
+```
+@CurrentPage
+private Page page;
+```
+
+```
+@PageTemplate
+private Template template;
+```
+
 Annotations `LocalDateValueMapValue` and `LocalDateTimeValueMapValue` have the same properties as ordinary `@ValueMapValue` to inject object with different name or in different structure path.
 
 ## Known issues of dependency not getting resolved
@@ -89,8 +99,7 @@ If your bundle can't resolve the dependency, there might be a issue that it's no
             <configuration>
                 <bnd><![CDATA[
 Import-Package: javax.annotation;version=0.0.0,*
-                com.juricamigac.aem.slingspecificannotations.*;0.0.1,*
-Export-Package: com.juricamigac.aem.slingspecificannotations.*;0.0.1,\
+Export-Package: com.juricamigac.slingspecificannotations.*;0.0.2,\
                     ]]></bnd>
             </configuration>
         </execution>

pom.xml

@@ -3,44 +3,35 @@
   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.sonatype.oss</groupId>
     <artifactId>oss-parent</artifactId>
     <version>7</version>
   </parent>
-
   <groupId>com.juricamigac</groupId>
   <artifactId>sling-specific-annotations</artifactId>
-  <version>0.0.1</version>
-
+  <version>0.0.2</version>
   <packaging>bundle</packaging>
-
   <name>Sling specific annotations</name>
-
   <distributionManagement>
     <repository>
       <id>github</id>
       <name>Sling specific annotations</name>
       <url>https://maven.pkg.github.com/jmigac/sling-specific-annotations</url>
     </repository>
   </distributionManagement>
-
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
-
     <license.year>2022</license.year>
     <project.build.by>Jurica Migač</project.build.by>
     <aem.sdk.version>2021.11.6058.20211123T163652Z-211000</aem.sdk.version>
     <project.package.id>slingspecificannotations</project.package.id>
     <bundle.name>${project.groupId} :: ${project.package.id}</bundle.name>
     <bundle.symbolicName>${project.groupId}.${project.package.id}</bundle.symbolicName>
     <bundle.namespace>${project.groupId}.${project.package.id}</bundle.namespace>
-
     <slf4j.version>1.7.7</slf4j.version>
-    <log4j.version>1.2.17</log4j.version>
-    
+    <log4j.version>1.2.16</log4j.version>
     <junit.version>4.11</junit.version>
     <mockito.version>1.9.5</mockito.version>
   </properties>
@@ -102,7 +93,7 @@
             <Bundle-SymbolicName>${bundle.symbolicName}</Bundle-SymbolicName>
             <Bundle-Version>${project.version}</Bundle-Version>
             <Embed-Dependency>*;scope=compile|runtime;type=!pom;inline=true</Embed-Dependency>
-            <Export-Package>${bundle.namespace}.*;${project.version}</Export-Package>
+            <Export-Package>${bundle.namespace}.*;version=${project.version}</Export-Package>
           </instructions>
         </configuration>
       </plugin>
@@ -190,25 +181,6 @@
       <artifactId>slf4j-log4j12</artifactId>
       <version>${slf4j.version}</version>
     </dependency>
-    <dependency>
-      <groupId>log4j</groupId>
-      <artifactId>log4j</artifactId>
-      <version>${log4j.version}</version>
-    </dependency>
-
-    <!-- test dependencies -->
-    <dependency>
-      <groupId>junit</groupId>
-      <artifactId>junit</artifactId>
-      <version>${junit.version}</version>
-      <scope>test</scope>
-    </dependency>
-    <dependency>
-      <groupId>org.mockito</groupId>
-      <artifactId>mockito-all</artifactId>
-      <version>${mockito.version}</version>
-      <scope>test</scope>
-    </dependency>
   </dependencies>
 
   <profiles>

src/main/java/com/juricamigac/slingspecificannotations/annotations/CurrentPage.java

@@ -0,0 +1,15 @@
+package com.juricamigac.slingspecificannotations.annotations;
+
+import org.apache.sling.models.annotations.Source;
+import org.apache.sling.models.spi.injectorspecific.InjectAnnotation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target(ElementType.FIELD)
+@Retention(RetentionPolicy.RUNTIME)
+@InjectAnnotation
+@Source("current-page-sling-specific-injection")
+public @interface CurrentPage {}

src/main/java/com/juricamigac/slingspecificannotations/annotations/PageTemplate.java

@@ -0,0 +1,15 @@
+package com.juricamigac.slingspecificannotations.annotations;
+
+import org.apache.sling.models.annotations.Source;
+import org.apache.sling.models.spi.injectorspecific.InjectAnnotation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target(ElementType.FIELD)
+@Retention(RetentionPolicy.RUNTIME)
+@InjectAnnotation
+@Source("page-template-sling-specific-injection")
+public @interface PageTemplate {}

src/main/java/com/juricamigac/slingspecificannotations/annotations/RequestParameter.java

@@ -0,0 +1,20 @@
+package com.juricamigac.slingspecificannotations.annotations;
+
+import org.apache.commons.lang3.StringUtils;
+import org.apache.sling.models.annotations.Source;
+import org.apache.sling.models.spi.injectorspecific.InjectAnnotation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target(ElementType.FIELD)
+@Retention(RetentionPolicy.RUNTIME)
+@InjectAnnotation
+@Source("request-parameter-sling-specific-injection")
+public @interface RequestParameter {
+
+    String name() default StringUtils.EMPTY;
+
+}

src/main/java/com/juricamigac/slingspecificannotations/constants/ServiceRankingConstants.java

@@ -0,0 +1,11 @@
+package com.juricamigac.slingspecificannotations.constants;
+
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
+
+@NoArgsConstructor(access = AccessLevel.PRIVATE)
+public class ServiceRankingConstants {
+
+    public static final int SLING_ANNOTATIONS_SERVICE_RANKING = 6500;
+
+}

src/main/java/com/juricamigac/slingspecificannotations/dataprocessor/CurrentPageProcessor.java

@@ -0,0 +1,69 @@
+package com.juricamigac.slingspecificannotations.dataprocessor;
+
+import com.day.cq.wcm.api.Page;
+import com.day.cq.wcm.api.PageManager;
+import com.day.cq.wcm.api.PageManagerFactory;
+import com.juricamigac.slingspecificannotations.annotations.CurrentPage;
+import com.juricamigac.slingspecificannotations.constants.ServiceRankingConstants;
+import com.juricamigac.slingspecificannotations.dataprocessor.annotationsprocessor.CurrentPageMetadataProviderAnnotationProcessor;
+import org.apache.sling.api.SlingHttpServletRequest;
+import org.apache.sling.api.resource.Resource;
+import org.apache.sling.models.spi.DisposalCallbackRegistry;
+import org.apache.sling.models.spi.Injector;
+import org.apache.sling.models.spi.injectorspecific.InjectAnnotationProcessor2;
+import org.apache.sling.models.spi.injectorspecific.StaticInjectAnnotationProcessorFactory;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Reference;
+
+import java.lang.reflect.AnnotatedElement;
+import java.lang.reflect.Type;
+
+import static org.osgi.framework.Constants.SERVICE_RANKING;
+
+@Component(
+        immediate = true,
+        service = {Injector.class, StaticInjectAnnotationProcessorFactory.class},
+        property = {SERVICE_RANKING + ":Integer=" + ServiceRankingConstants.SLING_ANNOTATIONS_SERVICE_RANKING})
+public class CurrentPageProcessor implements Injector, StaticInjectAnnotationProcessorFactory {
+
+    private static final String CURRENT_PAGE_SOURCE = "current-page-sling-specific-injection";
+
+    @Reference
+    private PageManagerFactory pageManagerFactory;
+
+    @Override
+    public String getName() {
+        return CURRENT_PAGE_SOURCE;
+    }
+
+    @Override
+    public Object getValue(Object adaptable, String fieldName, Type type, AnnotatedElement annotatedElement, DisposalCallbackRegistry disposalCallbackRegistry) {
+        if (adaptable instanceof Resource && this.isPage(type, annotatedElement)) {
+            final Resource resource = (Resource) adaptable;
+            return this.getPageFromAdaptable(resource);
+        } else if (adaptable instanceof SlingHttpServletRequest && this.isPage(type, annotatedElement)) {
+            final SlingHttpServletRequest request = (SlingHttpServletRequest) adaptable;
+            return this.getPageFromAdaptable(request.getResource());
+        }
+        return null;
+    }
+
+    private boolean isPage(final Type type, final AnnotatedElement annotatedElement) {
+        return type.equals(Page.class) && annotatedElement.isAnnotationPresent(CurrentPage.class);
+    }
+
+    @Override
+    public InjectAnnotationProcessor2 createAnnotationProcessor(AnnotatedElement annotatedElement) {
+        final CurrentPage annotation = annotatedElement.getAnnotation(CurrentPage.class);
+        if (annotation != null) {
+            return new CurrentPageMetadataProviderAnnotationProcessor();
+        }
+        return null;
+    }
+
+    private Page getPageFromAdaptable(final Resource resource) {
+        final PageManager pageManager = this.pageManagerFactory.getPageManager(resource.getResourceResolver());
+        return pageManager.getContainingPage(resource);
+    }
+
+}

src/main/java/com/juricamigac/slingspecificannotations/dataprocessor/LocalDateProcessor.java

@@ -1,5 +1,8 @@
 package com.juricamigac.slingspecificannotations.dataprocessor;
 
+import com.juricamigac.slingspecificannotations.annotations.LocalDateValueMapValue;
+import com.juricamigac.slingspecificannotations.constants.ServiceRankingConstants;
+import com.juricamigac.slingspecificannotations.dataprocessor.annotationsprocessor.RequestedDateMetadataProviderAnnotationProcessor;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.sling.api.SlingHttpServletRequest;
@@ -8,8 +11,6 @@
 import org.apache.sling.models.spi.Injector;
 import org.apache.sling.models.spi.injectorspecific.InjectAnnotationProcessor2;
 import org.apache.sling.models.spi.injectorspecific.StaticInjectAnnotationProcessorFactory;
-import com.juricamigac.slingspecificannotations.annotations.LocalDateValueMapValue;
-import com.juricamigac.slingspecificannotations.dataprocessor.annotationsprocessor.RequestedDateMetadataProviderAnnotationProcessor;
 import org.osgi.service.component.annotations.Component;
 
 import java.lang.reflect.AnnotatedElement;
@@ -24,8 +25,7 @@
 @Component(
         immediate = true,
         service = {Injector.class, StaticInjectAnnotationProcessorFactory.class},
-        property = {SERVICE_RANKING + ":Integer=7000"}
-)
+        property = {SERVICE_RANKING + ":Integer=" + ServiceRankingConstants.SLING_ANNOTATIONS_SERVICE_RANKING})
 public class LocalDateProcessor implements Injector, StaticInjectAnnotationProcessorFactory {
 
     private static final String INJECTION_NAME = "local-date-provider-injector";

src/main/java/com/juricamigac/slingspecificannotations/dataprocessor/LocalDateTimeProcessor.java

@@ -1,5 +1,8 @@
 package com.juricamigac.slingspecificannotations.dataprocessor;
 
+import com.juricamigac.slingspecificannotations.annotations.LocalDateTimeValueMapValue;
+import com.juricamigac.slingspecificannotations.constants.ServiceRankingConstants;
+import com.juricamigac.slingspecificannotations.dataprocessor.annotationsprocessor.RequestedDateTimeMetadataProviderAnnotationProcessor;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.sling.api.SlingHttpServletRequest;
@@ -8,20 +11,21 @@
 import org.apache.sling.models.spi.Injector;
 import org.apache.sling.models.spi.injectorspecific.InjectAnnotationProcessor2;
 import org.apache.sling.models.spi.injectorspecific.StaticInjectAnnotationProcessorFactory;
-import com.juricamigac.slingspecificannotations.annotations.LocalDateTimeValueMapValue;
-import com.juricamigac.slingspecificannotations.dataprocessor.annotationsprocessor.RequestedDateTimeMetadataProviderAnnotationProcessor;
 import org.osgi.service.component.annotations.Component;
-import org.osgi.service.component.propertytypes.ServiceRanking;
 
 import java.lang.reflect.AnnotatedElement;
 import java.lang.reflect.Type;
 import java.time.LocalDateTime;
 import java.time.ZoneId;
 import java.util.Date;
 
+import static org.osgi.framework.Constants.SERVICE_RANKING;
+
 @Slf4j
-@Component(immediate = true, service = { Injector.class, StaticInjectAnnotationProcessorFactory.class })
-@ServiceRanking(LocalDateTimeProcessor.SERVICE_RANKING)
+@Component(
+        immediate = true,
+        service = {Injector.class, StaticInjectAnnotationProcessorFactory.class},
+        property = {SERVICE_RANKING + ":Integer=" + ServiceRankingConstants.SLING_ANNOTATIONS_SERVICE_RANKING})
 public class LocalDateTimeProcessor implements Injector, StaticInjectAnnotationProcessorFactory {
 
     protected static final int SERVICE_RANKING = Integer.MAX_VALUE;

src/main/java/com/juricamigac/slingspecificannotations/dataprocessor/PageTemplateProcessor.java

@@ -0,0 +1,71 @@
+package com.juricamigac.slingspecificannotations.dataprocessor;
+
+import com.day.cq.wcm.api.Page;
+import com.day.cq.wcm.api.PageManager;
+import com.day.cq.wcm.api.PageManagerFactory;
+import com.day.cq.wcm.api.Template;
+import com.juricamigac.slingspecificannotations.annotations.PageTemplate;
+import com.juricamigac.slingspecificannotations.constants.ServiceRankingConstants;
+import com.juricamigac.slingspecificannotations.dataprocessor.annotationsprocessor.PageTemplateMetadataProviderAnnotationProcessor;
+import org.apache.sling.api.SlingHttpServletRequest;
+import org.apache.sling.api.resource.Resource;
+import org.apache.sling.models.spi.DisposalCallbackRegistry;
+import org.apache.sling.models.spi.Injector;
+import org.apache.sling.models.spi.injectorspecific.InjectAnnotationProcessor2;
+import org.apache.sling.models.spi.injectorspecific.StaticInjectAnnotationProcessorFactory;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Reference;
+
+import java.lang.reflect.AnnotatedElement;
+import java.lang.reflect.Type;
+
+import static org.osgi.framework.Constants.SERVICE_RANKING;
+
+@Component(
+        immediate = true,
+        service = {Injector.class, StaticInjectAnnotationProcessorFactory.class},
+        property = {SERVICE_RANKING + ":Integer=" + ServiceRankingConstants.SLING_ANNOTATIONS_SERVICE_RANKING})
+public class PageTemplateProcessor implements Injector, StaticInjectAnnotationProcessorFactory {
+
+    private static final String PAGE_TEMPLATE_ANNOTATION_SOURCE = "page-template-sling-specific-injection";
+
+    @Reference
+    private PageManagerFactory pageManagerFactory;
+
+    @Override
+    public String getName() {
+        return PAGE_TEMPLATE_ANNOTATION_SOURCE;
+    }
+
+    @Override
+    public Object getValue(Object adaptable, String fieldName, Type type, AnnotatedElement annotatedElement, DisposalCallbackRegistry disposalCallbackRegistry) {
+        if (adaptable instanceof Resource && this.isTemplate(type, annotatedElement)) {
+            final Resource resource = (Resource) adaptable;
+            return this.getPageTemplateFromResource(resource);
+        } else if (adaptable instanceof SlingHttpServletRequest && this.isTemplate(type, annotatedElement)) {
+            final SlingHttpServletRequest request = (SlingHttpServletRequest) adaptable;
+            return this.getPageTemplateFromResource(request.getResource());
+        }
+        return null;
+    }
+
+    private boolean isTemplate(final Type type, final AnnotatedElement annotatedElement) {
+        return type.equals(Template.class) && annotatedElement.isAnnotationPresent(PageTemplate.class);
+    }
+
+    @Override
+    public InjectAnnotationProcessor2 createAnnotationProcessor(AnnotatedElement annotatedElement) {
+        final PageTemplate annotation = annotatedElement.getAnnotation(PageTemplate.class);
+        if (annotation != null) {
+            return new PageTemplateMetadataProviderAnnotationProcessor();
+        }
+        return null;
+    }
+
+    private Template getPageTemplateFromResource(final Resource resource) {
+        final PageManager pageManager = this.pageManagerFactory.getPageManager(resource.getResourceResolver());
+        final Page page = pageManager.getContainingPage(resource);
+        return page.getTemplate();
+    }
+
+}