oracle.jdeveloper.db

Class DatabaseConnectionsListener

java.lang.Object

oracle.jdeveloper.db.DatabaseConnectionsListener

All Implemented Interfaces:

ConnectionsListener, DisconnectListener

public abstract class DatabaseConnectionsListener
extends java.lang.Object
implements ConnectionsListener, DisconnectListener

Listener class that can be registered with a DatabaseConnections instance to be notified of all connection operations. This combines ConnectionsListener (for add/remove/update events on the connection definitions) and DisconnectListener (for disconnect notification). It also includes a connect notification.

The listener methods are not abstract, so a subclass can override just the methods they are interested in.

Since:

12

See Also:

DatabaseConnections

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DatabaseConnectionsListener.ConnectionType Used to distinguish types of "connection connected" events for any Connection created through the API.

Constructor Summary

Constructors

Constructor and Description
DatabaseConnectionsListener()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canDisconnect(ConnectionsEvent event) This allows a listener to veto a disconnect by returning false.
void	connectionAdded(ConnectionsEvent event) Called when a connection has been added.
void	connectionConnected(ConnectionsEvent event, DatabaseConnectionsListener.ConnectionType type) This is called when a connection definition is successfully used to create a Connection to the database.
void	connectionDisconnected(ConnectionsEvent event) This is called on all listeners after a successful disconnect of the connection.
void	connectionRemoved(ConnectionsEvent event) Called when a connection has been removed.
void	connectionUpdated(ConnectionsEvent event) Called when a connection has been updated.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseConnectionsListener

public DatabaseConnectionsListener()

Method Detail

connectionAdded

public void connectionAdded(ConnectionsEvent event)

Description copied from interface: ConnectionsListener

Called when a connection has been added.

Specified by:

connectionAdded in interface ConnectionsListener

connectionRemoved

public void connectionRemoved(ConnectionsEvent event)

Description copied from interface: ConnectionsListener

Called when a connection has been removed.

Specified by:

connectionRemoved in interface ConnectionsListener

connectionUpdated

public void connectionUpdated(ConnectionsEvent event)

Description copied from interface: ConnectionsListener

Called when a connection has been updated.

Specified by:

connectionUpdated in interface ConnectionsListener

canDisconnect

public boolean canDisconnect(ConnectionsEvent event)

Description copied from interface: DisconnectListener

This allows a listener to veto a disconnect by returning false. As a result of a veto the API will just stop the operation. It will not prompt the user in any way. Before returning false it is the listener's job to make sure the user has explicitly requested a block on this disconnect (e.g. because they're debugging and want to continue).

Specified by:

canDisconnect in interface DisconnectListener

Parameters:

event - the connection event describing the connection to be disconnected.

connectionDisconnected

public void connectionDisconnected(ConnectionsEvent event)

Description copied from interface: DisconnectListener

This is called on all listeners after a successful disconnect of the connection.

Specified by:

connectionDisconnected in interface DisconnectListener

Parameters:

event - the connection event describing the connection that has been disconnected.

connectionConnected

public void connectionConnected(ConnectionsEvent event,
                       DatabaseConnectionsListener.ConnectionType type)

This is called when a connection definition is successfully used to create a Connection to the database.

Parameters:

event - the event describing the connection that has been connected.