com.adobe.aem.wcm.seo.sitemap.PageTreeSitemapGenerator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation
The Adobe Experience Manager SDK
There is a newer version: 2024.11.18751.20241128T090041Z-241100
/*************************************************************************
 *
 * ADOBE CONFIDENTIAL
 * __________________
 *
 *  Copyright 2021 Adobe Systems Incorporated
 *  All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of Adobe Systems Incorporated and its suppliers,
 * if any.  The intellectual and technical concepts contained
 * herein are proprietary to Adobe Systems Incorporated and its
 * suppliers and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe Systems Incorporated.
 **************************************************************************/
package com.adobe.aem.wcm.seo.sitemap;

import java.util.Locale;
import java.util.Map;

import org.apache.sling.api.resource.Resource;
import org.apache.sling.sitemap.spi.generator.SitemapGenerator;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.osgi.annotation.versioning.ProviderType;

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

/**
 * A service that exposes the filters and utility methods the default {@link SitemapGenerator} of for pages uses.
 * 
 * It acts as extension point for a delegation pattern implementation, where another {@link SitemapGenerator} replaces the default one but
 * needs to use some of its functionality anyway.
 */
@ProviderType
public interface PageTreeSitemapGenerator extends SitemapGenerator {

    /**
     * Returns true if the given {@link Resource} should be included.
     *
     * @param resource
     * @return
     * @see org.apache.sling.sitemap.spi.generator.ResourceTreeSitemapGenerator#shouldInclude(Resource)
     */
    boolean shouldInclude(@NotNull Resource resource);

    /**
     * Returns true if the given {@link Resource} should be followed for traversal.
     *
     * @param resource
     * @return
     * @see org.apache.sling.sitemap.spi.generator.ResourceTreeSitemapGenerator#shouldFollow(Resource)
     */
    boolean shouldFollow(@NotNull Resource resource);

    /**
     * Returns the canonical url of a given {@link Page}.
     * 

     * This may be the {@link Page}'s path externalized by the {@link com.adobe.aem.wcm.seo.sitemap.externalizer.SitemapLinkExternalizer}
     * or the canonical url specified by the {@link com.adobe.aem.wcm.seo.SeoTags#PN_CANONICAL_URL} property.
     *
     * @param page
     * @return
     */
    @Nullable
    String getCanonicalUrl(Page page);

    /**
     * Returns a mapping from {@link Locale} to the canonical url for the language alternatives of the given {@link Page}.
     *
     * @param page the {@link Page} get the alternate language links for
     * @return returns the map of alternate language links of the page as it is added to a Sitemap
     */
    @NotNull
    Map getAlternateLanguageLinks(Page page);

    /**
     * Returns {@code true} when the {@link Page} is published.
     * 
     * When called on Publishers, this is always @code true}.
     *
     * @param page the {@link Page} to check
     * @return {@code true} when the page is published, {@code false otherwise}
     * @deprecated use {@link PageTreeSitemapGenerator#shouldInclude(Resource)} instead
     */
    @Deprecated
    boolean isPublished(Page page);

    /**
     * Returns {@code true} when the {@link Page} is set to be not indexed by search engines.
     *
     * @param page the {@link Page} to check
     * @return {@code true} when the page is not to be contained in the Sitemap, {@code false otherwise}
     * @deprecated use {@link PageTreeSitemapGenerator#shouldInclude(Resource)} instead
     */
    @Deprecated
    boolean isNoIndex(Page page);

    /**
     * Returns {@code true} when the {@link Page} has a redirect target.
     *
     * @param page the {@link Page} to check
     * @return {@code true} when the page is a redirect, {@code false otherwise}
     * @deprecated use {@link PageTreeSitemapGenerator#shouldInclude(Resource)} instead
     */
    @Deprecated
    boolean isRedirect(Page page);

    /**
     * Returns {@code true} when the {@link Page} requires authentication.
     *
     * @param page the {@link Page} to check
     * @return {@code true} when the page is a protected by CUG, {@code false otherwise}
     * @deprecated use {@link PageTreeSitemapGenerator#shouldInclude(Resource)} instead
     */
    @Deprecated
    boolean isProtected(Page page);

}