1 /*
2 * Copyright (c) 2002-2014, 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.portal.service.content;
35
36 import fr.paris.lutece.portal.service.cache.AbstractCacheableService;
37 import fr.paris.lutece.portal.service.message.SiteMessageException;
38 import fr.paris.lutece.portal.service.security.UserNotSignedException;
39
40 import javax.servlet.http.HttpServletRequest;
41
42
43 /**
44 * Interface for pages provider services.
45 */
46 public abstract class ContentService extends AbstractCacheableService
47 {
48 private String _strPluginName;
49
50 /**
51 * Returns the HTML (or XML) code for a page for a given mode. The Service should use request parameters to
52 * identify the page content to provide.
53 *
54 * @param request The HTTP request containing content parameters
55 * @param nMode The current mode.
56 * @return The HTML (or XML) code of the page.
57 * @throws UserNotSignedException the UserNotSignedException
58 * @throws SiteMessageException occurs when a site message need to be displayed
59 */
60 public abstract String getPage( HttpServletRequest request, int nMode )
61 throws UserNotSignedException, SiteMessageException;
62
63 /**
64 * Analyzes request's parameters to see if the request should be handled by the current Content Service
65 *
66 * @param request The HTTP request
67 * @return true if this ContentService should handle this request
68 */
69 public abstract boolean isInvoked( HttpServletRequest request );
70
71 /**
72 * Return the name of the plugin
73 *
74 * @return The name of the plugin
75 */
76 public String getPluginName( )
77 {
78 return _strPluginName;
79 }
80
81 /**
82 * Set the plugin name of the content service
83 *
84 * @param strPluginName the plugin name
85 */
86 public void setPluginName( String strPluginName )
87 {
88 _strPluginName = strPluginName;
89 }
90 }