org.eclipse.jpt.jpa.db
Interface ConnectionProfileFactory

public interface ConnectionProfileFactory

Database connection profile factory

To retrieve the connection profile factory corresponding to an Eclipse workspace:

 IWorkspace workspace = ResourcesPlugin.getWorkspace();
 ConnectionProfileFactory factory = (ConnectionProfileFactory) workspace.getAdapter(ConnectionProfileFactory.class);
 

See org.eclipse.jpt.jpa.db/plugin.xml:org.eclipse.core.runtime.adapters.

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.

Method Summary

void	addConnectionProfileListener(ConnectionProfileListener listener) Add a listener that will be notified of changes to the DTP connection profiles.
ConnectionProfile	buildConnectionProfile(String name) Build and return a connection profile that wraps the DTP connection profile with the specified name.
ConnectionProfile	buildConnectionProfile(String name, DatabaseIdentifierAdapter adapter) Build and return a connection profile that wraps the DTP connection profile with the specified name.
IClasspathContainer	buildDriverClasspathContainer(String driverName) Build a Java classpath container for the specified driver.
Iterable<String>	getConnectionProfileNames() Return the names of the DTP connection profiles the factory can wrap with new connection profiles.
IWorkspace	getWorkspace() Return the factory's workspace.
void	removeConnectionProfileListener(ConnectionProfileListener listener) Remove the specified listener.

Method Detail

getWorkspace

IWorkspace getWorkspace()

Return the factory's workspace.

getConnectionProfileNames

Iterable<String> getConnectionProfileNames()

Return the names of the DTP connection profiles the factory can wrap with new connection profiles.

buildConnectionProfile

ConnectionProfile buildConnectionProfile(String name,
                                         DatabaseIdentifierAdapter adapter)

Build and return a connection profile that wraps the DTP connection profile with the specified name. Return null if there is no DTP connection profile with the specified name. Use the specified database identifier adapter to allow clients to control how database identifiers are handled.

buildConnectionProfile

ConnectionProfile buildConnectionProfile(String name)

Build and return a connection profile that wraps the DTP connection profile with the specified name. Return null if there is no DTP connection profile with the specified name.

Clients should use this method when a JPA platform is unavailable (e.g. during project creation). The returned connection profile will use the default database identifier adapter.

buildDriverClasspathContainer

IClasspathContainer buildDriverClasspathContainer(String driverName)

Build a Java classpath container for the specified driver.

See Also:

ConnectionProfile.getDriverName()

addConnectionProfileListener

void addConnectionProfileListener(ConnectionProfileListener listener)

Add a listener that will be notified of changes to the DTP connection profiles.

removeConnectionProfileListener

void removeConnectionProfileListener(ConnectionProfileListener listener)

Remove the specified listener.