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.chatbot.service;
35  
36  import fr.paris.lutece.plugins.chatbot.service.bot.ChatBot;
37  import fr.paris.lutece.portal.service.spring.SpringContextService;
38  import java.util.ArrayList;
39  import java.util.HashMap;
40  
41  import java.util.List;
42  import java.util.Map;
43  
44  /**
45   * BotService
46   */
47  public final class BotService
48  {
49      private static Map<String, ChatBot> _mapBots = new HashMap<>( );
50  
51      private static boolean _bInitFromContextFiles;
52  
53      /** Private constructor */
54      private BotService( )
55      {
56      }
57  
58      /**
59       * Get all bots
60       * 
61       * @return The bots list
62       */
63      public static List<ChatBot> getBots( )
64      {
65          if ( !_bInitFromContextFiles )
66          {
67              initFromContextFiles( );
68              _bInitFromContextFiles = true;
69          }
70          return new ArrayList<ChatBot>( _mapBots.values( ) );
71      }
72  
73      /**
74       * Register a bot from an other module
75       * 
76       * @param chatbot
77       *            The chatbot to register
78       */
79      public static void register( ChatBot chatbot )
80      {
81          _mapBots.put( chatbot.getKey( ), chatbot );
82      }
83  
84      /**
85       * Unregister a bot
86       * 
87       * @param strChatBotKey
88       *            The chatbot key
89       */
90      public static void unregister( String strChatBotKey )
91      {
92          _mapBots.remove( strChatBotKey );
93      }
94  
95      /**
96       * Get a bot by its key
97       * 
98       * @param strBotKey
99       *            The bot key
100      * @return The bot
101      */
102     public static ChatBot getBot( String strBotKey )
103     {
104         if ( !_bInitFromContextFiles )
105         {
106             initFromContextFiles( );
107             _bInitFromContextFiles = true;
108         }
109         return _mapBots.get( strBotKey );
110     }
111 
112     /**
113      * Init chatbots list from chatbot defined in context files
114      */
115     private static void initFromContextFiles( )
116     {
117         for ( ChatBot chatbot : SpringContextService.getBeansOfType( ChatBot.class ) )
118         {
119             register( chatbot );
120         }
121     }
122 }