001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software GmbH & Co. KG, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.i18n;
029
030import org.opencms.file.CmsObject;
031import org.opencms.file.CmsProject;
032import org.opencms.file.CmsUser;
033
034import javax.servlet.http.HttpServletRequest;
035
036/**
037 * A locale handler returns the locale name to use for the given request context.<p>
038 *
039 * By implementing this interface, and configuring OpenCms
040 * accordingly, the behaviour for the m_locale selection can be fine-tuned
041 * to the exact need of the OpenCms installation.<p>
042 *
043 * @since 6.0.0
044 */
045public interface I_CmsLocaleHandler {
046
047    /**
048     * Returns the i18n information to use in the request context.<p>
049     *
050     * @param req the current http request
051     * @param user the current user
052     * @param project the current project
053     * @param resource the URI of the requested resource (with full site root added)
054     *
055     * @return the i18n information to use for the given request context
056     */
057    CmsI18nInfo getI18nInfo(HttpServletRequest req, CmsUser user, CmsProject project, String resource);
058
059    /**
060     * Will be called during system startup.<p>
061     *
062     * @param cms an initialized cms permission context for VFS access
063     */
064    void initHandler(CmsObject cms);
065}