I_CmsResourceInit


1   /*
2    * File   : $Source: /usr/local/cvs/opencms/src/org/opencms/main/I_CmsResourceInit.java,v $
3    * Date   : $Date: 2005/06/23 11:11:38 $
4    * Version: $Revision: 1.9 $
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.main;
33  
34  import org.opencms.file.CmsObject;
35  import org.opencms.file.CmsResource;
36  
37  import javax.servlet.http.HttpServletRequest  ;
38  import javax.servlet.http.HttpServletResponse  ;
39  
40  /**
41   * This interface checks the requested resource from the OpenCms request context
42   * and returns it to the calling method, which will usually be 
43   * OpenCms.initResource(cms).<p>
44   * 
45   * @author  Andreas Zahner 
46   * 
47   * @version $Revision: 1.9 $ 
48   * 
49   * @since 6.0.0 
50   */
51  public interface I_CmsResourceInit {
52  
53      /**
54       * Possibility to modify or change the CmsFile with the CmsObject.<p>
55       * 
56       * @param resource the requested file
57       * @param cms the current CmsObject
58       * @param req the current request
59       * @param res the current response
60       * @return a resource in the OpenCms VFS
61       * @throws CmsResourceInitException if other implementations of the interface should not be executed
62       */
63      CmsResource initResource(CmsResource resource, CmsObject cms, HttpServletRequest   req, HttpServletResponse   res)
64      throws CmsResourceInitException;
65  
66  }
67
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags