1 /*
2 * Copyright (c) 2002-2022, City of Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.portal.service.search;
35
36 import fr.paris.lutece.portal.service.message.SiteMessageException;
37
38 import org.apache.lucene.document.Document;
39
40 import java.io.IOException;
41
42 import java.util.List;
43
44 /**
45 * Interface of pluggable indexer. An Indexer can add documents to the main Lucene index.
46 */
47 public interface SearchIndexer
48 {
49 /**
50 * Index all lucene documents from the plugin, replace List<Document> getDocuments( ) method
51 *
52 * @throws IOException
53 * If an IO error occured
54 * @throws InterruptedException
55 * If a thread error occured
56 * @throws SiteMessageException
57 * occurs when a site message need to be displayed
58 */
59 void indexDocuments( ) throws IOException, InterruptedException, SiteMessageException;
60
61 /**
62 * Returns a List of lucene documents to add to the index
63 *
64 * @param strIdDocument
65 * document id
66 * @return A List of lucene documents to add to the index
67 * @throws IOException
68 * If an IO error occured
69 * @throws InterruptedException
70 * If a thread error occured
71 * @throws SiteMessageException
72 * occurs when a site message need to be displayed
73 */
74 List<Document> getDocuments( String strIdDocument ) throws IOException, InterruptedException, SiteMessageException;
75
76 /**
77 * Returns the indexer service name
78 *
79 * @return the indexer service name
80 */
81 String getName( );
82
83 /**
84 * Returns the indexer service version
85 *
86 * @return the indexer service version
87 */
88 String getVersion( );
89
90 /**
91 * Returns the indexer service description
92 *
93 * @return the indexer service description
94 */
95 String getDescription( );
96
97 /**
98 * Tells whether the service is enable or not
99 *
100 * @return true if enable, otherwise false
101 */
102 boolean isEnable( );
103
104 /**
105 * Returns all the {@link fr.paris.lutece.portal.service.search.SearchItem#FIELD_TYPE types} of document the service may index. (See
106 * {@link fr.paris.lutece.portal.service.search.SearchItem#getType()})
107 *
108 * @return The list
109 */
110 List<String> getListType( );
111
112 /**
113 * Returns the search app dedicated to the documents indexed by the service
114 *
115 * @return the url of the app page
116 */
117 String getSpecificSearchAppUrl( );
118 }