Package org.apache.sling.sitemap

Interface SitemapGeneratorManager

@ProviderType public interface SitemapGeneratorManager
A service that manages all registered SitemapGenerator services.

  • Method Details

    • getNames

      Set<String> getNames(@NotNull @NotNull Resource sitemapRoot)
      Returns all names of all SitemapGenerators for the given sitemap root.
      Parameters:
      sitemapRoot -
      Returns:

    • getOnDemandNames

      @NotNull @NotNull Set<String> getOnDemandNames(@NotNull @NotNull Resource sitemapRoot)
      Returns all names of all SitemapGenerators for the given sitemap root, limited to those that are configured to be served on demand.
      Parameters:
      sitemapRoot -
      Returns:

    • getGenerator

      @Nullable @Nullable SitemapGenerator getGenerator(@NotNull @NotNull Resource sitemapRoot, @NotNull @NotNull String name)
      Returns the SitemapGenerator for the given sitemap root Resource and name. This may be null when no SitemapGenerator service exists that generates a sitemap with the name for the given root.
      Parameters:
      sitemapRoot -
      name -
      Returns:

    • getGenerators

      @NotNull @NotNull Map<String,SitemapGenerator> getGenerators(@NotNull @NotNull Resource sitemapRoot)
      Returns a Map of SitemapGenerators for each name returned by getNames(Resource).
      Parameters:
      sitemapRoot -
      Returns: