Content Classifications

AEM has long used the principal of overlays and Sling Resource Merger to allow customers to extend and customize AEM functionality. Predefined functionality that powers the AEM consoles and UI are stored in /libs. Customers are never to modify anything beneath /libs but could add additional content beneath /apps to overlay and extend the functionality defined in /libs (See Developing with Overlays for more information). This still caused numerous issues when upgrading AEM as the content in /libs might change causing the overlay functionality to break in unexpected ways. Customers could also extend AEM components through inheritance by way of sling:resourceSuperType, or simply reference a component in /libs directly by way of sling:resourceType. Similar upgrade issues could occur with reference and override use cases.

To make it safer and easier for customers to understand what areas of /libs are safe to use and overlay the content in /libs has been classified with the following mixins:

  • Public (granite:PublicArea) - Defines a node as public so that it can be overlaid, inherited ( sling:resourceSuperType) or used directly ( sling:resourceType). Nodes beneath /libs marked as Public are safe to upgrade with the addition of a Compatibility Package. In general, customers should only use nodes marked as Public.

  • Abstract (granite:AbstractArea) - Defines a node as abstract. Nodes can be overlaid or inherited ( sling:resourceSupertype) but not used directly ( sling:resourceType).

  • Final (granite:FinalArea) - Defines a node as final. Nodes classified as final ideally should not be overlaid or inherited. Final nodes can be used directly by way of sling:resourceType. Subnodes under final node are considered internal by default.

  • Internal (granite:InternalArea) *- *Defines a node as internal. Nodes classified as internal ideally should not be overlaid, inherited, or used directly. These nodes are meant only for internal functionality of AEM

  • No Annotation - Nodes inherit classification based on the tree hierarchy. The / root is by default Public. Nodes with a parent classified as Internal or Final are also to be treated as Internal.

NOTE
These policies are only enforced against Sling search path-based mechanisms. Other areas of /libs like a client-side library may be marked as Internal, but could still be used with standard clientlib inclusion. It is important that a customer continues to respect the Internal classification in these cases.

CRXDE Lite Content Type Indicators

Mixins applied in CRXDE Lite show content nodes and trees that are marked as INTERNAL as being dimmed (grayed out). For FINAL, only the icon is dimmed. The children of these nodes also appear dimmed. The Overlay Node functionality is disabled in both these cases.

Public

image2018-2-8_23-34-5

Final

image2018-2-8_23-34-56

Internal

image2018-2-8_23-38-23

Content Health Check

NOTE
As of AEM 6.5, Adobe recommends using the Pattern Detector to detect content access violations. Pattern detector reports are more detailed, detect more issues, and reduce the probability of false positives.

AEM 6.5 ships with a health check to alert customers if overlaid or referenced content is used in a way inconsistent with the content classification.

The** Sling/Granite Content Access Check** is a new health check that monitors the repository to see if customer code is improperly accessing protected nodes in AEM.

This scans /apps and typically takes several seconds to complete.

To access this new health check, do the following:

  1. From the AEM Home Screen, navigate to Tools > Operations > Health Reports

  2. Click Sling/Granite Content Access Check.

    screen_shot_2017-12-14at55648pm

After the scan is complete, a list of warnings appears, notifying an end user of the protected node that is being improperly referenced:

screenshot-2018-2-5healthreports

After fixing the violations, it returns to green state:

screenshot-2018-2-5healthreports-violations

The health check displays information collected by a background service that asynchronously checks whenever an overlay or resource type is used across all Sling search paths. If content mixins are used incorrectly, it reports a violation.

Experience Manager


Elevate and Empower Teams with Agentic AI for Exceptional Experiences

Online | Strategy Keynote | General Audience

Elevate and empower your CX teams with AI that transforms creativity, personalization, and productivity. Discover how Adobe is...

Tue, Mar 18, 1:00 PM PDT (8:00 PM UTC)

Register

3 Pillars of Purpose-driven Experiences: Trust, Data, and GenAI

In-person | Session | General Audience

Learn how leading B2B and B2C brands like AT&T and IBM are intersecting data, GenAI and trust to build “purpose-driven” experiences that...

Wed, Mar 19, 1:00 PM PDT (8:00 PM UTC)

Register

Connect with Experience League at Summit!

Get front-row access to top sessions, hands-on activities, and networking—wherever you are!

Learn more