oracle.javatools.db

Class DBObjectProviderFactory

java.lang.Object

oracle.javatools.db.DBObjectProviderFactory

public final class DBObjectProviderFactory
extends java.lang.Object

Factory class for creating DBObjectProviders. The providers are cached by an identifier which must be unique per provider. Different provider implementations will use different keys. For example the the Database support (always available) uses a String (Database.getQualifiedName()) as the identifier while the offline database (when available) will use its URL.

Since:

10.1.3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DBObjectProviderFactory.Creator Factory creator class used to create provider instances when there isn't one already in the cache.
static interface	DBObjectProviderFactory.Listener Listener interface that can be registered against this factory to be notified of provider create and uncache events.

Method Summary

Modifier and Type	Method and Description
static <T extends DBObjectProviderFactory.Creator> T	findFactory(java.lang.Class<T> clz) Deprecated. use getCreator(String) instead as it doesn't load classes.
static DBObjectProvider	findOrCreateProvider(DBObjectProviderID id) Finds or creates a provider with the given DBObjectProviderID.
static DBObjectProvider	findOrCreateProvider(java.lang.Object identifier) Deprecated. use findOrCreateProvider(String,Object)
static DBObjectProvider	findOrCreateProvider(java.lang.String providerType, java.lang.Object identifier) Finds or creates a provider with the given type and identifier.
static DBObjectProvider	findProvider(DBObjectProviderID id) Finds a provider using the given id.
static DBObjectProvider	findProvider(java.lang.Object identifier) Deprecated. use findProvider(String,Object)
static DBObjectProvider	findProvider(java.lang.String providerType, java.lang.Object identifier) Finds a provider using the given identifier key.
static DBObjectProviderFactory.Creator	getCreator(java.lang.String providerType) Internal use only.
static java.lang.String	getDescription(java.lang.String type, java.lang.Object identifier) Gets a displayable string to represent the provider with the given identifier.
static java.lang.Class<? extends DBObjectProvider>	loadProviderClass(java.lang.String clzName) Loads the given provider class using the class name.
static void	registerFactory(DBObjectProviderFactory.Creator factory) Register the given Creator to be available for creating providers.
static void	registerListener(DBObjectProviderFactory.Listener l) Registers a listener to be notified of any providers being created or removed from the cache.
static void	registerProviderListener(java.lang.String providerType, DBObjectProviderListener l) Registers a DBObjectProviderListener that will in turn be registered with any DBObjectProvider created of the given providerType.
static DBObjectProvider	uncacheProvider(java.lang.Object identifier) Deprecated. use uncacheProvider(String,Object) to avoid initialising unnecessary extensions.
static DBObjectProvider	uncacheProvider(java.lang.String providerType, java.lang.Object identifier) Uncaches a DBObjectProvider instance.
static void	unregisterFactory(DBObjectProviderFactory.Creator factory) Unregisters the given Creator.
static void	unregisterListener(DBObjectProviderFactory.Listener l) Unregister the specified listener.
static void	unregisterProviderListener(java.lang.String providerType, DBObjectProviderListener l) Unregisters a DBObjectProviderListener that was previously registered with registerProviderListener(String,DBObjectProviderListener) If either argument is null nothing will be unregistered.

Methods inherited from class java.lang.Object

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

Method Detail

registerListener

public static void registerListener(DBObjectProviderFactory.Listener l)

Registers a listener to be notified of any providers being created or removed from the cache.

Parameters:

l -

unregisterListener

public static void unregisterListener(DBObjectProviderFactory.Listener l)

Unregister the specified listener. If the collection of registered listeners contains the specified listen, it is removed.

registerProviderListener

public static void registerProviderListener(java.lang.String providerType,
                                            DBObjectProviderListener l)

Registers a DBObjectProviderListener that will in turn be registered with any DBObjectProvider created of the given providerType. If either argument is null nothing will be registered.

When a DBObjectProvider instance that the listener has been added to is closed/removed then the listener will be unregistered from it.

Parameters:

providerType - the type of provider to register the listener with

l - the listener to add to all providers created of the given type

unregisterProviderListener

public static void unregisterProviderListener(java.lang.String providerType,
                                              DBObjectProviderListener l)

Unregisters a DBObjectProviderListener that was previously registered with registerProviderListener(String,DBObjectProviderListener) If either argument is null nothing will be unregistered.

Unregistering this listener will stop it from being registered with any new DBObjectProvider. If it has already been registered with a DBObjectProvider that has been created since it was registered then it will remain listening to that provider until the provider is closed/removed.

Parameters:

providerType - the type of provider the listener was registered against

l - the listener to unregister

registerFactory

public static void registerFactory(DBObjectProviderFactory.Creator factory)

Register the given Creator to be available for creating providers. The Creator must implement getProviderType() to return a non-null, unique String that identifies the type of provider it creates.

unregisterFactory

public static void unregisterFactory(DBObjectProviderFactory.Creator factory)

Unregisters the given Creator. The Creator instance must be the same as that registered using registerFactory.

findFactory

@Deprecated
public static <T extends DBObjectProviderFactory.Creator> T findFactory(java.lang.Class<T> clz)

Deprecated. use getCreator(String) instead as it doesn't load classes.

Finds a registered factory.

findProvider

@Deprecated
public static DBObjectProvider findProvider(java.lang.Object identifier)

Deprecated. use findProvider(String,Object)

findProvider

public static DBObjectProvider findProvider(DBObjectProviderID id)

Finds a provider using the given id.

Parameters:

id - the ID for the DBObjectProvider to find.

findProvider

public static DBObjectProvider findProvider(java.lang.String providerType,
                                            java.lang.Object identifier)

Finds a provider using the given identifier key. Only works for providers that can be cached. Databases created without a connection name cannot be cached.

Parameters:

providerType - the type of provider to find

identifier - the identifier for the provider - e.g. connection name or offline database url

See Also:

Database.PROVIDER_TYPE

findOrCreateProvider

@Deprecated
public static DBObjectProvider findOrCreateProvider(java.lang.Object identifier)
                                                         throws DBException

Deprecated. use findOrCreateProvider(String,Object)

Throws:

DBException

findOrCreateProvider

public static DBObjectProvider findOrCreateProvider(DBObjectProviderID id)
                                             throws DBException

Finds or creates a provider with the given DBObjectProviderID.

Parameters:

id - the ID object for the provider

Throws:

DBException

findOrCreateProvider

public static DBObjectProvider findOrCreateProvider(java.lang.String providerType,
                                                    java.lang.Object identifier)
                                             throws DBException

Finds or creates a provider with the given type and identifier.

Parameters:

providerType - the type of provider to find - e.g. Database.PROVIDER_TYPE or OfflineDBObjectProvider.PROVIDER_TYPE.

identifier - the identifier for the provider - e.g. connection name or offline database url

Throws:

DBException

See Also:

Database.PROVIDER_TYPE

getCreator

public static final DBObjectProviderFactory.Creator getCreator(java.lang.String providerType)

Internal use only. Gets the registered Creator for the given provider type.

uncacheProvider

@Deprecated
public static final DBObjectProvider uncacheProvider(java.lang.Object identifier)

Deprecated. use uncacheProvider(String,Object) to avoid initialising unnecessary extensions.

uncacheProvider

public static final DBObjectProvider uncacheProvider(java.lang.String providerType,
                                                     java.lang.Object identifier)

Uncaches a DBObjectProvider instance.

Parameters:

providerType - the type of provider

identifier - the unique identified for the provider

Returns:

the instance that has been uncached, or null if no such provider existed.

getDescription

public static java.lang.String getDescription(java.lang.String type,
                                              java.lang.Object identifier)

Gets a displayable string to represent the provider with the given identifier. The string can contain a description of the type as well, for example "database hr" or "offline database DATABASE1"

loadProviderClass

public static final java.lang.Class<? extends DBObjectProvider> loadProviderClass(java.lang.String clzName)
                                                                           throws java.lang.ClassNotFoundException

Loads the given provider class using the class name. This is preferable to using Class.forName( clzName ) because the given provider class may not be on the classpath of the api (e.g. in osgi mode).

Parameters:

clzName - the name of the provider class to load

Returns:

the loaded provider class

Throws:

java.lang.ClassNotFoundException - if the class cannot be found on any of the available classpaths.