AEM Cloud Service - Output Site Map XML with Absolute URLs

Goal

Output an OnDemand Site Map XML of the site with Absolute URLs having Domain Name. Domain name can be configured per environment (dev/stage/prod) in Cloud Services Program Overview > Environments > org-dev > Configuration > Environment Configuration as a variable here EAEM_SITEMAP_HOST_PREFIX. For SiteMap Generator check adobe documentation

Package Install | Github

SiteMap with Domain Name

Environment Variable in Cloud Service

Environment Variable in Local SDK

Enable SiteMap for en site

            /content/eaem-sites-sitemap-absolute-urls/us/en

Solution

1) Add a OSGI component apps.experienceaem.sites.core.models.EAEMSiteMapGenerator extending org.apache.sling.sitemap.spi.generator.ResourceTreeSitemapGenerator for adding custom resource urls in the map. Code in this class reads the environment variable siteMapHostPrefix (via osgi configuration) and constructs the full url of resource...

package apps.experienceaem.sites.core.models;

import java.util.Calendar;
import java.util.Optional;

import com.day.cq.replication.ReplicationStatus;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.sitemap.SitemapException;
import org.apache.sling.sitemap.builder.Sitemap;
import org.apache.sling.sitemap.builder.Url;
import org.apache.sling.sitemap.spi.generator.ResourceTreeSitemapGenerator;
import org.apache.sling.sitemap.spi.generator.SitemapGenerator;
import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.metatype.annotations.AttributeDefinition;
import org.osgi.service.metatype.annotations.AttributeType;
import org.osgi.service.metatype.annotations.Designate;
import org.osgi.service.metatype.annotations.ObjectClassDefinition;

import com.day.cq.wcm.api.Page;

@Component(
        property = {"service.ranking:Integer=99"},
        service = {SitemapGenerator.class}
)
@Designate(ocd=EAEMSiteMapGenerator.Configuration.class)
public class EAEMSiteMapGenerator extends ResourceTreeSitemapGenerator {
    private String siteMapHostPrefix = "";

    @Activate
    protected void activate(EAEMSiteMapGenerator.Configuration configuration) {
        this.siteMapHostPrefix = configuration.siteMapHostPrefix();
    }

    @Override
    protected void addResource(final String name, final Sitemap sitemap, final Resource resource) throws SitemapException {
        final Page page = resource.adaptTo(Page.class);
        String location = resource.getResourceResolver().map(page.getPath());

        location = this.siteMapHostPrefix + location;

        final Url url = sitemap.addUrl(location);

        Calendar lastmod = getLastmodDate(page);
        if (lastmod != null) {
            url.setLastModified(lastmod.toInstant());
        }
    }

    private Calendar getLastmodDate(Page page) {
        Optional createdAt = Optional.ofNullable(page.getContentResource()).map((contentResource) -> {
            return (ReplicationStatus) contentResource.adaptTo(ReplicationStatus.class);
        }).map(ReplicationStatus::getLastPublished);

        if (createdAt.isPresent()) {
            return (Calendar) createdAt.get();
        }

        return null;
    }

    @ObjectClassDefinition(
            name = "Experience AEM - Page Tree Sitemap Generator Configuration"
    )
    @interface Configuration {
        @AttributeDefinition(
                name = "SiteMap Host Prefix",
                description = "SiteMap Host Prefix for making absolute urls in response of sitemap.xml requests",
                type = AttributeType.STRING
        )
        String siteMapHostPrefix() default "";
    }
}

2) Add config json for the above site map generator \apps\eaem-sites-sitemap-absolute-urls\osgiconfig\config\apps.experienceaem.sites.core.models.EAEMSiteMapGenerator.cfg.json for setting siteMapHostPrefix 

{
  "siteMapHostPrefix": "$[env:EAEM_SITEMAP_HOST_PREFIX]"
}

3) Enable on demand sitemap generation (its disabled by default for performance reasons) by setting allOnDemand to true in \apps\eaem-sites-sitemap-absolute-urls\osgiconfig\config\org.apache.sling.sitemap.impl.SitemapGeneratorManagerImpl~eaem.cfg.json

{
  "allOnDemand": true
}