DTP ODA Consumer Data Source Property Service Provider
Identifier:
org.eclipse.datatools.connectivity.oda.consumer.propertyProvider
Since:
3.0.1
Description:
This ODA consumer helper component's extension point allows an ODA consumer application to extend the ODA consumer framework to provide application-specific service to obtain and adjust externalized property names and corresponding values, for use by an ODA run-time driver to connect to a data source.
Configuration Markup:
<!ELEMENT extension (dataSourcePropertyService)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT dataSourcePropertyService EMPTY>
<!ATTLIST dataSourcePropertyService
consumerApplicationId CDATA #REQUIRED
providerClass CDATA #REQUIRED>
Allows an ODA consumer application, such as J2EE application, to extend the ODA consumer framework to provide application-specific service to obtain and adjust configurable, externalized property names and corresponding values, for use by an ODA run-time driver to connect to a data source.
- consumerApplicationId - The unique identifier of an ODA consumer application, such as a J2EE application, which embeds an engine that uses the ODA consumer helper framework.
This consumer application id must match the value of the IPropertyProvider.ODA_CONSUMER_ID key, contained in a Map passed as the context in the call to the IDriver.setAppContext method.
- providerClass - The concrete class that implements the
org.eclipse.datatools.connectivity.oda.consumer.services.IPropertyProvider
interface to provide the application-specific service to obtain and adjust the data source connection property name-value pairs.
API Information:
[Provisional] An extension must implement the IPropertyProvider interface defined in the org.eclipse.datatools.connectivity.oda.consumer.services package. See the package's JavaDoc documentation for more information.
Copyright (c) 2006 Actuate Corporation.
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html .