KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > opencms > i18n > I_CmsLocaleHandler


1 /*
2  * File : $Source: /usr/local/cvs/opencms/src/org/opencms/i18n/I_CmsLocaleHandler.java,v $
3  * Date : $Date: 2005/06/26 12:23:30 $
4  * Version: $Revision: 1.15 $
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.i18n;
33
34 import org.opencms.file.CmsObject;
35 import org.opencms.file.CmsProject;
36 import org.opencms.file.CmsUser;
37
38 import javax.servlet.http.HttpServletRequest JavaDoc;
39
40 /**
41  * A locale handler returns the locale name to use for the given request context.<p>
42  *
43  * By implementing this interface, and configuring OpenCms
44  * accordingly, the behaviour for the m_locale selection can be fine-tuned
45  * to the exact need of the OpenCms installation.<p>
46  *
47  * @author Carsten Weinholz
48  *
49  * @version $Revision: 1.15 $
50  *
51  * @since 6.0.0
52  */
53 public interface I_CmsLocaleHandler {
54
55     /**
56      * Returns the i18n information to use in the request context.<p>
57      *
58      * @param req the current http request
59      * @param user the current user
60      * @param project the current project
61      * @param resource the URI of the requested resource (with full site root added)
62      *
63      * @return the i18n information to use for the given request context
64      */
65     CmsI18nInfo getI18nInfo(HttpServletRequest JavaDoc req, CmsUser user, CmsProject project, String JavaDoc resource);
66
67     /**
68      * Will be called during system startup.<p>
69      *
70      * @param cms an initialized cms permission context for VFS access
71      */
72     void initHandler(CmsObject cms);
73 }
74
Popular Tags