Package com.adobe.cq.xf

Interface ExperienceFragmentLinkRewriterProvider

  • @ConsumerType
public interface ExperienceFragmentLinkRewriterProvider

    Experience Fragment Link Rewriter Provider

    This is an extension point offered to clients in order to allow link rewriting for the Export to Target feature.

    Services implementing this interface will be called during the Export To Target offer content generation for HTML.

    When an Export to Target call is made in the AEM Experience Fragment console, the body of the HTML content is generated through a request to an Experience Fragment with the selector atoffer.html. However, before this HTML content can be sent to Target, we would have to rewrite the links present throughout the content in such a way so that they point to resources on the publish instance, where they can be accessed publicly. We already rewrite these links using Externalizer, but if there is the need for more customization, a service can implement this interface in order to take control of the link rewriting process.

    For example, a call is made to http[s]://aem_instance[:port]/path/to/experience/fragment.nocloudconfigs.atoffer.html. During the Sling Rewriter phase, Sling will parse each node of the HTML output (called tag). At this time, if there is any service implementing this interface, the "shouldRewrite" method is called in order to establish if the current Experience Fragment should have links rewritten. If the method returns true, then our system doesn't make any more modifications to the link, but lets the service handle the rewriting through the rewriteLink method.

    Currently, only one ExperienceFragmentLinkRewriterProvider for an Experience Fragment is permitted. If there are multiple providers for an Experience Fragment, only the one with the highest priority is chosen. Priority is determined by the providers getPriority() method. If there are several ExperienceFragmentLinkRewriterProvider with the same priority, then only one will be chosen.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int getPriority()
      If there are several providers for which the shouldRewrite returns true for a particular ExperienceFragmentVariation, then the one with the highest priority is used.
      java.lang.String rewriteLink​(java.lang.String link, java.lang.String tag, java.lang.String attribute)
      This method receives a String which represents the location of the resource on the author instance.
      boolean shouldRewrite​(ExperienceFragmentVariation experienceFragment)
      This method receives the Resource which represents the Experience Fragment that is currently being processed by the Sling Rewriter framework.

    • Method Detail

      • rewriteLink

        java.lang.String rewriteLink​(java.lang.String link,
                             java.lang.String tag,
                             java.lang.String attribute)
        This method receives a String which represents the location of the resource on the author instance. These are the values of attributes present on the HTML tags that are also passed as input.

        The type of attributes that will be processed are the following:

        • src attributes
        • href attributes
        • action attributes
        • attributes that contain -href in their name
        • attributes that contain -src in their name

        The link this method receives is usually an URI in the form of /path/to/resource. To note that in some cases, the URI might differ, due to the effects of the html selector on a component inside the Experience Fragments. In other words, if there are custom components in your Experience Fragment, then the link received in this method might be different, depending on its implementation. Our out-of-the-box components are rendered as a path to the resource, as mentioned previously.

        Besides the link, the method also receives the local attribute name, so that implementations can easily distinguish what attributes from the above set is currently being processed (e.g. there can be data-src attributes that an implementation might not want to change). The last parameter is the tag name that is currently being processed, that can be helpful in the case some resources should not be changed, such as link attributes when the purpose is embedding inside another page.

        The method should return a valid link to the resource, that can be accessed publicly. This link will be then placed in the corresponding attribute and tag. An example of an output for a regular case is the mapped public facing URL to a resource: http[s]://[public-hostname]/path/to/resource. How the output should look like is an implementation detail left to the service that implements this interface. The regular use case is that the Target Offer is embedded inside other HTML pages as a separate div and then delivered to clients or used in other places, and as such all the links inside this Target Offer should be able to be accessed by anyone.

        If the method returns null, then no rewrite will be done and the link will remain the same.

        Parameters:
        link - - the value of the attribute, which is usually an internal URI (e.g. /path/to/resource)
        tag - - the name of the node that is currently modified
        attribute - - the name of the attribute that is currently modified
        Returns:
        - a string representing the rewritten link that is public facing (e.g. http[s]://[public_instance]/path/to/resource), or null

      • shouldRewrite

        boolean shouldRewrite​(ExperienceFragmentVariation experienceFragment)
        This method receives the Resource which represents the Experience Fragment that is currently being processed by the Sling Rewriter framework.

        Should return true if the service implementing this interface should be used on rewriting links for the experience fragment variation given.

        Parameters:
        experienceFragment - - the experience fragment that is currently processed
        Returns:
        - true in case this service should rewrite links, false otherwise

      • getPriority

        int getPriority()
        If there are several providers for which the shouldRewrite returns true for a particular ExperienceFragmentVariation, then the one with the highest priority is used.
        Returns:
        - an Integer representing the priority of this Provider over others for which shouldRewrite(ExperienceFragmentVariation) returns true.