View Javadoc
1   /*
2    * Copyright (c) 2002-2021, 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.plugins.announce.service.search;
35  
36  import fr.paris.lutece.plugins.announce.service.AnnouncePlugin;
37  import fr.paris.lutece.plugins.announce.service.announcesearch.AnnounceSearchService;
38  import fr.paris.lutece.plugins.announce.service.announcesearch.DefaultAnnounceIndexer;
39  import fr.paris.lutece.portal.service.message.SiteMessageException;
40  import fr.paris.lutece.portal.service.search.SearchIndexer;
41  import fr.paris.lutece.portal.service.util.AppPropertiesService;
42  
43  import org.apache.lucene.document.Document;
44  
45  import java.io.IOException;
46  
47  import java.util.ArrayList;
48  import java.util.List;
49  
50  /**
51   * AnnounceIndexer
52   */
53  public class AnnounceIndexer implements SearchIndexer
54  {
55      private static final String INDEXER_NAME = "announce.indexer.name";
56      private static final String INDEXER_DESCRIPTION = "announce.indexer.description";
57      private static final String INDEXER_VERSION = "announce.indexer.version";
58      private static final String PROPERTY_INDEXER_ENABLE = "announce.indexer.enable";
59      private static final String JSP_SEARCH_ANNOUNCE = "jsp/site/Portal.jsp?page=announce";
60  
61      /**
62       * {@inheritDoc}
63       */
64      @Override
65      public List<Document> getDocuments( String strDocument ) throws IOException, InterruptedException, SiteMessageException
66      {
67          return DefaultAnnounceIndexer.getDocuments( strDocument );
68      }
69  
70      /**
71       * {@inheritDoc}
72       */
73      @Override
74      public void indexDocuments( ) throws IOException, InterruptedException, SiteMessageException
75      {
76          AnnounceSearchService.getInstance( ).processIndexing( true );
77          DefaultAnnounceIndexer.getDocuments( "" );
78      }
79  
80      /**
81       * {@inheritDoc}
82       */
83      @Override
84      public String getName( )
85      {
86          return AppPropertiesService.getProperty( INDEXER_NAME );
87      }
88  
89      /**
90       * {@inheritDoc}
91       */
92      @Override
93      public String getVersion( )
94      {
95          return AppPropertiesService.getProperty( INDEXER_VERSION );
96      }
97  
98      /**
99       * {@inheritDoc}
100      */
101     @Override
102     public String getDescription( )
103     {
104         return AppPropertiesService.getProperty( INDEXER_DESCRIPTION );
105     }
106 
107     /**
108      * {@inheritDoc}
109      */
110     @Override
111     public boolean isEnable( )
112     {
113         String strEnable = AppPropertiesService.getProperty( PROPERTY_INDEXER_ENABLE, "true" );
114 
115         return ( strEnable.equalsIgnoreCase( "true" ) );
116     }
117 
118     /**
119      * {@inheritDoc}
120      */
121     @Override
122     public List<String> getListType( )
123     {
124         List<String> listType = new ArrayList<>( );
125         listType.add( AnnouncePlugin.PLUGIN_NAME );
126 
127         return listType;
128     }
129 
130     /**
131      * {@inheritDoc}
132      */
133     @Override
134     public String getSpecificSearchAppUrl( )
135     {
136         return JSP_SEARCH_ANNOUNCE;
137     }
138 }