View Javadoc
1   /*
2    * Copyright (c) 2002-2017, Mairie de 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.recastbots.service;
35  
36  import fr.paris.lutece.plugins.chatbot.service.BotService;
37  import fr.paris.lutece.plugins.chatbot.service.bot.ChatBot;
38  import fr.paris.lutece.plugins.recastbots.business.RecastBot;
39  import fr.paris.lutece.plugins.recastbots.business.RecastBotHome;
40  import fr.paris.lutece.portal.service.i18n.I18nService;
41  import fr.paris.lutece.util.ReferenceList;
42  import java.util.Locale;
43  
44  /**
45   * BotRegistrationService
46   */
47  public class BotRegistrationService
48  {
49  
50      private static final String MESSAGE_STATUS_ENABLED = "recastbots.bot_status.enabled";
51      private static final String MESSAGE_STATUS_DISABLED = "recastbots.bot_status.disabled";
52      private static final String MESSAGE_MODE_STANDARD = "recastbots.mode.standard";
53      private static final String MESSAGE_MODE_STANDALONE = "recastbots.mode.standalone";
54  
55      private static final int STATUS_ENABLED = 1;
56      private static final int STATUS_DISABLED = 0;
57      private static final int MODE_STANDARD = 0;
58      private static final int MODE_STANDALONE = 1;
59  
60      private static ReferenceList _listStatus;
61  
62      /**
63       * Register all bots
64       */
65      public static void registerAllBots( )
66      {
67          for ( RecastBot bot : RecastBotHome.getRecastBotsList( ) )
68          {
69              ChatBot chatbot = new BotInstance( bot );
70              BotService.register( chatbot );
71          }
72      }
73  
74      /**
75       * Returns the list of available bot status
76       *
77       * @param locale
78       *            The locale
79       * @return The list
80       */
81      public static ReferenceList getBotsStatusList( Locale locale )
82      {
83          if ( _listStatus == null )
84          {
85              _listStatus = new ReferenceList( );
86              _listStatus.addItem( STATUS_DISABLED, I18nService.getLocalizedString( MESSAGE_STATUS_DISABLED, locale ) );
87              _listStatus.addItem( STATUS_ENABLED, I18nService.getLocalizedString( MESSAGE_STATUS_ENABLED, locale ) );
88          }
89          return _listStatus;
90      }
91  
92      /**
93       * Register the bot
94       * 
95       * @param botInstance
96       *            The bot instance
97       * @param nStatus
98       *            The status
99       */
100     public static void register( BotInstance botInstance, int nStatus )
101     {
102         if ( nStatus == STATUS_ENABLED )
103         {
104             BotService.register( botInstance );
105         }
106     }
107 
108     /**
109      * Un register the bot
110      * 
111      * @param strBotKey
112      *            The bot key
113      */
114     public static void unregister( String strBotKey )
115     {
116         BotService.unregister( strBotKey );
117     }
118 
119     public static ReferenceList getModes( Locale locale )
120     {
121         ReferenceList list = new ReferenceList( );
122 
123         list.addItem( MODE_STANDARD, I18nService.getLocalizedString( MESSAGE_MODE_STANDARD, locale ) );
124         list.addItem( MODE_STANDALONE, I18nService.getLocalizedString( MESSAGE_MODE_STANDALONE, locale ) );
125 
126         return list;
127     }
128 }