Feature/injector extensions - part 2 - last

CHANGELOG.md

@@ -15,6 +15,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com)
 - #1637 - Add support for bounce address setting in EmailService
 - #1654 - Added I18nProvider service to support injectors
 - #1648 - Add Smart Tags to XMP Metadata Node Workflow Process
+- #1670 - Added @JsonValueMapValue, @I18N, @HierarchicalPageProperty, and improved @AemObject and @SharedValueMapValue.
 
 ### Fixed
 - #1667 - Refactored the activate methods of all http cache services

bundle/src/main/java/com/adobe/acs/commons/models/injectors/annotation/AemObject.java

@@ -64,13 +64,17 @@
 @Source(AemObject.SOURCE)
 public @interface AemObject {
 
+    /**
+     * Source value used for this annotation.
+     * @see Source
+     */
     String SOURCE = "define-objects";
     /**
      * if set to REQUIRED injection is mandatory, if set to OPTIONAL injection is optional, in case of DEFAULT
      * the standard annotations ({@link org.apache.sling.models.annotations.Optional}, {@link org.apache.sling.models.annotations.Required}) are used.
      * If even those are not available the default injection strategy defined on the {@link org.apache.sling.models.annotations.Model} applies.
      * Default value = DEFAULT.
      */
-    public InjectionStrategy injectionStrategy() default InjectionStrategy.DEFAULT;
+    InjectionStrategy injectionStrategy() default InjectionStrategy.DEFAULT;
 
 }

bundle/src/main/java/com/adobe/acs/commons/models/injectors/annotation/HierarchicalPageProperty.java

@@ -44,6 +44,10 @@
 @Source(HierarchicalPageProperty.SOURCE)
 public @interface HierarchicalPageProperty {
 
+    /**
+     * Source value used for this annotation.
+     * @see Source
+     */
     String SOURCE = "hierarchical-page-property";
 
     /**

bundle/src/main/java/com/adobe/acs/commons/models/injectors/annotation/I18N.java

@@ -42,6 +42,10 @@
 @Source(I18N.SOURCE)
 public @interface I18N {
 
+    /**
+     * Source value used for this annotation.
+     * @see Source
+     */
     String SOURCE = "i18n";
 
     /**

bundle/src/main/java/com/adobe/acs/commons/models/injectors/annotation/JsonValueMapValue.java

@@ -43,6 +43,10 @@
 @Source(JsonValueMapValue.SOURCE)
 public @interface JsonValueMapValue {
 
+    /**
+     * Source value used for this annotation.
+     * @see Source
+     */
     String SOURCE = "json-valuemap-value";
 
     /**

bundle/src/main/java/com/adobe/acs/commons/models/injectors/annotation/SharedValueMapValue.java

@@ -20,6 +20,7 @@
 package com.adobe.acs.commons.models.injectors.annotation;
 
 import com.adobe.acs.commons.wcm.properties.shared.SharedComponentProperties;
+import org.apache.commons.lang3.StringUtils;
 import org.apache.sling.models.annotations.Source;
 import org.apache.sling.models.annotations.injectorspecific.InjectionStrategy;
 import org.apache.sling.models.spi.injectorspecific.InjectAnnotation;
@@ -38,11 +39,18 @@
 @Target({ METHOD, FIELD, PARAMETER })
 @Retention(RUNTIME)
 @InjectAnnotation
-@Source("shared-component-properties-valuemap")
+@Source(SharedValueMapValue.SOURCE)
 public @interface SharedValueMapValue {
-    String name() default "";
 
-    public InjectionStrategy injectionStrategy() default InjectionStrategy.DEFAULT;
+    /**
+     * Source value used for this annotation.
+     * @see Source
+     */
+    String SOURCE = "shared-component-properties-valuemap";
 
-    public SharedComponentProperties.ValueTypes type() default SharedComponentProperties.ValueTypes.MERGED;
+    String name() default StringUtils.EMPTY;
+
+    InjectionStrategy injectionStrategy() default InjectionStrategy.DEFAULT;
+
+    SharedComponentProperties.ValueTypes type() default SharedComponentProperties.ValueTypes.MERGED;
 }

bundle/src/main/java/com/adobe/acs/commons/models/injectors/impl/AemObjectInjector.java

@@ -91,9 +91,6 @@
  */
 public final class AemObjectInjector implements Injector {
 
-    @Reference
-    private I18nProvider i18nProvider;
-
     @Reference
     private XSSAPI genericXxsApi;
 
@@ -175,7 +172,6 @@ private enum ObjectType {
         RESOURCE_DESIGN,
         CURRENT_STYLE,
         SESSION,
-        I18N,
         XSS_API;
 
         private static final String RESOURCE_PAGE_STRING = "resourcePage";
@@ -201,8 +197,6 @@ public static ObjectType fromClassAndName(Class<?> classOrGenericParam, String n
                 return ObjectType.CURRENT_STYLE;
             } else if (classOrGenericParam.isAssignableFrom(Session.class)) {
                 return ObjectType.SESSION;
-            } else if (classOrGenericParam.isAssignableFrom(I18n.class)) {
-                return ObjectType.I18N;
             } else if (classOrGenericParam.isAssignableFrom(XSSAPI.class)) {
                 return ObjectType.XSS_API;
             }

bundle/src/main/java/com/adobe/acs/commons/models/injectors/impl/SharedValueMapValueInjector.java

@@ -19,17 +19,12 @@
  */
 package com.adobe.acs.commons.models.injectors.impl;
 
-import java.lang.reflect.AnnotatedElement;
-import java.lang.reflect.Array;
-import java.lang.reflect.ParameterizedType;
-import java.lang.reflect.Type;
-import java.util.Arrays;
-import java.util.Collection;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-
-import org.apache.sling.api.SlingHttpServletRequest;
+import com.adobe.acs.commons.models.injectors.annotation.SharedValueMapValue;
+import com.adobe.acs.commons.util.impl.ReflectionUtil;
+import com.adobe.acs.commons.wcm.PageRootProvider;
+import com.adobe.acs.commons.wcm.properties.shared.SharedComponentProperties;
+import com.day.cq.commons.jcr.JcrConstants;
+import com.day.cq.wcm.api.Page;
 import org.apache.sling.api.resource.Resource;
 import org.apache.sling.api.resource.ValueMap;
 import org.apache.sling.api.wrappers.ValueMapDecorator;
@@ -39,11 +34,12 @@
 import org.osgi.service.component.annotations.Component;
 import org.osgi.service.component.annotations.Reference;
 
-import com.adobe.acs.commons.models.injectors.annotation.SharedValueMapValue;
-import com.adobe.acs.commons.wcm.PageRootProvider;
-import com.adobe.acs.commons.wcm.properties.shared.SharedComponentProperties;
-import com.day.cq.commons.jcr.JcrConstants;
-import com.day.cq.wcm.api.Page;
+import java.lang.reflect.AnnotatedElement;
+import java.lang.reflect.Type;
+import java.util.HashMap;
+import java.util.Map;
+
+import static com.adobe.acs.commons.models.injectors.impl.InjectorUtils.getResource;
 
 @Component(service=Injector.class, property= {Constants.SERVICE_RANKING +":Integer=4500"})
 public class SharedValueMapValueInjector implements Injector {
@@ -53,7 +49,7 @@ public class SharedValueMapValueInjector implements Injector {
 
     @Override
     public String getName() {
-        return "shared-component-properties-valuemap";
+        return SharedValueMapValue.SOURCE;
     }
 
     @Override
@@ -63,17 +59,7 @@ public Object getValue(Object adaptable, String name, Type declaredType, Annotat
             return null;
         }
 
-        // sanity check
-        if (!(adaptable instanceof Resource || adaptable instanceof SlingHttpServletRequest)) {
-            return null;
-        }
-
-        Resource resource = null;
-        if (adaptable instanceof SlingHttpServletRequest) {
-            resource = ((SlingHttpServletRequest) adaptable).getResource();
-        } else if (adaptable instanceof Resource) {
-            resource = (Resource) adaptable;
-        }
+        Resource resource = getResource(adaptable);
 
         if (resource != null) {
             Page pageRoot = pageRootProvider.getRootPage(resource);
@@ -93,7 +79,7 @@ public Object getValue(Object adaptable, String name, Type declaredType, Annotat
                         break;
                 }
                 if (valueMap != null) {
-                    return getValueMapValue(valueMap, name, declaredType);
+                    return ReflectionUtil.convertValueMapValue(valueMap, name, declaredType);
                 }
             }
         }
@@ -132,28 +118,4 @@ protected ValueMap getMergedProperties(Page pageRoot, Resource resource) {
         return new ValueMapDecorator(mergedProperties);
     }
 
-    /**
-     * Get the property value from the value map.
-     *
-     * This function has special logic to handle parameterized types
-     * such as List<?> which can be addapted to from array properties.
-     */
-    protected Object getValueMapValue(ValueMap valueMap, String name, Type type) {
-        if (type instanceof Class) {
-            return valueMap.get(name, (Class) type);
-        } else if (type instanceof ParameterizedType) {
-            ParameterizedType parameterizedType = (ParameterizedType) type;
-            if (parameterizedType.getActualTypeArguments().length == 1) {
-                Class collectionType = (Class) parameterizedType.getRawType();
-                if (collectionType.equals(Collection.class) || collectionType.equals(List.class)) {
-                    Class itemType = (Class) parameterizedType.getActualTypeArguments()[0];
-                    Object valuesArray = valueMap.get(name, Array.newInstance(itemType, 0).getClass());
-                    if (valuesArray != null) {
-                        return Arrays.asList((Object[]) valuesArray);
-                    }
-                }
-            }
-        }
-        return null;
-    }
 }

bundle/src/test/java/com/adobe/acs/commons/models/injectors/impl/SharedValueMapValueInjectorTest.java

@@ -20,6 +20,7 @@
 package com.adobe.acs.commons.models.injectors.impl;
 
 import com.adobe.acs.commons.models.injectors.annotation.impl.SharedValueMapValueAnnotationProcessorFactory;
+import com.adobe.acs.commons.models.injectors.impl.model.impl.SharedValueMapValueTestModel;
 import com.adobe.acs.commons.wcm.impl.PageRootProviderConfig;
 import com.adobe.acs.commons.wcm.impl.PageRootProviderMultiImpl;
 import com.adobe.acs.commons.wcm.properties.shared.SharedComponentProperties;
@@ -38,7 +39,6 @@
 import javax.jcr.Node;
 import javax.jcr.RepositoryException;
 import javax.jcr.Session;
-
 import java.util.Arrays;
 import java.util.Collections;
 

bundle/src/test/java/com/adobe/acs/commons/models/injectors/impl/SharedValueMapValueTestModel.java → bundle/src/test/java/com/adobe/acs/commons/models/injectors/impl/model/impl/SharedValueMapValueTestModel.java

@@ -17,9 +17,10 @@
  * limitations under the License.
  * #L%
  */
-package com.adobe.acs.commons.models.injectors.impl;
+package com.adobe.acs.commons.models.injectors.impl.model.impl;
 
 import com.adobe.acs.commons.models.injectors.annotation.SharedValueMapValue;
+import com.adobe.acs.commons.models.injectors.impl.SharedValueMapValueInjectorTest;
 import com.adobe.acs.commons.wcm.PageRootProvider;
 import com.adobe.acs.commons.wcm.properties.shared.SharedComponentProperties;
 import org.apache.sling.api.SlingHttpServletRequest;
@@ -181,4 +182,4 @@ public List<Long> getLongListPropFromNonArray() {
         return longListPropFromNonArray;
     }
 
-}
+}