Understanding the AEM Code Snippet

1. request.getResourceResolver().adaptTo(PageManager.class):

request.getResourceResolver(): This fetches a ResourceResolver from the servlet’s request. A ResourceResolver in AEM assists in translating resource paths to actual resources.

.adaptTo(PageManager.class): This method tries to adapt or convert the ResourceResolver into another type, specifically a PageManager. The PageManager in AEM offers utilities for working with pages, such as fetching, creating, or deleting pages.

2. Optional.ofNullable(…)

This wraps the value returned by the preceding code (which might be a PageManager object or null if the adaptation failed) within an Optional object. Optional is a container that may or may not contain a value.

3. .map(pm -> pm.getContainingPage(request.getResource()))

If the Optional contains a non-null PageManager value, the .map method applies the given function to it. Here, it uses the PageManager (denoted as pm in the lambda) to retrieve the containing page of the present resource.

pm.getContainingPage(request.getResource()): This extracts the AEM Page that encompasses the current resource.

4. .orElse(null)

Lastly, if any prior steps don’t succeed (i.e., if the adaptation to PageManager was unsuccessful or if no containing page for the resource exists), the orElse method ensures currentPage is set to null.

The post Retrieving the Current Page in an AEM Servlet via ResourceType appeared first on Sourced Code.

In this article we will talk through how to access the design dialogue settings that is configured in editable template policies within Sling Models. This article will be a quick reference, which means we will provide you code examples for the solution.

1. Example _cq_design_dialog.xml configuration

This is a snippet that resides in /apps/core/wcm/components/title/v1/title/_cq_design_dialog.xml

2. Accessing Design Dialog Properties in Sling Models:

In AEM, Sling Models provide a way to map resource properties to Java objects, making it easier to work with the content of a page. To access Design Dialog properties within a Sling Model, take a look at the example code below.

Take notice, in line:17, we are using Sling Model Specific Annotations, @ScriptVariable, to initiate the currentStyle object. In line:22, we are calling the get method() which is a public method, which here we will attempt to find configuration set via design dialog “renderLayoutAs”. If “renderLayoutAs” is not configured, then String renderLayoutAs == null. Finally in line:24, we will use a switch statement to execute code based on what is configured.

The post How to access Design Dialogue Properties in Sling Model appeared first on Sourced Code.

Why is the aria-label for the AEM Core Text Component not rendering as expected?
For rendering links that contain the “aria-label” attribute, AEM refers to AEM’s XSS (Cross-Site Scripting) protection. This protection mechanism, exclusive to AEM, effectively prevents attackers from injecting malicious code into web pages that are viewed by other users. AEM’s XSS protection is built upon the trusted AntiSamy Java library, which is provided by OWASP (Open Web Application Security Project).

During the rendering process in AEM, if certain tags are not included in the whitelist, they will be stripped off. This means that any tags not explicitly permitted by the XSS protection configuration will be removed when the web pages are rendered. By enforcing this restriction, AEM ensures that only authorized and safe tags are displayed, significantly reducing the potential risk of XSS vulnerabilities.

In this article, we will configure AEM to allow the “aria-label” HTML attribute, so your text component’s links are rendering as expected. This article does not provide the JavaScript solution for how to add capabilities to the AEM Core Text Component for the “aria-label” HTML attribute.

Developer steps to enable and allow the AEM Core Text Component to render “aria-label” on the page.

1. Login to AEM
2. Visit http://localhost:4502/crx/de/index.jsp#/libs/cq/xssprotection/config.xml
3. Overlay the XSS protection configuration by copying /libs/cq/xssprotection into /apps/cq/xssprotection (and all it’s children)
4. Delete the /apps/cq/xssprotection/rep:policy
5. From crx/DE you can edit the file /apps/cq/xssprotection/config.xml
6. On your keyboard, hit “ctrl + f” to find <tag name=”a” action=”validate”>
7. This is an XML file, so find the end of the closing tag </tag>
8. Insert this line of code:

   1 2 3 4 5

   <attribute name="aria-label">     <regexp-list>         <regexp name="anything"/>     </regexp-list>  </attribute>

   

9. Done
10. Now test out the Text Component, and expect the aria-labels to render as expected!
11. Next, you would want to copy the /apps/cq/xssprotection into your code base, so you can deploy the xss configuration into difference environments of AEM automatically.

The post AEM Rich Text Editor rendering aria-labels appeared first on Sourced Code.

1. Find all Content Fragments with Content Fragment Model

http://localhost:4502/libs/cq/search/content/querydebug.html?_charset_=UTF-8&query=type%3Ddam%3AAsset%0D%0Apath%3D%2Fcontent%2Fdam%0D%0Aboolproperty%3Djcr%3Acontent%2FcontentFragment%0D%0Aboolproperty.value%3Dtrue%0D%0Aproperty%3Djcr%3Acontent%2Fdata%2Fcq%3Amodel%0D%0Aproperty.value%3D%2Fconf%2Fsourcedcode%2Fsettings%2Fdam%2Fcfm%2Fmodels%2Fmodel1

2. Find all Content Fragments with Content Fragment Model & Property

http://localhost:4502/libs/cq/search/content/querydebug.html?_charset_=UTF-8&query=path%3D%2Fcontent%2Fdam%2Fsourcedcode%0D%0Aboolproperty%3Djcr%3Acontent%2FcontentFragment%0D%0Aboolproperty.value%3Dtrue%0D%0A1_property%3Djcr%3Acontent%2Fdata%2Fcq%3Amodel%0D%0A1_property_1.value%3D%2Fconf%2Fsourcedcode%2Fsettings%2Fdam%2Fcfm%2Fmodels%2Fmodel1%0D%0A2_property%3Djcr%3Acontent%2Fdata%2Fmaster%2Ftitle%0D%0A2_property.value%3Dexample

4. Find all Content Fragments with Content Fragment Model & Full Text Search

http://localhost:4502/libs/cq/search/content/querydebug.html?_charset_=UTF-8&facets=on&query=type%3Ddam%3AAsset%0D%0Apath%3D%2Fcontent%2Fdam%0D%0Aboolproperty%3Djcr%3Acontent%2FcontentFragment%0D%0Aboolproperty.value%3Dtrue%0D%0Aproperty%3Djcr%3Acontent%2Fdata%2Fcq%3Amodel%0D%0Aproperty.value%3D%2Fconf%2Fwknd-shared%2Fsettings%2Fdam%2Fcfm%2Fmodels%2Fadventure%0D%0Afulltext%3Da%0D%0Afulltext.relPath%3Djcr%3Acontent%2Fdata%2Fmaster%0D%0A

4. Find all Content Fragments & Full Text Search

http://localhost:4502/libs/cq/search/content/querydebug.html?_charset_=UTF-8&facets=on&query=type%3Ddam%3AAsset%0D%0Apath%3D%2Fcontent%2Fdam%2Fsourcedcode%0D%0Aboolproperty%3Djcr%3Acontent%2FcontentFragment%0D%0Aboolproperty.value%3Dtrue%0D%0Aproperty%3Djcr%3Acontent%2Fdata%2Fcq%3Amodel%0D%0Aproperty.value%3D%2Fconf%2Fsourcedcode%2Fsettings%2Fdam%2Fcfm%2Fmodels%2Fmodel1%0D%0Afulltext%3Dfull+text

The post AEM Query Builder Examples with Content Fragments appeared first on Sourced Code.

Example of Servlet Being Called

Test: When I call http://localhost:4502/bin/example, I expect to see a JSON response with application/JSON, 200 OK, and response body = { “property1”: “value1” }. The example shows that the tests are passing.

The post @SlingServletPaths Example Code in AEM appeared first on Sourced Code.

Jump to Code Snippet

Granite UI (Touch UI) Rendered as

This is a screenshot of how a very basic Touch UI would look like for author’s when the author double clicks on the component to make change’s to it.

Jump to Code Snippet

Code Snippet

The solution below includes an example with the “styletab” which is an out-of-the-box feature for the AEM Style System. You can copy and paste this snippet into your .content.xml, like _cq_dialog/.content.xml:

Extras

If you would like to enable your component for the AEM Style System, click here, How to Enable AEM Style System Configuration for Components.

The post AEM Touch UI (Granite UI) Tabs: Example Code appeared first on Sourced Code.

Sightly HTL

Sling Model Class : LinkResolve.class

The post How to Pass Data Parameters to Sling Modal from Sightly HTL Component appeared first on Sourced Code.

In this article, we will go through the 3 different ways in how we can retrieve inherited page properties.

1. How does this work?
2. inheritedPageProperties with Sightly
3. inheritedPageProperties with JSP
4. inheritedPageProperties with OSGI Bundle, Java Backend

How does this work?

An InheritanceValueMap for a given Resource that will inherit values from ancestral pages.
For example, given: /content/parent/page/jcr:content/footer/image/@width, the HierarchyNodeInheritanceValueMap will search for a footer/image/@width property in:

look up one: /content/parent/currentPage/jcr:content/footer/image/@width
look up two: /content/parent/jcr:content/footer/image/@width
look up three: /content/jcr:content/footer/image/@width

1. inheritedPageProperties with Sightly

Sightly offers a plethora of AEM Global objects, and one of them notably is the “inheritedPageProperties”. Utilising the inheritedPageProperties global object, we can use dot or square bracket notation to access the interited page property value.

2. inheritedPageProperties with JSP

Utilising the JSP include, /libs/foundation/global.jsp (purpose of retreiving the currentPage AEM global object), we can make use of the HierarchyNodeInheritanceValueMap.class, and currentPage resource to initialise the InheritanceValueMap.class object. Next, calling the method getInherited(String name, Class<T> type), we are able to get the inherited page property.

3. inheritedPageProperties with OSGI Bundle, Java Backend

Similar to the JSP implementation above, we can make use of the HierarchyNodeInheritanceValueMap.class, and currentPage resource to initialise the InheritanceValueMap.class object. Next, calling the method getInherited(String name, Class<T> type), we are able to get the inherited page property.

The post AEM inheritedpageproperties with Sightly, JSP, OSGI Bundle appeared first on Sourced Code.

These are the common questions we have when we are trying to figure out the number of use and the node-paths of the targeted searched component within the Java content repository, known as “JCR”. In this article, you will discover one of the quickest techniques used to retrieve the total number of uses and node-paths of a component within the JCR by using the Query Builder API, query debugger tool.

If you don’t have certain user priveledges within your AEM instance, there’s another way to find out the usage of your component(s), Components Console; however, the Components Console is restricted in a sense where the component search results-list only display pages of a given component and does not provide a total number of how many pages are returned from the search.

1. Component Search by the Query Builder API, Query Builder Debugger Tool

The AEM Query Builder is an API which can be used to search for nodes in JCR. Well defined “Predicates” are typically created from using the Query Builder Debugging Tool, as this tool serves instant search results within the UI.

Step 1: With your running AEM instance, visit http://localhost:4502/libs/cq/search/content/querydebug.html.

Step 2: Paste in the search query below & hit search; view screenshot.
Replace with your component’s path: weretail/components/content/heroimage
Note!: sometimes the descendant path must be more nested, so /content/we-retail/gb/en

This query searches for all types of nodes with the sling:resourceType equals to the value, weretail/components/content/heroimage, and where the path is descendant from /content/we-retail; to learn more about the Query builder API and queries, click here (Adobe Documentation)

Step 3: Review the results.

2. Component Search by the Components Console

This out of the box Components Console, CC, is available from AEM 6.2+ right under Tools -> General -> Components. The CC displays search results in a form of pages where the component is being used; rather than each node from the example above. This console is accessible to authors so that even they can check for which pages use the searched component.

Step 1: Within your running AEM instance, visit http://localhost:4502/libs/wcm/core/content/sites/components.html.

Step 2: Search for a component. Insert your search criteria with either by “keyword”, “component path”, or “component group”. On every change of the search criteria, you should see results in a list format on the right hand side of the search left side bar.
Step 3: Click on the targeted component, and you will be redirected to the details page.
Step 4: From the details page, click on “live usage”, and a results-list of pages will be displayed, where the targeted component can be found.
Step 5: From the results-list, clicking on a link will open the page’s editor.

Components Console – Steps 2 & 3

Components Console – Steps 4 & 5

The post How many times is an AEM Component used in the JCR? appeared first on Sourced Code.

The @AttributeDefinition defines the supporting configuration for a given OSGI component’s configuration. It allows you to set data types and default values for each given configuration. When an admin user interacts with the Felix console, how the @AttributeDefinition is defined will determine the look and feel of each of the input fields are presented.

@AttributeDefinition Essential Parameters Explained

As we know, the most basic way to define a configuration will be to utilise the annotation @AttributeDefinition. Let’s explore the essential configurations.

The @AttributeDefinition annotation accepts parameters as such:

• line 2: name: defines the human read-able label
• line 3: description: description for the attribute configuration.
• line 4: type: definition of the attribute’s data type.
•           line 6: <T>: definition of the attribute’s data type
•           line 6: name_of_conf_reference: configuration’s reference id : name.of.conf.reference
•           line 7: <T>[]: multifield (multi data set) is supported.

  1 2 3 4 5 6 7

  @AttributeDefinition( name="" description="" type="" } name_of_conf_reference() default ""; // [] name_of_conf_reference_list() default "";

  Explained:
  Illustrating how the label, description, and the configuration reference shows up on the OSGI Apache Felix console.
  

  ---

  Attribute Types

  With the understanding of how the @AttributeDefinition Essential Parameters are used, we can go ahead to utilise and to familiarize ourselves with the supported essential data attribute types; most of the basic attributes are covered below:

  1. String Attribute Type
  2. String[] Attribute Type
  3. Long Attribute Type
  4. int Attribute Type
  5. Short Attribute Type
  6. Char Attribute Type
  7. byte Attribute Type
  8. Float Attribute Type
  9. Double Attribute Type
  10. Boolean Attribute Type
  11. Password Attribute Type
  12. Options Attribute Type

   

  1. String Attribute Type

  1 2 3 4 5

  @AttributeDefinition( name = "String Label", description = "String Config Example Description", type = AttributeType.STRING) String config_string_example() default "Default String";

  2. String[] Attribute Type

  1 2 3 4 5

  @AttributeDefinition( name = "String[] Label", description = "String[] Config Example Description", type = AttributeType.STRING) String[] config_string_array_example() default {"item1", "item2"};

  Explained:
  Illustrating how the multi-fields shows up on the OSGI Felix console.
  
  Note:
  Configuration can be set as multifield can be enabled without much effort, simply change the attribute type to an list type, shown in the #2. String[] Attribute Type example.

  ---

  3. Long Attribute Type

  1 2 3 4 5

  @AttributeDefinition( name = "Long Label", description = "Long Config Example Description", type = AttributeType.LONG) long config_long_example() default 0L;

  4. int Attribute Type

  1 2 3 4 5

  @AttributeDefinition( name = "int Label", description = "innt Config Example Description", type = AttributeType.INTEGER) int config_number_example() default 0;

  5. Short Attribute Type

  1 2 3 4 5

  @AttributeDefinition( name = "Short Label", description = "Short Config Example Description", type = AttributeType.SHORT) short config_short_example() default 0;

  6. Char Attribute Type

  1 2 3 4 5

  @AttributeDefinition( name = "Char Label", description = "Char Config Example Description", type = AttributeType.CHARACTER) char config_char_example() default 0;

  7. Byte Attribute Type

  1 2 3 4 5

  @AttributeDefinition( name = "Byte Label", description = "Byte Config Example Description", type = AttributeType.BYTE) byte config_byte_example() default 0;

  See Code Examples!
  Click here to view OSGI R6 Configuration Code Examples.

  8. Double Attribute Type

  1 2 3 4 5

  @AttributeDefinition( name = "Double Label", description = "Double Config Example Description", type = AttributeType.DOUBLE) double config_double_example() default 0;

  9. Float Attribute Type

  1 2 3 4 5

  @AttributeDefinition( name = "Float Label", description = "Float Config Example Description", type = AttributeType.FLOAT) float config_float_example() default 0;

  10. Boolean Attribute Type

  1 2 3 4 5

  @AttributeDefinition( name = "Boolean Label", description = "Boolean Config Example Description", type = AttributeType.BOOLEAN) boolean config_boolean_example() default true;

  11. Password Attribute Type

  1 2 3 4 5

  @AttributeDefinition( name = "Password Label", description = "Password Config Example Description", type = AttributeType.PASSWORD) String config_password_config_example() default "";

  12. Options Attribute Type

  1 2 3 4 5 6 7 8 9 10 11 12

  @AttributeDefinition( name = "Dropdown Label", description = "Dropdown Config Example Description", options = { @Option(label = "PRODUCTION", value = "PRODUCTION"), @Option(label = "STAGING", value = "STAGING"), @Option(label = "UAT", value = "UAT"), @Option(label = "QA", value = "QA"), @Option(label = "DEVELOP", value = "DEVELOP") } ) String config_dropdown_example() default "DEVELOP";

  ---

  See Code Examples!
  Click here to view OSGI R6 Configuration Code Examples.

The post OSGI R6 Configuration @AttributeDefinition Essentials Reference Guide appeared first on Sourced Code.

The post Articles List View appeared first on Sourced Code.

References:

1. Checkbox
2. Text Field
3. Text Area
4. Path Field
5. Multifield
6. Select
7. Radio Group
8. Number Field
9. File Upload
10. Color Picker
11. Creating a Basic AEM Touch UI Dialogue

1. Checkbox Granite UI 1.0, Touch UI XML Example:

sling:resourceType: granite/ui/components/coral/foundation/form/checkbox
Documetation: https://helpx.adobe.com/experience-manager/6-5/sites/developing/using/reference-materials/granite-ui/api/jcr_root/libs/granite/ui/components/coral/foundation/form/checkbox/index.html

2. Text Field Granite UI 1.0, Touch UI XML Example:

sling:resourceType: granite/ui/components/coral/foundation/form/textfield
Documentation: https://developer.adobe.com/experience-manager/reference-materials/6-5/granite-ui/api/jcr_root/libs/granite/ui/components/coral/foundation/form/textfield/index.html

3. Text Area Granite UI 1.0, Touch UI XML Example:

sling:resourceType: granite/ui/components/coral/foundation/form/textarea
Documentation: https://developer.adobe.com/experience-manager/reference-materials/6-5/granite-ui/api/jcr_root/libs/granite/ui/components/coral/foundation/form/textarea/index.html

4. Path Field Granite UI 1.0, Touch UI XML Example:

sling:resourceType: granite/ui/components/coral/foundation/form/pathfield
Documentation: https://developer.adobe.com/experience-manager/reference-materials/6-5/granite-ui/api/jcr_root/libs/granite/ui/components/coral/foundation/form/pathfield/index.html

5. Multifield Granite UI 1.0, Touch UI XML Example:

sling:resourceType: granite/ui/components/coral/foundation/form/multifield
Documentation: https://developer.adobe.com/experience-manager/reference-materials/6-5/granite-ui/api/jcr_root/libs/granite/ui/components/coral/foundation/form/multifield/index.html

6. Select Granite UI 1.0, Touch UI XML Example:

sling:resourceType: granite/ui/components/coral/foundation/form/select
Documentation: https://developer.adobe.com/experience-manager/reference-materials/6-5/granite-ui/api/jcr_root/libs/granite/ui/components/coral/foundation/form/select/index.html

7. Radio Group Granite UI 1.0, Touch UI XML Example:

sling:resourceType: granite/ui/components/coral/foundation/form/radiogroup
Documentation: https://developer.adobe.com/experience-manager/reference-materials/6-5/granite-ui/api/jcr_root/libs/granite/ui/components/coral/foundation/form/radiogroup/index.html

8. Number Field Granite UI 1.0, Touch UI XML Example:

sling:resourceType: granite/ui/components/coral/foundation/form/numberfield
Documentation: https://developer.adobe.com/experience-manager/reference-materials/6-5/granite-ui/api/jcr_root/libs/granite/ui/components/coral/foundation/form/numberfield/index.html

9. File Upload Granite UI 1.0, Touch UI XML Example:

Note: How to disable the file upload, browser button, granite UI component’s upload feature will be to set the allowUpload property to false, indicated in the examples below.

sling:resourceType: cq/gui/components/authoring/dialog/fileupload
Documentation: https://developer.adobe.com/experience-manager/reference-materials/6-5/granite-ui/api/jcr_root/libs/granite/ui/components/coral/foundation/form/fileupload/index.html

10. Color Picker Granite UI 1.0, Touch UI XML Example:

Note: the variant properties can be set for two different outcomes; “default” allows the authors to insert custom hex values, while the set value of “swatch” does not allow custom hex selection.

sling:resourceType: granite/ui/components/coral/foundation/form/colorfield
Documentation: https://developer.adobe.com/experience-manager/reference-materials/6-5/granite-ui/api/jcr_root/libs/granite/ui/components/coral/foundation/form/colorfield/index.html

The post AEM Granite UI 1.0 Form Component’s XML Cheat Sheet Reference Guide appeared first on Sourced Code.

Sure we can invoke injectors by the @inject, followed by the @source annotation (with an injector name) as so, @Inject @Source(“script-bindings”), but invoking such injectors introduces many more lines of code which is tedious and repetitive. Using the @inject annotation freely may cause injector collisions.

This article will provide examples (used in practice) which will include both ways to invoke injectors in Sling Models, using the @Inject & @Source annotations, and also the Apache Sling Model injector specific annotations approach.

Available Injectors

1. @ScriptVariable
2. @ValueMapValue
3. @ResourcePath
4. @ChildResource
5. @RequestAttribute
6. @OSGiService
7. @Self
8. @SlingObject

1. Script Bindings (name=”script-bindings”) Injector

Service Ranking: 1000
Annotation: @ScriptVariable
Description: Injects objects via script variable defined from Sling Bindings; Lookup objects in the script bindings object by name.

2. Value Map (name=”valuemap”) Injector

Service Ranking: 2000
Annotation: @ValueMapValue
Description: Gets a property from a ValueMap by name; If @Via is not set, it will automatically take resource if the adaptable is the SlingHttpServletRequest. If name is not set the name is derived from the method/field name.

3. Resource Path (name=”resource-path”) Injector

Service Ranking: 2500
Annotation: @ResourcePath
Description: Injects one or multiple resources. The resource paths are either given by @Path annotations, the element path or paths of the annotation @ResourcePath or by paths given through a resource property being referenced by either @Named or element name of the annotation @ResourcePath.

4. Child Resources (name=”child-resources”) Injector

Service Ranking: 3000
Annotation: @ChildResource
Description: Gets a child resource by name.

5. Request Attributes (name=”request-attributes”) Injector

Service Ranking: 4000
Annotation: @RequestAttribute
Description: Injects a request attribute by name. If name is not set the name is derived from the method/field name.

The example below calls the Sling Model using input parameter:

6. OSGi Services (name=”osgi-services”) Injector

Service Ranking: 5000
Annotation: @OSGiService
Description: Injects an OSGi service by type; Lookup services based on class name. Since Sling Models Impl 1.2.8 (SLING-5664) the service with the highest service ranking is returned. In case multiple services are returned, they are ordered descending by their service ranking (i.e. the one with the highest ranking first).

7. Self (name=”self”) Injector

Service Ranking: Integer.MAX_VALUE
Annotation: @Self
Description: Injects the adaptable object itself (if the class of the field matches or is a supertype). If the @Self annotation is present it is tried to adapt the adaptable to the field type.

8. Sling Object (name=”sling-object”) Injector

Service Ranking: Integer.MAX_VALUE
Annotation: @SlingObject
Description: Injects commonly used sling objects if the field matches with the class: request, response, resource resolver, current resource, SlingScriptHelper. This works only if the adaptable can get the according information, i.e. all objects are available via SlingHttpServletRequest while ResourceResolver can only resolve the ResourceResolver object and nothing else. A discussion around this limitation can be found at SLING-4083. Also Resources can only be injected if the according injector specific annotation is used (@SlingObject).

The post AEM Sling Model Injectors Annotations Cheat Sheet Reference Guide appeared first on Sourced Code.

1. AEM Backend, an example of using global objects

• The global objects are accessible by OSGI’s dependency injection annotation; @inject.
• GET, SET, and other methods can be invoked by the POJO class.

2. AEM Front-End, example of using the global objects, stored in reserved variables:

• The global objects are accessible by using unique variables (defined below).
• Only GET methods can be invoked by Sightly/HTL.
• While previewing the java documentation, only the get methods can be used. While using the global object, exclude the “get” prefix.

3. Mapping of Sightly/HTL Variables and AEM Backend Objects:

The post AEM Global Objects for Backend and Front-end Sightly (HTL) Development appeared first on Sourced Code.

The best way to learn the power of the JCR-SQL2 language is to try it out on CRX/DE Lite. Without future or do, below will be a lesson on JCR-SQL2. To locate CRX/DE Lite’s query tool, visit http://localhost:4502/crx/de/index.jsp, then select on the tools drop down, and choose query.

JCR-SQL2 Syntax

1. SELECT Statement
2. NAME() Statement
3. ISDESCENDANTNODE Statement
4. CONTAINS Statement
5. LIKE Operator
6. IS NOT NULL Property
7. ORDER BY Keyword
8. CAST() Statement
9. JCR-SQL2 Code Snippets Cheat Sheet (new 2023)
10. JCR SQL2 Java Code Example Servlet (new 2023)

1. The JCR-SQL2 SELECT Statement

• The SELECT statement is used to select all JCR nodes that matches the JCR node’s primary type.
• Returns in CRX/DE Lite: A list of JCR nodes in the results table with their corresponding paths.
• Returns in OSGI Bundle (Sling API): All the found nodes stored in the Iterator<Resource> object.
• Returns in OSGI Bundle (JCR API): The QueryResult object where you can call getNodes() method to get the NodeIterator object.

2. The JCR-SQL2 NAME() Statement

• Selecting nodes with a specific node name.
• Returns in CRX/DE Lite: A list of JCR nodes in the results table with their corresponding paths.
• Returns in OSGI Bundle (Sling API): All the found nodes stored in the Iterator<Resource> object.
• Returns in OSGI Bundle (JCR API): The QueryResult object where you can call getNodes() method to get the NodeIterator object.

3. The JCR-SQL2 ISDESCENDANTNODE Statement

• Selecting nodes under a file path.
• Returns in CRX/DE Lite: A list of JCR nodes in the results table with their corresponding paths.
• Returns in OSGI Bundle (Sling API): All the found nodes stored in the Iterator<Resource> object.
• Returns in OSGI Bundle (JCR API): The QueryResult object where you can call getNodes() method to get the NodeIterator object.

4. The JCR-SQL2 CONTAINS Statement

• Selecting nodes where the properties contain a value.
• Returns in CRX/DE Lite: A list of JCR nodes in the results table with their corresponding paths.
• Returns in OSGI Bundle (Sling API): All the found nodes stored in the Iterator<Resource> object.
• Returns in OSGI Bundle (JCR API): The QueryResult object where you can call getNodes() method to get the NodeIterator object.

5. The JCR-SQL2 LIKE Operator

• The LIKE operator is used to search for a specified pattern in node properties.
• There are two wildcards used in conjunction with the LIKE operator: % and _
• Returns in CRX/DE Lite: A list of JCR nodes in the results table with their corresponding paths.
• Returns in OSGI Bundle (Sling API): All the found nodes stored in the Iterator<Resource> object.
• Returns in OSGI Bundle (JCR API): The QueryResult object where you can call getNodes() method to get the NodeIterator object.

6. The JCR-SQL2 IS NOT NULL Property

• Used for validation of property’s value is not null.
• Returns in CRX/DE Lite: A list of JCR nodes in the results table with their corresponding paths.
• Returns in OSGI Bundle (Sling API): All the found nodes stored in the Iterator<Resource> object.
• Returns in OSGI Bundle (JCR API): The QueryResult object where you can call getNodes() method to get the NodeIterator object.

7. The JCR-SQL2 ORDER BY Keyword

• The ORDER BY keyword is used to sort the result-set in ascending or descending order.
• Returned values are sorted by default in ascending order.
• Returns in CRX/DE Lite: A list of JCR nodes in the results table with their corresponding paths.
• Returns in OSGI Bundle (Sling API): All the found nodes stored in the Iterator<Resource> object.
• Returns in OSGI Bundle (JCR API): The QueryResult object where you can call getNodes() method to get the NodeIterator object.

8. The JCR-SQL2 CAST() Statement

• Convert an expression from one data type to another.
• Cast Types:
  • STRING
  • BINARY
  • DATE
  • LONG
  • DOUBLE
  • DECIMAL
  • BOOLEAN
  • NAME
  • PATH
  • REFERENCE
  • WEAKREFERENCE
  • URI
• Returns in CRX/DE Lite: A list of JCR nodes in the results table with their corresponding paths.
• Returns in OSGI Bundle (Sling API): All the found nodes stored in the Iterator<Resource> object.
• Returns in OSGI Bundle (JCR API): The QueryResult object where you can call getNodes() method to get the NodeIterator object.

9. JCR-SQL2 Code Snippets Cheat Sheet

Use these code snippets below to rapidly build your AEM JCR SQL2 search queries, I will try my best to give you some really great examples:

a. Find all [nt:unstructured] nodes, under the path “/content/we-retail”, where the node name = “root”

b. Find all components ([nt:unstructured] nodes), under the path “/content/we-retail”, where component resourceType = “weretail/components/content/image”

b. Find all components ([nt:unstructured] nodes), under the path “/content/we-retail”, where component resourceType = “weretail/components/content/image” AND the fileReference property contains with “/content/dam/we-retail/en/experiences”

c. Find all [nt:unstructured] nodes, under the path “/content/we-retail”, where the property(“jcr:title”) contains “Featured products”

d. Find all pages (cq:Page nodes), under the path “/content/we-retail”, where the cq:lastModified date is before or equals to “January 1st, 2000”

e. Find all pages (cq:Page nodes), under the path “/content/we-retail”, where the jcr:created date is before to “July 1st, 2022”

f. Find all [cq:PageContent] nodes, under the path “/content/we-retail”, where the cq:template equals to “/conf/we-retail/settings/wcm/templates/hero-page”

This AEM JCR SQ2 Query is an example for how to find all nodes with a specific template, results returned as cq:PageContent node.

g. Find all pages (cq:Page nodes), under the path “/content/we-retail”, where the cq:template equals to “/conf/we-retail/settings/wcm/templates/hero-page”

This AEM JCR SQ2 Query is an example for how to find all nodes with a specific template, results returned as cq:Page node.

h. Find all [cq:PageContent] nodes, under the path “/content/we-retail”, where the cq:tags[] contains “we-retail:gender/men”

i. Find all [cq:PageContent] nodes, under the path “/content/we-retail”, where the cq:tags[] contains “we-retail:gender/men” AND cq:tags[] contains “we-retail:activity/surfing”

9. JCR-SQL2 Java Code Example Servlet (2023)

This is an example of how an AEM servlet would actually utilize the JCR-SQL2 Query with the examples above. It will output a JSON array of the page paths.

JSON response

Curl call

The post How to use AEM JCR SQL2 query strings to query for nodes in Java Content Repository appeared first on Sourced Code.

Out of the box, AEM denies all server names or hosts to make HTTP request to the respective running AEM publish/author instance. During a HTTP request made to the AEM publish/author, AEM checks the Referrer header configuration. If the referrer configured to allow the host(s), then AEM will full-fill the request, and if not, the AEM “referrer not allowed” error message will be shown.

Take an example of an AEM application exposes an servlet that exposes the endpoint of “/bin/stores.js”. This endpoint will return an array of store detail JSON objects. This feature will be reusable, so throughout the AEM application, on many occasions, the endpoint is being used to render HTML elements to the page using javascript. Now take an example of a microsite within the same organisation of m.site.com (mobile site) where it would like to consume “/bin/stores.js”. When the micro-site make a HTTP GET request on “/bin/stores.js”, you will get the AEM “referrer not allowed” error because the host (or m.site.com) referrer is not allowed; we must allow m.site.com in the Apache Sling Referrer Filter settings.

In OSGI Configurations in AEM (http://localhost:4502/system/console/configMgr) use the browser finder (CTRL + F) and find “Apache Sling Referrer Filter”. Click on the configuration, and let’s break it down to see what fields control what.

Breaking things down

• Allow Empty (Boolean): only enable this if you are testing (using a REST Client). Enabling this will allow any hosts to make requests to your AEM application (remember to turn this off in your production environment).
• Allow Hosts (String[]): allows specific hosts to make requests to your AEM instance; use string characters only.
• Allow Regexp Host (String[]): allows specific hosts to make requests your AEM instance; use regex only.
• Filter Methods (String[]): defines which HTTP method(s) will be checked with the values in the allowed hosts before accepting incoming HTTP requests.

The post What is the AEM Apache Sling Referrer Filter OSGI configuration? appeared first on Sourced Code.