oracle.jdeveloper.db

Class DatabaseConnectionEditor

java.lang.Object

oracle.jdeveloper.db.DatabaseConnectionEditor

public final class DatabaseConnectionEditor
extends java.lang.Object

Launcher for the database connection editor. Call editConnection() to launch the dialog for editing connections, optionally specifying the name of the connection to initially select in the editor.

For full control over the editor, call createLauncher() to get a launcher which can then be customised before launching the actual dialog.

Use AppDatabaseConnectionEditor to create/edit an application's connections

Since:

11

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DatabaseConnectionEditor.ConnectionEditor Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
static DatabaseConnectionEditorLauncher	createLauncher() Creates a new launcher for the database connection create/edit dialog.
static ConnectionInfo	editConnection(ConnectionInfo info, boolean allowAllStores) Launches the connection editor.
static java.lang.String	editConnection(java.lang.String connName) Deprecated. use editConnection(String,String)
static java.lang.String	editConnection(java.lang.String storeName, java.lang.String connName) Launches the connection editor.
static java.lang.String	editConnection(java.lang.String storeName, java.lang.String connName, boolean allowAllStores) Launches the connection editor.
static void	setEditor(java.lang.Class<? extends DatabaseConnectionEditor.ConnectionEditor> ed) Deprecated. - use setLauncher(java.lang.Class<? extends oracle.jdeveloper.db.DatabaseConnectionEditorLauncher>), the new launcher class is more powerful as it can return the chosen store and connection name together, and is also more flexible for change (abstract class rather than an interface).
static void	setLauncher(java.lang.Class<? extends DatabaseConnectionEditorLauncher> clz) Deprecated. use extension.xml hook (see above).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setEditor

@Deprecated
public static void setEditor(java.lang.Class<? extends DatabaseConnectionEditor.ConnectionEditor> ed)

Deprecated. - use setLauncher(java.lang.Class<? extends oracle.jdeveloper.db.DatabaseConnectionEditorLauncher>), the new launcher class is more powerful as it can return the chosen store and connection name together, and is also more flexible for change (abstract class rather than an interface).

setLauncher

@Deprecated
public static void setLauncher(java.lang.Class<? extends DatabaseConnectionEditorLauncher> clz)

Deprecated. use extension.xml hook (see above).

Sets the launcher class. There is a default implementation for editing connections but this allows that to be overridden. This method will not work in JDeveloper itself, as the default connection editor for JDeveloper cannot be changed.

This method has been deprecated in favour of the following extension.xml hook:

   <database-connection-hook xmlns="http://xmlns.oracle.com/ide/db/extension">
     <connection-editor-launcher>com.example.MyEditLauncher</connection-editor-launcher>
   </database-connection-hook>
 

Parameters:

clz -

createLauncher

public static DatabaseConnectionEditorLauncher createLauncher()

Creates a new launcher for the database connection create/edit dialog.

Returns:

a new launcher instance

editConnection

@Deprecated
public static java.lang.String editConnection(java.lang.String connName)

Deprecated. use editConnection(String,String)

Launches the connection editor (connection store will be worked out from the Context).

Parameters:

connName - name of the connection to edit, or null to prompt the user to create a new connection.

editConnection

public static java.lang.String editConnection(java.lang.String storeName,
                              java.lang.String connName)

Launches the connection editor. Use AppDatabaseConnectionEditor to create/edit an application's connections

Parameters:

storeName - the store of connections the connection will be edited in. If null, the store will be worked out from the context, but then there is the potential for the store to be unknown for a created connection as only the name is returned.

connName - name of the connection to edit, or null to prompt the user to create a new connection.

Returns:

the name of the newly created (or edited) connection. The store is implied to be the store passed in.

editConnection

public static java.lang.String editConnection(java.lang.String storeName,
                              java.lang.String connName,
                              boolean allowAllStores)

Launches the connection editor.

Parameters:

storeName - the store of connections the connection will be edited in.

connName - name of the connection to edit, or null to prompt the user to create a new connection.

allowAllStores - used for features that are centric to the database navigator and not application based. if true the user gets a choice of all available connection stores.

Returns:

the name of the newly created (or edited) connection.

editConnection

public static ConnectionInfo editConnection(ConnectionInfo info,
                            boolean allowAllStores)

Launches the connection editor.

Parameters:

info - store/conection name of the connection to edit, or null to prompt the user to create a new connection. The info can have a store but no name to default the creation to a specific store.

allowAllStores - used for features that are centric to the database navigator and not application based. if true the user gets a choice of all available connection stores.

Returns:

the information for the newly created (or edited) connection.