Talks about how to use the Apache Sling Rewriter API

Article summary

Summary


Discusses how to create an AEM 6.3 Sling Rewriter Service by using the Apache Sling Java API.

This article uses an Adobe Maven Archetype 11 project to build an OSGi bundle. If you are not familiar with an Adobe Maven Archetype project, it is recommended that you read the following article: Creating an Adobe Experience Manager 6.3 Project using Adobe Maven Archetype 11.

A special thank you to Daniel Klco, a member of the AEM community, for submitting AEM Java code that is used as the basis for this developer article. In addition, thank you to Sumanta Pakira for helping with this use case. 

A special thank you to Ratna Kumar Kotla and Navin Kaushal, very helpful AEM community members, for testing this article to ensure it works.

Its great community members like those mentioned here that help the overall AEM community and drives the success of AEM Developers using Adobe Experience Manager.

Digital Marketing Solution(s) Adobe Experience Manager 6.3
Audience Developer
Required Skills Java, HTML, JavaScript
Version 6.3

Download

Introduction

You can create a custom Adobe Experience Manager 6.3 (AEM) Link Rewriter service that is based on the Apache Sling Rewriter module. This module is used for rewriting the output generated by the Sling rendering process.

An AEM Link Rewriter service is implemented as an OSGi bundle that contains a Java class that extends the org.apache.sling.rewriter.Transformer class. For information, see Interface Transformer.

 

Note:

For more details, see Apache Sling Rewriter.

This development article walks you through how to create an AEM Link Rewriter service that modifies links the references the following content: 

  • A PDF document 
  • A MS Word document 
  • A MS Excel file 

For example, if a link within an AEM We Retail web page references a PDF in the AEM DAM, the link is modified by the service. The AEM service adds a PDF icon to the link, as shown in the following illustration. 

ClientLinkMod
An AEM Linked Rewriter Service modifies a link within an AEM web page

Setup Maven in your development environment

You can use Maven to build an OSGi bundle that contains a Sling Servlet. Maven manages required JAR files that a Java project needs in its class path. Instead of searching the Internet trying to find and download third-party JAR files to include in your project’s class path, Maven manages these dependencies for you.

You can download Maven 3 from the following URL:

http://maven.apache.org/download.html

After you download and extract Maven, create an environment variable named M3_HOME. Assign the Maven install location to this environment variable. For example:

C:\Programs\Apache\apache-maven-3.0.4

Set up a system environment variable to reference Maven. To test whether you properly setup Maven, enter the following Maven command into a command prompt:

%M3_HOME%\bin\mvn -version

This command provides Maven and Java install details and resembles the following message:

Default locale: en_US, platform encoding: Cp1252
OS name: "windows 7", version: "6.1", arch: "amd64", family: "windows"

Note: It is recommended that you use Maven 3.0.3 or greater. For more information about setting up Maven and the Home variable, see: Maven in 5 Minutes.

Next, copy the Maven configuration file named settings.xml from [install location]\apache-maven-3.0.4\conf\ to your user profile. For example, C:\Users\scottm\.m2\.

You have to configure your settings.xml file to use Adobe’s public repository. For information, see Adobe Public Maven Repository at http://repo.adobe.com/.

The following XML code represents a settings.xml file that you can use.

<?xml version="1.0" encoding="UTF-8"?>
  
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at
  
    http://www.apache.org/licenses/LICENSE-2.0
  
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
-->
  
<!--
 | This is the configuration file for Maven. It can be specified at two levels:
 |
 |  1. User Level. This settings.xml file provides configuration for a single user, 
 |                 and is normally provided in ${user.home}/.m2/settings.xml.
 |
 |                 NOTE: This location can be overridden with the CLI option:
 |
 |                 -s /path/to/user/settings.xml
 |
 |  2. Global Level. This settings.xml file provides configuration for all Maven
 |                 users on a machine (assuming they're all using the same Maven
 |                 installation). It's normally provided in 
 |                 ${maven.home}/conf/settings.xml.
 |
 |                 NOTE: This location can be overridden with the CLI option:
 |
 |                 -gs /path/to/global/settings.xml
 |
 | The sections in this sample file are intended to give you a running start at
 | getting the most out of your Maven installation. Where appropriate, the default
 | values (values used when the setting is not specified) are provided.
 |
 |-->
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
  <!-- localRepository
   | The path to the local repository maven will use to store artifacts.
   |
   | Default: ~/.m2/repository
  <localRepository>/path/to/local/repo</localRepository>
  -->
  
  <!-- interactiveMode
   | This will determine whether maven prompts you when it needs input. If set to false,
   | maven will use a sensible default value, perhaps based on some other setting, for
   | the parameter in question.
   |
   | Default: true
  <interactiveMode>true</interactiveMode>
  -->
  
  <!-- offline
   | Determines whether maven should attempt to connect to the network when executing a build.
   | This will have an effect on artifact downloads, artifact deployment, and others.
   |
   | Default: false
  <offline>false</offline>
  -->
  
  <!-- pluginGroups
   | This is a list of additional group identifiers that will be searched when resolving plugins by their prefix, i.e.
   | when invoking a command line like "mvn prefix:goal". Maven will automatically add the group identifiers
   | "org.apache.maven.plugins" and "org.codehaus.mojo" if these are not already contained in the list.
   |-->
  <pluginGroups>
    <!-- pluginGroup
     | Specifies a further group identifier to use for plugin lookup.
    <pluginGroup>com.your.plugins</pluginGroup>
    -->
  </pluginGroups>
  
  <!-- proxies
   | This is a list of proxies which can be used on this machine to connect to the network.
   | Unless otherwise specified (by system property or command-line switch), the first proxy
   | specification in this list marked as active will be used.
   |-->
  <proxies>
    <!-- proxy
     | Specification for one proxy, to be used in connecting to the network.
     |
    <proxy>
      <id>optional</id>
      <active>true</active>
      <protocol>http</protocol>
      <username>proxyuser</username>
      <password>proxypass</password>
      <host>proxy.host.net</host>
      <port>80</port>
      <nonProxyHosts>local.net|some.host.com</nonProxyHosts>
    </proxy>
    -->
  </proxies>
  
  <!-- servers
   | This is a list of authentication profiles, keyed by the server-id used within the system.
   | Authentication profiles can be used whenever maven must make a connection to a remote server.
   |-->
  <servers>
    <!-- server
     | Specifies the authentication information to use when connecting to a particular server, identified by
     | a unique name within the system (referred to by the 'id' attribute below).
     | 
     | NOTE: You should either specify username/password OR privateKey/passphrase, since these pairings are 
     |       used together.
     |
    <server>
      <id>deploymentRepo</id>
      <username>repouser</username>
      <password>repopwd</password>
    </server>
    -->
      
    <!-- Another sample, using keys to authenticate.
    <server>
      <id>siteServer</id>
      <privateKey>/path/to/private/key</privateKey>
      <passphrase>optional; leave empty if not used.</passphrase>
    </server>
    -->
  </servers>
  
  <!-- mirrors
   | This is a list of mirrors to be used in downloading artifacts from remote repositories.
   | 
   | It works like this: a POM may declare a repository to use in resolving certain artifacts.
   | However, this repository may have problems with heavy traffic at times, so people have mirrored
   | it to several places.
   |
   | That repository definition will have a unique id, so we can create a mirror reference for that
   | repository, to be used as an alternate download site. The mirror site will be the preferred 
   | server for that repository.
   |-->
  <mirrors>
    <!-- mirror
     | Specifies a repository mirror site to use instead of a given repository. The repository that
     | this mirror serves has an ID that matches the mirrorOf element of this mirror. IDs are used
     | for inheritance and direct lookup purposes, and must be unique across the set of mirrors.
     |
    <mirror>
      <id>mirrorId</id>
      <mirrorOf>repositoryId</mirrorOf>
      <name>Human Readable Name for this Mirror.</name>
      <url>http://my.repository.com/repo/path</url>
    </mirror>
     -->
  </mirrors>
    
  <!-- profiles
   | This is a list of profiles which can be activated in a variety of ways, and which can modify
   | the build process. Profiles provided in the settings.xml are intended to provide local machine-
   | specific paths and repository locations which allow the build to work in the local environment.
   |
   | For example, if you have an integration testing plugin - like cactus - that needs to know where
   | your Tomcat instance is installed, you can provide a variable here such that the variable is 
   | dereferenced during the build process to configure the cactus plugin.
   |
   | As noted above, profiles can be activated in a variety of ways. One way - the activeProfiles
   | section of this document (settings.xml) - will be discussed later. Another way essentially
   | relies on the detection of a system property, either matching a particular value for the property,
   | or merely testing its existence. Profiles can also be activated by JDK version prefix, where a 
   | value of '1.4' might activate a profile when the build is executed on a JDK version of '1.4.2_07'.
   | Finally, the list of active profiles can be specified directly from the command line.
   |
   | NOTE: For profiles defined in the settings.xml, you are restricted to specifying only artifact
   |       repositories, plugin repositories, and free-form properties to be used as configuration
   |       variables for plugins in the POM.
   |
   |-->
  <profiles>
    <!-- profile
     | Specifies a set of introductions to the build process, to be activated using one or more of the
     | mechanisms described above. For inheritance purposes, and to activate profiles via <activatedProfiles/>
     | or the command line, profiles have to have an ID that is unique.
     |
     | An encouraged best practice for profile identification is to use a consistent naming convention
     | for profiles, such as 'env-dev', 'env-test', 'env-production', 'user-jdcasey', 'user-brett', etc.
     | This will make it more intuitive to understand what the set of introduced profiles is attempting
     | to accomplish, particularly when you only have a list of profile id's for debug.
     |
     | This profile example uses the JDK version to trigger activation, and provides a JDK-specific repo.
    <profile>
      <id>jdk-1.4</id>
  
      <activation>
        <jdk>1.4</jdk>
      </activation>
  
      <repositories>
        <repository>
          <id>jdk14</id>
          <name>Repository for JDK 1.4 builds</name>
          <url>http://www.myhost.com/maven/jdk14</url>
          <layout>default</layout>
          <snapshotPolicy>always</snapshotPolicy>
        </repository>
      </repositories>
    </profile>
    -->
  
    <!--
     | Here is another profile, activated by the system property 'target-env' with a value of 'dev',
     | which provides a specific path to the Tomcat instance. To use this, your plugin configuration
     | might hypothetically look like:
     |
     | ...
     | <plugin>
     |   <groupId>org.myco.myplugins</groupId>
     |   <artifactId>myplugin</artifactId>
     |   
     |   <configuration>
     |     <tomcatLocation>${tomcatPath}</tomcatLocation>
     |   </configuration>
     | </plugin>
     | ...
     |
     | NOTE: If you just wanted to inject this configuration whenever someone set 'target-env' to
     |       anything, you could just leave off the <value/> inside the activation-property.
     |
    <profile>
      <id>env-dev</id>
  
      <activation>
        <property>
          <name>target-env</name>
          <value>dev</value>
        </property>
      </activation>
  
      <properties>
        <tomcatPath>/path/to/tomcat/instance</tomcatPath>
      </properties>
    </profile>
    -->
    
  
<profile>
  
                <id>adobe-public</id>
  
                <activation>
  
                    <activeByDefault>true</activeByDefault>
  
                </activation>
  
                <repositories>
  
                  <repository>
  
                    <id>adobe</id>
  
                    <name>Nexus Proxy Repository</name>
  
                    <url>http://repo.adobe.com/nexus/content/groups/public/</url>
  
                    <layout>default</layout>
  
                  </repository>
  
                </repositories>
  
                <pluginRepositories>
  
                  <pluginRepository>
  
                    <id>adobe</id>
  
                    <name>Nexus Proxy Repository</name>
  
                    <url>http://repo.adobe.com/nexus/content/groups/public/</url>
  
                    <layout>default</layout>
  
                  </pluginRepository>
  
                </pluginRepositories>
  
            </profile>
  
</profiles>
  
  <!-- activeProfiles
   | List of profiles that are active for all builds.
   |
  <activeProfiles>
    <activeProfile>alwaysActiveProfile</activeProfile>
    <activeProfile>anotherAlwaysActiveProfile</activeProfile>
  </activeProfiles>
  -->
</settings>

Note:

The Adobe repository URL is now made secured. Change http://repo.adobe.com/nexus/content/groups/public/ to https://repo.adobe.com/nexus/content/groups/public/.

Create an AEM Maven 11 archetype project

Create an Experience Manager 11 archetype project by using the Maven archetype plugin. In this example, assume that the working directory is C:\AdobeCQ.

M10
Files generated by Maven 11 Archetype

To create an Experience Manager archetype project, perform these steps:

1. Open the command prompt and go to your working directory (for example, C:\AdobeCQ).

2. Run the following Maven command:

mvn org.apache.maven.plugins:maven-archetype-plugin:2.4:generate -DarchetypeGroupId=com.adobe.granite.archetypes -DarchetypeArtifactId=aem-project-archetype -DarchetypeVersion=11 -DarchetypeCatalog=https://repo.adobe.com/nexus/content/groups/public/

3. When prompted, specify the following information:

  • groupId - linkRewriterIcon
  • artifactId - linkRewriterIcon
  • version - 1.0-SNAPSHOT
  • package - com.adobe.community.rewriter
  • appsFolderName - linkRewriterIcon
  • artifactName - linkRewriterIcon
  • componentGroupName - linkRewriterIcon
  • contentFolderName - linkRewriterIcon
  • cssId - linkRewriterIcon
  • packageGroup - linkRewriterIcon
  • siteName - linkRewriterIcon

4. When prompted, specify Y.

5. Once done, you will see a message like:

[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 01:42 min
[INFO] Finished at: 2016-04-25T14:34:19-04:00
[INFO] Final Memory: 16M/463M
[INFO] ------------------------------------------------------------------------

6. Change the working directory to linkRewriterIcon and then enter the following command.

mvn eclipse:eclipse

After you run this command, you can import the project into Eclipse as discussed in the next section.

Add Java files to the Maven project using Eclipse

To make it easier to work with the Maven generated project, import it into the Eclipse development environment, as shown in the following illustration.

project
Eclipse Import Project Dialog

Note:

Do not worry about the errors reported in Eclipse. It does not read the POM file where the APIs are resolved. You build the bundle with Maven. Eclipse is used to edit the Java files and the POM file.

After you import the project into Eclipse, notice each module is a separate Eclipse project:

  • core - where Java files that are used in OSGi services and sling servlets are located
  • launcher - where additional Java files are located
  • tests - Java files for tests like JUNIT tests
  • apps - content under /apps
  • content - content under /content

When you want to create an OSGi service, you work under core. Likewise, if you want to create a HTL component, you can work under apps.

The next step is to add Java files to the com.adobe.community.rewriter.core package. One of the Java classes that you create in this section impements the org.apache.sling.rewriter.Transformer interface. For information, see Interface Transformer.

You create two Java classes in the com.adobe.community.rewriter.core package: 

  • LinkTypeTransformerFactory - creates a Transformer instance
  • LinkTypeTransformer - contains business logic that modifies links. 

 

Note:

This development article uses Declarative Services Annotations as opposed to Apache Felix SCR annotations. For information, see OFFICIAL OSGI DECLARATIVE SERVICES ANNOTATIONS IN AEM.  

LinkTypeTransformerFactory

The LinkTypeTransformerFactory class has a method named createTransformer that creates a Transformer instance. The following Java code represents this class.  

package com.adobe.community.rewriter.core;

import org.apache.sling.rewriter.Transformer;
import org.apache.sling.rewriter.TransformerFactory;
import org.osgi.service.component.annotations.Component;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * A TransformerFactory service instance for creating a Transformer to add link
 * type icons into links to documents.
 * 
 * @author dklco@apache.org
 * @see com.perficient.adobe.rewriter.LinkTypeTransformer
 */
@Component(property = { "pipeline.type=linktype" }, service = { TransformerFactory.class })
public class LinkTypeTransformerFactory implements TransformerFactory {

	private static final Logger log = LoggerFactory.getLogger(LinkTypeTransformerFactory.class);

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.apache.sling.rewriter.TransformerFactory#createTransformer()
	 */
	@Override
	public Transformer createTransformer() {
		log.trace("createTransformer");
		return new LinkTypeTransformer();
	}

}

LinkTypeTransformer

The LinkTypeTransformer class implements the Transformer class and contains the application logic that modifies links within an AEM web page. Notice this this class contains methods inherited from interface org.xml.sax.ContentHandler such as startElement

In this example, notice the init method. This method contains application logic that populates a Java Map object. Notice the use of the following code: 

for (String type : new String[] { "pdf", "doc", "xls" }) {
    iconMap.put(Pattern.compile(".+\\." + type + "($|#.*|\\?.*)", Pattern.CASE_INSENSITIVE),
"/etc/designs/sling-rewriting-pipeline-demo/img/" + type + ".png");
}

This is how the link rewriter modifies links that reference PDF, DOC, or XLS files. 

The following Java code represents the LinkTypeTransformer class.

package com.adobe.community.rewriter.core;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import java.util.Map.Entry;
import java.util.regex.*;

import javax.swing.text.html.HTML;

import org.apache.jackrabbit.oak.commons.StringUtils;
import org.apache.sling.rewriter.ProcessingComponentConfiguration;
import org.apache.sling.rewriter.ProcessingContext;
import org.apache.sling.rewriter.Transformer;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.xml.sax.Attributes;
import org.xml.sax.ContentHandler;
import org.xml.sax.Locator;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.AttributesImpl;

import com.drew.lang.StringUtil;

/**
 * A Sling Rewriter Transformer which appends in an icon to the beginning of
 * links to document links.
 * 
 * @author dklco@apache.org
 */
public class LinkTypeTransformer implements Transformer {

	private static final Logger log = LoggerFactory.getLogger(LinkTypeTransformer.class);

	private ContentHandler contentHandler;

	private Map<Pattern, String> iconMap = new HashMap<Pattern, String>();

	@Override
	public void setDocumentLocator(Locator locator) {
		contentHandler.setDocumentLocator(locator);
	}

	@Override
	public void startDocument() throws SAXException {
		contentHandler.startDocument();
	}

	@Override
	public void endDocument() throws SAXException {
		contentHandler.endDocument();
	}

	@Override
	public void startPrefixMapping(String prefix, String uri) throws SAXException {
		contentHandler.startPrefixMapping(prefix, uri);
	}

	@Override
	public void endPrefixMapping(String prefix) throws SAXException {
		contentHandler.endPrefixMapping(prefix);
	}

	@Override
	public void startElement(String uri, String localName, String qName, Attributes atts) throws SAXException {
		if (HTML.Tag.A.toString().equalsIgnoreCase(localName) && isDefinedType(atts)) {
			contentHandler.startElement(uri, localName, qName, atts);
			addTypeIcon(atts);
		} else {
			contentHandler.startElement(uri, localName, qName, atts);
		}
	}

	private void addTypeIcon(Attributes elAttrs) throws SAXException {
		log.trace("addTypeIcon");

		String href = elAttrs.getValue(HTML.Attribute.HREF.toString());
		String icon = null;
		for (Entry<Pattern, String> entry : iconMap.entrySet()) {
			if (entry.getKey().matcher(href).matches()) {
				icon = entry.getValue();
				break;
			}
		}

		if (icon != null) {
			log.debug("Adding icon {} to link {}", icon, href);
			AttributesImpl atts = new AttributesImpl();
			atts.addAttribute("", HTML.Attribute.SRC.toString(), "", "", icon);
			contentHandler.startElement("", HTML.Tag.IMG.toString(), "", atts);
			contentHandler.endElement("", HTML.Tag.IMG.toString(), "");
		} else {
			log.warn("Unable to find icon for {}", href);
		}
	}

	private boolean isDefinedType(Attributes atts) {
		String href = atts.getValue(HTML.Attribute.HREF.toString());
		if (href != null) {
			for (Pattern pattern : iconMap.keySet()) {
				if (pattern.matcher(href).matches()) {
					log.debug("URL {} matches pattern {}", href, pattern);
					return true;
				}
			}
		}
		return false;
	}

	@Override
	public void endElement(String uri, String localName, String qName) throws SAXException {
		contentHandler.endElement(uri, localName, qName);
	}

	@Override
	public void characters(char[] ch, int start, int length) throws SAXException {
		contentHandler.characters(ch, start, length);
	}

	@Override
	public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException {
		contentHandler.ignorableWhitespace(ch, start, length);
	}

	@Override
	public void processingInstruction(String target, String data) throws SAXException {
		contentHandler.processingInstruction(target, data);
	}

	@Override
	public void skippedEntity(String name) throws SAXException {
		contentHandler.skippedEntity(name);
	}

	@Override
	public void dispose() {
		// TODO Auto-generated method stub

	}

	@Override
	public void init(ProcessingContext context, ProcessingComponentConfiguration config) throws IOException {
		log.trace("init");
		for (String type : new String[] { "pdf", "doc", "xls" }) {
			iconMap.put(Pattern.compile(".+\\." + type + "($|#.*|\\?.*)", Pattern.CASE_INSENSITIVE),
					"/etc/designs/sling-rewriting-pipeline-demo/img/" + type + ".png");
		}
	}

	@Override
	public void setContentHandler(ContentHandler handler) {
		this.contentHandler = handler;
	}

}

Modify the Maven POM file

Add the following POM dependency to the POM file located at C:\AdobeCQ\linkRewriterIcon.

<dependency>
               <groupId>com.adobe.aem</groupId>
               <artifactId>uber-jar</artifactId>
               <version>6.3.0</version>
               <!-- for AEM6.1 use this version     : <version>6.1.0</version> -->
               <!-- for AEM6.1 SP1 use this version : <version>6.1.0-SP1-B0001</version> -->
               <!-- for AEM6.1 SP2 use this version : <version>6.1.0-SP2</version> -->
               <!-- for AEM6.2 use this version     : <version>6.2.0</version> -->
               <classifier>obfuscated-apis</classifier>
               <scope>provided</scope>
           </dependency>
             
           <dependency>
               <groupId>org.apache.geronimo.specs</groupId>
               <artifactId>geronimo-atinject_1.0_spec</artifactId>
               <version>1.0</version>
               <scope>provided</scope>
           </dependency>

When you add new Java classes under core, you need to modify a POM file to successfully build the OSGi bundle. You modify the POM file located at C:\AdobeCQ\linkRewriterIcon\core.

The following code represents this POM file.

<?xml version="1.0" encoding="UTF-8"?>
<!--
 |  Copyright 2015 Adobe Systems Incorporated
 |
 |  Licensed under the Apache License, Version 2.0 (the "License");
 |  you may not use this file except in compliance with the License.
 |  You may obtain a copy of the License at
 |
 |      http://www.apache.org/licenses/LICENSE-2.0
 |
 |  Unless required by applicable law or agreed to in writing, software
 |  distributed under the License is distributed on an "AS IS" BASIS,
 |  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 |  See the License for the specific language governing permissions and
 |  limitations under the License.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>linkRewriterIcon</groupId>
        <artifactId>linkRewriterIcon</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>
    <artifactId>linkRewriterIcon.core</artifactId>
    <packaging>bundle</packaging>
    <name>linkRewriterIcon - Core</name>
    <description>Core bundle for linkRewriterIcon</description>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.sling</groupId>
                <artifactId>maven-sling-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-bundle-plugin</artifactId>
                <extensions>true</extensions>
                <executions>
                    <execution>
                        <id>bundle-manifest</id>
                        <phase>process-classes</phase>
                        <goals>
                            <goal>manifest</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <instructions>
                        <!-- Import any version of javax.inject, to allow running on multiple versions of AEM -->
                        <Import-Package>javax.inject;version=0.0.0,*</Import-Package>
                        <Sling-Model-Packages>
                            com.adobe.community.rewriter.core
                        </Sling-Model-Packages>
                    </instructions>
                </configuration>
            </plugin>
        </plugins>
    </build>

    <dependencies>
        <!-- OSGi Dependencies -->
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>osgi.core</artifactId>
        </dependency>
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>osgi.cmpn</artifactId>
        </dependency>
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>osgi.annotation</artifactId>
        </dependency>
        <!-- Other Dependencies -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
        </dependency>
        <dependency>
            <groupId>javax.jcr</groupId>
            <artifactId>jcr</artifactId>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>servlet-api</artifactId>
        </dependency>
        <dependency>
            <groupId>com.adobe.aem</groupId>
            <artifactId>uber-jar</artifactId>
            <classifier>apis</classifier>
        </dependency>
        <dependency>
            <groupId>org.apache.sling</groupId>
            <artifactId>org.apache.sling.models.api</artifactId>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mockito</groupId>
            <artifactId>mockito-core</artifactId>
        </dependency>
        <dependency>
            <groupId>junit-addons</groupId>
            <artifactId>junit-addons</artifactId>
        </dependency>
    </dependencies>
</project>

Build the OSGi bundle using Maven

To build the OSGi bundle by using Maven, perform these steps:

  1. Open the command prompt and go to the C:\AdobeCQ\linkRewriterIcon.
  2. Run the following maven command: mvn -PautoInstallPackage install.
  3. The OSGi component can be found in the following folder: C:\AdobeCQ\linkRewriterIcon\core\target. The file name of the OSGi component is linkRewriterIcon.core-1.0-SNAPSHOT.jar.

The command -PautoInstallPackage automatically deploys the OSGi bundle to AEM.

View the Active OSGi bundle

After you deploy the OSGi bundle by using the Maven command, you can see it in an active state in the Adobe Apache Felix Web Console.

 

OSGI
The OSGi bundle in an Active State

View your OSGi bundle by performing these steps:

  1. Login to Adobe Apache Felix Web Console at http://server:port/system/console/bundles (default admin user = admin with password= admin).
  2. Click the Bundles tab, sort the bundle list by Id, and note the Id of the last bundle.

Set Configuration nodes for the Rewriter Service

Create configuration nodes under this JCR location: 

/apps/linkRewriterIcon/config

To setup the AEM configuration nodes, perform these steps in CRXDE lite: 

1. Select the following node: /apps/linkRewriterIcon/config.

2.  Right click and select Create, Create Node. Enter the following values:

  • Name: rewriter
  • Type: sling:Folder

3. Select the following node: /apps/linkRewriterIcon/config/rewriter.

4. Right click and select Create, Create Node. Enter the following values:

  • Name: link-type-rewrite
  • Type: nt:unstructured

5. Add the following properties to this node: 

  • contentTypes (String[]) - text/html
  • enabled (Boolean) - true
  • generatorType (String) - htmlparser
  • order (String) - 1000
  • paths (String[]) - /content
  • serializerType (String) - htmlwriter
  • transformerTypes (String[]) - linktype

6. Select the following node: /apps/linkRewriterIcon/config/rewriter/link-type-rewrite.

7. Right click and select Create, Create Node. Enter the following values:

  • Name: generator-htmlparser
  • Type: nt:unstructured

8. Add the following property to this node:

  • includeTags (String[]) - A

Place a link that references a PDF into a We Retail page

The final task to perform is to open a We Retail page located in the following location. 

http://localhost:4502/editor.html/content/we-retail/ca/en/men.html

The following illustration shows this page. 

MenPage
An AEM We Retail page

Scroll to the bottom of the page and place a Text component onto the page. Specify a value such as PDF File. Then select this text and make it a link that references a PDF in the AEM DAM, as shown in this illustration. 

PDF_LINK
Make text a link that references a PDF document in the AEM DAM

Then view the page in Preview mode. You will see a PDF icon as part of the link. The custom AEM Link Rewriter service that you created in this article has modified the link and created the icon. 

ClientLinkMod
A PDF Icon appears with the link.

Note:

Make sure that you install the package shown at the start of this article to deploy the image icons that the service uses. 

See also

Join the AEM community at: Adobe Experience Manager Community

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy