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
35 package fr.paris.lutece.plugins.botpress.service.renderers;
36
37 import com.fasterxml.jackson.databind.JsonNode;
38 import java.util.List;
39 import java.util.Map;
40
41 /**
42 * BotMessageRenderer
43 */
44 public interface BotMessageRenderer
45 {
46 final String FIELD_TYPE = "type";
47 final String TYPE_TEXT = "text";
48 final String TYPE_FILE = "file";
49 final String FIELD_TEXT = "text";
50 final String FIELD_URL = "url";
51
52 /**
53 * Analyze the response node to tell if this renderer should be invoked
54 *
55 * @param nodeResponse
56 * The response node
57 * @return true if the renderer should handle the response format otherwise false
58 */
59 boolean isInvoked( JsonNode nodeResponse );
60
61 /**
62 * Render a JSON response as HTML
63 *
64 * @param map
65 * The map corresponding to the JSON response
66 * @return The rendered HTML
67 */
68 String render( Map map );
69
70 /**
71 * Return the content type corresponding to this renderer
72 *
73 * @return The content type
74 */
75 String getPostContentType( );
76
77 /**
78 * Define a list of converters used by the renderer
79 *
80 * @param listConverters
81 * The list of converters
82 */
83 void setConverters( List<Converter> listConverters );
84
85 /**
86 * Returns the list of converters
87 *
88 * @return converters
89 */
90 List<Converter> getConverters( );
91
92 }