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.business.portlet;
35  
36  import org.apache.commons.lang3.StringUtils;
37  
38  import javax.servlet.http.HttpServletRequest;
39  
40  /**
41   * This class provides definition of methods which be overloaded by classes which inherits the Portlet class
42   */
43  public class PortletImpl extends Portlet
44  {
45      /**
46       * Must be overloaded to return the Portlet Xml code without the heading XML
47       *
48       * @param request
49       *            The HTTP servlet request
50       * @return none
51       */
52      @Override
53      public String getXml( HttpServletRequest request )
54      {
55          return StringUtils.EMPTY;
56      }
57  
58      /**
59       * Must be overloaded to return the complete Xml document (with heading)
60       *
61       * @param request
62       *            The HTTP servlet request
63       * @return none
64       */
65      @Override
66      public String getXmlDocument( HttpServletRequest request )
67      {
68          return StringUtils.EMPTY;
69      }
70  
71      /**
72       * {@inheritDoc}
73       */
74      @Override
75      public void remove( )
76      {
77          // Do nothing
78      }
79  }