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