blob: b60a7219d13e4937a9184551823649a486fecb6d [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 1998, 2012 Oracle. All rights reserved.
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
* which accompanies this distribution.
* The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
* and the Eclipse Distribution License is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* Contributors:
* Oracle - initial API and implementation from Oracle TopLink
******************************************************************************/
package org.eclipse.persistence.tools.db.relational.spi;
import java.sql.Connection;
/**
* Simple factory interface for building external databases.
* <p>
* Provisional API: This interface is part of an interim API that is still under development and
* expected to change significantly before reaching stability. It is available at this early stage
* to solicit feedback from pioneering adopters on the understanding that any code that uses this
* API will almost certainly be broken (repeatedly) as the API evolves.<p>
*
* @version 2.6
*/
public interface ExternalDatabaseFactory {
/**
* Returns an {@link ExternalDatabase} for the specified connection. The connection will be <code>null</code>
* if a connection to a database has not been established or is inappropriate. The connection can
* be ignored, as appropriate.
*/
ExternalDatabase buildDatabase(Connection connection);
}