1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_sdbc_XDriverManager_idl__ 24cdf0e10cSrcweir#define __com_sun_star_sdbc_XDriverManager_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_beans_PropertyValue_idl__ 31cdf0e10cSrcweir#include <com/sun/star/beans/PropertyValue.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_sdbc_SQLException_idl__ 35cdf0e10cSrcweir#include <com/sun/star/sdbc/SQLException.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir module com { module sun { module star { module sdbc { 39cdf0e10cSrcweir 40cdf0e10cSrcweir published interface XConnection; 41cdf0e10cSrcweir published interface XDriver; 42cdf0e10cSrcweir 43cdf0e10cSrcweir 44cdf0e10cSrcweir/** is the basic interface for managing a set of SDBC drivers. 45cdf0e10cSrcweir 46cdf0e10cSrcweir 47cdf0e10cSrcweir 48cdf0e10cSrcweir <p> 49cdf0e10cSrcweir When the method 50cdf0e10cSrcweir <member scope="com::sun::star::sdbc">XDriverManager::getConnection()</member> 51cdf0e10cSrcweir is called, 52cdf0e10cSrcweir the DriverManager will attempt to 53cdf0e10cSrcweir locate a suitable driver. 54cdf0e10cSrcweir 55cdf0e10cSrcweir </p> 56cdf0e10cSrcweir @see com::sun::star::sdbc::XDriver 57cdf0e10cSrcweir @see com::sun::star::sdbc::XConnection 58cdf0e10cSrcweir */ 59cdf0e10cSrcweirpublished interface XDriverManager: com::sun::star::uno::XInterface 60cdf0e10cSrcweir{ 61cdf0e10cSrcweir //------------------------------------------------------------------------- 62cdf0e10cSrcweir 63cdf0e10cSrcweir /** attempts to establish a connection to the given database URL. 64cdf0e10cSrcweir The DriverManager attempts to select an appropriate driver from 65cdf0e10cSrcweir the set of registered JDBC/SDBC drivers. 66cdf0e10cSrcweir @param url 67cdf0e10cSrcweir a database url of the form sdbc:subprotocol:subname 68cdf0e10cSrcweir @returns 69cdf0e10cSrcweir the Connection object 70cdf0e10cSrcweir @throws SQLException 71cdf0e10cSrcweir if a database access error occurs. 72cdf0e10cSrcweir */ 73cdf0e10cSrcweir XConnection getConnection([in]string url) 74cdf0e10cSrcweir raises (SQLException); 75cdf0e10cSrcweir //------------------------------------------------------------------------- 76cdf0e10cSrcweir 77cdf0e10cSrcweir /** attempts to establish a connection to the given database URL. 78cdf0e10cSrcweir The DriverManager attempts to select an appropriate driver from 79cdf0e10cSrcweir the set of registered JDBC/SDBC drivers. 80cdf0e10cSrcweir @param url 81cdf0e10cSrcweir a database url of the form sdbc:subprotocol:subname 82cdf0e10cSrcweir @param info 83cdf0e10cSrcweir a list of arbitrary string tag/value pairs as connection arguments; 84cdf0e10cSrcweir normally at least a "user" and "password" property should be included 85cdf0e10cSrcweir @see com::sun::star::sdbc::ConnectionProperties 86cdf0e10cSrcweir @returns 87cdf0e10cSrcweir the Connection object 88cdf0e10cSrcweir @throws SQLException 89cdf0e10cSrcweir if a database access error occurs. 90cdf0e10cSrcweir */ 91cdf0e10cSrcweir XConnection getConnectionWithInfo([in]string url, 92cdf0e10cSrcweir [in]sequence<com::sun::star::beans::PropertyValue> info) 93cdf0e10cSrcweir raises (SQLException); 94cdf0e10cSrcweir //------------------------------------------------------------------------- 95cdf0e10cSrcweir 96cdf0e10cSrcweir /** sets the maximum time in seconds that a driver will wait 97cdf0e10cSrcweir while attempting to connect to a database. 98cdf0e10cSrcweir @param seconds 99cdf0e10cSrcweir the login time limit in seconds 100cdf0e10cSrcweir 101cdf0e10cSrcweir @throws SQLException 102cdf0e10cSrcweir if a database access error occurs. 103cdf0e10cSrcweir */ 104cdf0e10cSrcweir void setLoginTimeout([in]long seconds); 105cdf0e10cSrcweir //------------------------------------------------------------------------- 106cdf0e10cSrcweir 107cdf0e10cSrcweir /** gets the maximum time in seconds that a driver can wait 108cdf0e10cSrcweir when attempting to login to a database. 109cdf0e10cSrcweir @returns 110cdf0e10cSrcweir the driver login time limit in seconds 111cdf0e10cSrcweir 112cdf0e10cSrcweir @throws SQLException 113cdf0e10cSrcweir if a database access error occurs. 114cdf0e10cSrcweir */ 115cdf0e10cSrcweir long getLoginTimeout(); 116cdf0e10cSrcweir}; 117cdf0e10cSrcweir 118cdf0e10cSrcweir//============================================================================= 119cdf0e10cSrcweir 120cdf0e10cSrcweir}; }; }; }; 121cdf0e10cSrcweir 122cdf0e10cSrcweir#endif 123