I_CmsLoaderIncludeExtension


1   /*
2    * File   : $Source: /usr/local/cvs/opencms/src/org/opencms/loader/I_CmsLoaderIncludeExtension.java,v $
3    * Date   : $Date: 2005/06/23 11:11:28 $
4    * Version: $Revision: 1.6 $
5    *
6    * This library is part of OpenCms -
7    * the Open Source Content Mananagement System
8    *
9    * Copyright (c) 2005 Alkacon Software GmbH (http://www.alkacon.com)
10   *
11   * This library is free software; you can redistribute it and/or
12   * modify it under the terms of the GNU Lesser General Public
13   * License as published by the Free Software Foundation; either
14   * version 2.1 of the License, or (at your option) any later version.
15   *
16   * This library is distributed in the hope that it will be useful,
17   * but WITHOUT ANY WARRANTY; without even the implied warranty of
18   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19   * Lesser General Public License for more details.
20   *
21   * For further information about Alkacon Software GmbH, please see the
22   * company website: http://www.alkacon.com
23   *
24   * For further information about OpenCms, please see the
25   * project website: http://www.opencms.org
26   * 
27   * You should have received a copy of the GNU Lesser General Public
28   * License along with this library; if not, write to the Free Software
29   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
30   */
31  
32  package org.opencms.loader;
33  
34  import org.opencms.main.CmsException;
35  
36  import java.util.Map  ;
37  
38  import javax.servlet.ServletRequest  ;
39  import javax.servlet.ServletResponse  ;
40  
41  /**
42   * Allows extensions to the default include mechanism, 
43   * these might be required for the handling of special resource types.<p>
44   *
45   * @author Alexander Kandzior 
46   * 
47   * @version $Revision: 1.6 $ 
48   * 
49   * @since 6.0.0 
50   * 
51   * @see org.opencms.jsp.CmsJspTagInclude#includeTagAction(javax.servlet.jsp.PageContext, String, String, boolean, Map, ServletRequest, ServletResponse)
52   */
53  public interface I_CmsLoaderIncludeExtension {
54  
55      /**
56       * The extension method for the include tag action.<p>
57       * 
58       * @param target the target for the include, might be <code>null</code>
59       * @param element the element to select form the target might be <code>null</code>
60       * @param editable the flag to indicate if the target is editable
61       * @param paramMap a map of parameters for the include, can be modified, might be <code>null</code>
62       * @param req the current request
63       * @param res the current response
64       * @throws CmsException in case something goes wrong
65       * @return the modified target URI
66       */
67      String   includeExtension(
68          String   target,
69          String   element,
70          boolean editable,
71          Map   paramMap,
72          ServletRequest   req,
73          ServletResponse   res) throws CmsException;
74  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags