org.eclipse.datatools.connectivity.oda.consumer.services
Interface IPropertyProvider
- public interface IPropertyProvider
The interface of the provider of run-time data source properties.
An ODA consumer application that implements the
org.eclipse.datatools.connectivity.oda.consumer.propertyProvider
extension point must provide a concrete class implementation
of this interface.
Method Summary |
java.util.Properties |
getDataSourceProperties(java.util.Properties candidateProperties,
java.lang.Object appContext)
Provides the effective property values to use at runtime to open
a connection to a data source. |
ODA_CONSUMER_ID
public static final java.lang.String ODA_CONSUMER_ID
- See Also:
- Constant Field Values
ODA_CONN_PROP_CONTEXT
public static final java.lang.String ODA_CONN_PROP_CONTEXT
- See Also:
- Constant Field Values
getDataSourceProperties
public java.util.Properties getDataSourceProperties(java.util.Properties candidateProperties,
java.lang.Object appContext)
throws OdaException
- Provides the effective property values to use at runtime to open
a connection to a data source.
- Parameters:
candidateProperties
- the set of candidate property name-value pairs
specified by an ODA consumer application
in its call to an ODA driver's IConnection.open method.
It may contain a configuration id or key
specific to the consumer application
to uniquely identify a set of externalized property values.
Such use is entirely implementation dependent.appContext
- the application context value provided by an
ODA consumer application in its call to an ODA driver's
IDriver.setAppContext method, associated with
the ODA_CONN_PROP_CONTEXT key.
The provider may use this application-specific context to
assist in its lookup and processing of its externalized
configuration framework. May be null.
- Returns:
- the set of effective property name-value pairs to use
- Throws:
OdaException
- if provider error occurs
Copyright © 2006 Actuate, IBM Corporation, Sybase, Inc. and others. All rights reserved.