I_CmsDriver


1   /*
2    * File   : $Source: /usr/local/cvs/opencms/src/org/opencms/db/I_CmsDriver.java,v $
3    * Date   : $Date: 2005/06/26 12:47:05 $
4    * Version: $Revision: 1.14 $
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.db;
33  
34  import org.opencms.configuration.CmsConfigurationManager;
35  import org.opencms.main.CmsException;
36  
37  import java.util.List  ;
38  
39  /**
40   * Generic base driver interface.<p>
41   * 
42   * @author Carsten Weinholz 
43   * 
44   * @version $Revision: 1.14 $
45   * 
46   * @since 6.0.0
47   */
48  public interface I_CmsDriver {
49  
50      /**
51       * Initializes the driver.<p>
52       * 
53       * @param dbc the current database context
54       * @param configurationManager the configuration manager
55       * @param successiveDrivers a list of successive drivers to be initialized
56       * @param driverManager the initialized OpenCms driver manager
57       * 
58       * @throws CmsException if something goes wrong
59       */
60      void init(
61          CmsDbContext dbc,
62          CmsConfigurationManager configurationManager,
63          List   successiveDrivers,
64          CmsDriverManager driverManager) throws CmsException;
65  
66      /**
67       * Returns information about the driver.<p>
68       * 
69       * @return an information string
70       */
71      String   toString();
72  
73  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags