com.taradevko.aem.seo.service

Interface CanonicalTagging

All Known Implementing Classes:

CanonicalTaggingImpl

public interface CanonicalTagging

Service for looking for the canonical page.

OSGi Implementation is to be configured. Rule has next syntax:

• for **strict** rules, where page is mapped to another page: `_PATH PAGE 1_=>_CANONICAL PAGE PATH_`
• for rules which map pages by regex and provide lookup path: `_PATTERN FOR PAGE WHICH CHILD WILL BE MAPPED_>_LOOKUP PATH_`

Examples:

      for rule /content/mysite/categoty[0-9]>/content/mysite/maincategory
      configured publish domain https://doma.in
      and resource path /content/mysite/categoty4/page-with-canonical/component
      canonical path will be  https://doma.in/content/mysite/maincategory/page-with-canonical
 

      for strict rule /content/mysite/specific/page-with-canonical=>/content/mysite/canonical-specific/page-with-canonical
      and resource path /content/mysite/specific/page-with-canonical
      configured publish domain https://doma.in
      canonical path will be  https://doma.in/content/mysite/canonical-specific/page-with-canonical
 

Method Summary

Modifier and Type	Method and Description
String	getCanonicalLink(String resourcePath) Method, which returns canonical link for the given resource path.

Method Detail

getCanonicalLink

String getCanonicalLink(String resourcePath)

Method, which returns canonical link for the given resource path.

Internally, page will be extracted for the provided resource path. Using rules canonical path will be tried to found.

Using Externalizer, path will be converted to the link.

Parameters:

resourcePath - which will be used to get page it is part of

Returns:

canonical link or null