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.db;
029
030import org.opencms.file.CmsRequestContext;
031
032/**
033 * This interface defines a factory to create runtime info objects.<p>
034 *
035 * @since 6.0.0
036 */
037public interface I_CmsDbContextFactory {
038
039    /**
040     * Initializes the runtime info factory with the OpenCms driver manager.<p>
041     *
042     * @param driverManager the initialized OpenCms driver manager
043     */
044    void initialize(CmsDriverManager driverManager);
045
046    /**
047     * Returns a new database context based on the given user request context.<p>
048     *
049     * @param context the user request context to initialize the database context with
050     *
051     * @return a new database context based on the given user request context
052     */
053    CmsDbContext getDbContext(CmsRequestContext context);
054
055    /**
056     * Returns a new database context.<p>
057     *
058     * @return a new database context
059     */
060    CmsDbContext getDbContext();
061}