99 lines
3.3 KiB
Text
99 lines
3.3 KiB
Text
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed
|
|
* with this work for additional information regarding copyright
|
|
* ownership. The ASF licenses this file to you under the Apache
|
|
* License, Version 2.0 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
|
|
*/
|
|
|
|
module com { module sun { module star { module sdbc {
|
|
|
|
published interface XConnection;
|
|
published interface XDriver;
|
|
|
|
|
|
/** is the basic interface for managing a set of SDBC drivers.
|
|
|
|
|
|
|
|
<p>
|
|
When the method
|
|
com::sun::star::sdbc::XDriverManager::getConnection()
|
|
is called,
|
|
the DriverManager will attempt to
|
|
locate a suitable driver.
|
|
|
|
</p>
|
|
@see com::sun::star::sdbc::XDriver
|
|
@see com::sun::star::sdbc::XConnection
|
|
*/
|
|
published interface XDriverManager: com::sun::star::uno::XInterface
|
|
{
|
|
|
|
/** attempts to establish a connection to the given database URL.
|
|
The DriverManager attempts to select an appropriate driver from
|
|
the set of registered JDBC/SDBC drivers.
|
|
@param url
|
|
a database url of the form sdbc:subprotocol:subname
|
|
@returns
|
|
the Connection object
|
|
@throws SQLException
|
|
if a database access error occurs.
|
|
*/
|
|
XConnection getConnection([in]string url)
|
|
raises (SQLException);
|
|
|
|
/** attempts to establish a connection to the given database URL.
|
|
The DriverManager attempts to select an appropriate driver from
|
|
the set of registered JDBC/SDBC drivers.
|
|
@param url
|
|
a database url of the form sdbc:subprotocol:subname
|
|
@param info
|
|
a list of arbitrary string tag/value pairs as connection arguments;
|
|
normally at least a "user" and "password" property should be included
|
|
@see com::sun::star::sdbc::ConnectionProperties
|
|
@returns
|
|
the Connection object
|
|
@throws SQLException
|
|
if a database access error occurs.
|
|
*/
|
|
XConnection getConnectionWithInfo([in]string url,
|
|
[in]sequence<com::sun::star::beans::PropertyValue> info)
|
|
raises (SQLException);
|
|
|
|
/** sets the maximum time in seconds that a driver will wait
|
|
while attempting to connect to a database.
|
|
@param seconds
|
|
the login time limit in seconds
|
|
|
|
@throws SQLException
|
|
if a database access error occurs.
|
|
*/
|
|
void setLoginTimeout([in]long seconds);
|
|
|
|
/** gets the maximum time in seconds that a driver can wait
|
|
when attempting to login to a database.
|
|
@returns
|
|
the driver login time limit in seconds
|
|
|
|
@throws SQLException
|
|
if a database access error occurs.
|
|
*/
|
|
long getLoginTimeout();
|
|
};
|
|
|
|
|
|
}; }; }; };
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|