001/*
002 *  Copyright 2016 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.cms.indexing.solr;
017
018import org.apache.solr.client.solrj.SolrClient;
019
020import org.ametys.cms.indexing.IndexingException;
021
022/**
023 * Provides additional documents when indexing a workspace.
024 */
025public interface DocumentProvider
026{
027    
028    /**
029     * Index additional documents for the given workspace.
030     * @param workspaceName The workspace name.
031     * @param solrClient The solr client to use
032     * @throws IndexingException If an error occurs indexing the documents.
033     */
034    void indexDocuments(String workspaceName, SolrClient solrClient) throws IndexingException;
035    
036}