001/*
002 *  Copyright 2010 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.web.indexing.solr;
017
018import org.apache.solr.client.solrj.SolrClient;
019
020import org.ametys.web.repository.site.Site;
021import org.ametys.web.repository.sitemap.Sitemap;
022
023/**
024 * Additional indexed documents provider.<br>
025 * The goal is to provide documents which are not pages and
026 * needs to be indexed into order to be search.
027 */
028public interface SiteDocumentProvider
029{
030    
031    /**
032     * Add documents to the index.
033     * @param site the site to index.
034     * @param solrClient The solr client to use
035     * @throws Exception if an error occurs.
036     */
037    void indexSiteDocuments(Site site, SolrClient solrClient) throws Exception;
038    
039    /**
040     * Add documents to the index.
041     * @param sitemap the sitemap to index.
042     * @param solrClient The solr client to use
043     * @throws Exception if an error occurs.
044     */
045    void indexSitemapDocuments(Sitemap sitemap, SolrClient solrClient) throws Exception;
046    
047}