AEM Context-Aware Configurations in Java Backend Example Code

AEM Context-Aware Configurations to enable developers to define adaptable application settings based on specific site or content contexts. This feature significantly simplifies the management of environment-specific configurations, allowing for dynamic application behavior adjustment without changing the core application code.

In this article, we will step through how developers can incorporate and retrieve context-aware configurations from AEM backend development.

Quick Links

Overview of Context-Aware Configurations
Accessing Configurations via Java
Configuration Interface Example
Utilizing the Configuration in an OSGi Component

1. Overview of Context-Aware Configurations

Adobe Experience Manager (AEM) introduces Context-Aware Configurations to empower developers to define adaptable application settings based on the specific contexts of sites or content. This functionality simplifies configuration management across different environments, facilitating dynamic behavior adjustments of applications without necessitating changes to the core code.

2. Accessing Configurations via Java

To harness context-aware configurations, the process starts with fetching the relevant content resource using the ResourceResolver:

1	Resource contentResource = resourceResolver.getResource("/content/mysite/page1");

Following resource retrieval, adapt it to a ConfigurationBuilder to fetch the specific configuration:

1	MyConfig config = contentResource.adaptTo(ConfigurationBuilder.class).as(MyConfig.class);

MyConfig is a developer-defined interface that encapsulates the configuration parameters influencing the application’s functionality.

4. Configuration Interface Example

Define the MyConfig interface with configuration parameters as follows from the code below. Making sure that my code is scalable, I usually place CaConfig under the path com.sourcedcode.core.caconfig.*

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

package com.sourcedcode.core.caconfig;

import org.apache.sling.caconfig.annotation.Configuration;
import org.apache.sling.caconfig.annotation.Property;

@Configuration(label = "My Configuration", description = "Configuration example for a component")
public @interface MyConfig {

@Property(label = "Feature Toggle", description = "Enable or disable the feature")
boolean featureEnabled() default false;

@Property(label = "Feature Name", description = "Specifies the feature name")
String featureName() default "defaultFeature";
}

5. Utilizing the Configuration in an OSGi Component

Implement the configuration within an AEM component or service as shown below:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

import org.apache.sling.api.resource.ResourceResolver;
import org.apache.sling.caconfig.ConfigurationBuilder;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;

@Component(service = MyComponent.class)
public class MyComponent {

@Reference
private ResourceResolver resourceResolver;

public void applyConfiguration() {
Resource contentResource = resourceResolver.getResource("/content/mysite/page1");
MyConfig config = contentResource.adaptTo(ConfigurationBuilder.class).as(MyConfig.class);

if (config.featureEnabled()) {
System.out.println("Feature is enabled: " + config.featureName());
}
}
}

This example demonstrates the dynamic adjustment of application functionality based on retrieved configurations, highlighting the flexibility and maintainability that Context-Aware Configurations bring to AEM development.

3 thoughts on “AEM Context-Aware Configurations in Java Backend Example Code”

AEM Context-Aware Configurations in Java Backend Example Code