View Javadoc
1   /*
2    * Copyright (c) 2002-2019, 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.botpress.service;
35  
36  import fr.paris.lutece.plugins.botpress.business.BPBot;
37  import fr.paris.lutece.plugins.chatbot.business.BotPost;
38  import fr.paris.lutece.plugins.chatbot.service.bot.AbstractChatBot;
39  import java.util.ArrayList;
40  import java.util.List;
41  import java.util.Locale;
42  
43  /**
44   * BotInstance
45   */
46  public final class BotInstance extends AbstractChatBot
47  {
48      // Variables declarations
49  
50      private String _strBotApiEntryPointUrl;
51      private String _strErrorMessage;
52  
53      /**
54       * Constructor
55       * 
56       * @param bot
57       *            The BotPress bot
58       */
59      public BotInstance( BPBot bot )
60      {
61          super( );
62  
63          setKey( bot.getBotKey( ) );
64          setName( bot.getName( ) );
65          setDescription( bot.getDescription( ) );
66          List listLanguages = new ArrayList<>( );
67          listLanguages.add( bot.getLanguage( ) );
68          setListAvailableLanguages( listLanguages );
69          setAvatarUrl( bot.getAvatarUrl( ) );
70          setStandalone( bot.getIsStandalone( ) != 0 );
71          setWelcomeMessage( bot.getWelcomeMessage( ) );
72          setAvatarRendererKey( bot.getAvatarRendererKey( ) );
73          _strBotApiEntryPointUrl = ConverseService.getBotApiEntryPointUrl( bot.getBotPressKey( ), bot.getServerUrl( ), bot.getApiVersion( ) );
74          _strErrorMessage = bot.getErrorMessage( );
75  
76      }
77  
78      /**
79       * Returns the BotApiEntryPointUrl
80       *
81       * @return The BotApiEntryPointUrl
82       */
83      public String getBotApiEntryPointUrl( )
84      {
85          return _strBotApiEntryPointUrl;
86      }
87  
88      /**
89       * Sets the BotApiEntryPointUrl
90       *
91       * @param strBotApiEntryPointUrl
92       *            The BotApiEntryPointUrl
93       */
94      public void setBotApiEntryPointUrl( String strBotApiEntryPointUrl )
95      {
96          _strBotApiEntryPointUrl = strBotApiEntryPointUrl;
97      }
98  
99      /**
100      * {@inheritDoc }
101      */
102     @Override
103     public List<BotPost> processUserMessage( String strMessage, String strConversationId, Locale locale )
104     {
105         return ConverseService.getBotResponse( strMessage, strConversationId, _strBotApiEntryPointUrl, _strErrorMessage, locale );
106     }
107 
108     /**
109      * Reset the conversation
110      *
111      * @param strConversationId
112      *            The conversation ID
113      */
114     @Override
115     public void reset( String strConversationId )
116     {
117 
118     }
119 
120 }