Package org.ametys.web.indexing

Interface SiteIndexer

All Known Implementing Classes:
SolrSiteIndexer
public interface SiteIndexer
Component indexing a Site.

  • Field Details

    • ROLE

      static final String ROLE
      The component role.

  • Method Details

    • indexSite

      void indexSite(Site site) throws IndexingException
      Index a site in all workspaces
      Parameters:
      site - the site to index.
      Throws:
      IndexingException - If an error occurs while indexing the site.

    • indexSite

      void indexSite(String siteName) throws IndexingException
      Index a site in all workspaces
      Parameters:
      siteName - the name of the site to index.
      Throws:
      IndexingException - If an error occurs while indexing the site.

    • indexSite

      void indexSite(String siteName, String workspaceName) throws IndexingException
      Index a site in a specific workspace.
      Parameters:
      siteName - the name of the site to index.
      workspaceName - The workspace name.
      Throws:
      IndexingException - If an error occurs while indexing the site.

    • indexSite

      void indexSite(String siteName, String workspaceName, org.apache.solr.client.solrj.SolrClient solrClient) throws IndexingException
      Index a site in a specific workspace.
      Parameters:
      siteName - the name of the site to index.
      workspaceName - The workspace name.
      solrClient - The solr client to use
      Throws:
      IndexingException - If an error occurs while indexing the site.

    • indexSitemap

      void indexSitemap(Sitemap sitemap) throws IndexingException
      Index a sitemap in all workpaces
      Parameters:
      sitemap - the sitemap to index.
      Throws:
      IndexingException - If an error occurs while indexing the sitemap.

    • indexSitemap

      void indexSitemap(String siteName, String sitemapName) throws IndexingException
      Index a sitemap in all workpaces
      Parameters:
      siteName - the site name.
      sitemapName - the name of the sitemap to index.
      Throws:
      IndexingException - If an error occurs while indexing the sitemap.

    • indexSitemap

      void indexSitemap(String siteName, String sitemapName, String workspaceName) throws IndexingException
      Index a sitemap in a specific workspace.
      Parameters:
      siteName - the site name.
      sitemapName - the name of the sitemap to index.
      workspaceName - The workspace name.
      Throws:
      IndexingException - If an error occurs while indexing the sitemap.

    • unindexSite

      void unindexSite(String siteName, String workspaceName) throws IndexingException
      Unindex a site in a specific workspace.
      Parameters:
      siteName - the name of site to unindex.
      workspaceName - The workspace name.
      Throws:
      IndexingException - If an error occurs while unindexing the site.

    • unindexSite

      void unindexSite(String siteName) throws IndexingException
      Unindex a site in all workspaces
      Parameters:
      siteName - the name of site to unindex.
      Throws:
      IndexingException - If an error occurs while unindexing the site.

    • unindexSitemap

      void unindexSitemap(String siteName, String sitemapName) throws IndexingException
      Unindex a sitemap in all workpaces
      Parameters:
      siteName - the site name.
      sitemapName - the name of the sitemap to index.
      Throws:
      IndexingException - If an error occurs while unindexing the sitemap.

    • unindexSitemap

      void unindexSitemap(String siteName, String sitemapName, String workspaceName) throws IndexingException
      Unindex a sitemap in a specific workspace.
      Parameters:
      siteName - the site name.
      sitemapName - the name of the sitemap to index.
      workspaceName - The workspace name.
      Throws:
      IndexingException - If an error occurs while unindexing the sitemap.