| Linda Chan | 11f26ff | 2011-09-28 16:32:28 -0700 | [diff] [blame] | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
| 2 | <HTML>
|
| 3 | <HEAD><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
| 4 | <title>DTP ODA Consumer Data Source Property Service Provider</title>
|
| 5 | <style type="text/css">@import url("file:/D:/dev/eclipse_platform/eclipse_37/plugins/org.eclipse.sdk_3.7.0.v201106131736/book.css");</style>
|
| 6 | <style type="text/css">@import url("file:/D:/dev/eclipse_platform/eclipse_37/configuration/org.eclipse.osgi/bundles/624/1/.cp/schema.css");</style>
|
| 7 | </HEAD>
|
| 8 | <BODY>
|
| 9 | <H1 style="text-align:center">DTP ODA Consumer Data Source Property Service Provider</H1>
|
| 10 | <p></p>
|
| 11 | <h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>org.eclipse.datatools.connectivity.oda.consumer.propertyProvider<p></p>
|
| 12 | <h6 class="CaptionFigColumn SchemaHeader">Since: </h6>3.0.1
|
| 13 | <p></p>
|
| 14 |
|
| 15 | <h6 class="CaptionFigColumn SchemaHeader">Description: </h6>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.<p></p>
|
| 16 | <h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6>
|
| 17 | <p></p>
|
| 18 | <p class="code SchemaDtd"><!ELEMENT <a name="e.extension">extension</a> (<a href="#e.dataSourcePropertyService">dataSourcePropertyService</a>)></p>
|
| 19 | <p class="code SchemaDtd"><!ATTLIST extension</p>
|
| 20 | <p class="code SchemaDtdAttlist">point CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">id CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">name CDATA #IMPLIED</p>></p>
|
| 21 | <p></p>
|
| 22 | <ul class="ConfigMarkupAttlistDesc">
|
| 23 | </ul>
|
| 24 | <br><p class="code SchemaDtd"><!ELEMENT <a name="e.dataSourcePropertyService">dataSourcePropertyService</a> EMPTY></p>
|
| 25 | <p class="code SchemaDtd"><!ATTLIST dataSourcePropertyService</p>
|
| 26 | <p class="code SchemaDtdAttlist">consumerApplicationId CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">providerClass CDATA #REQUIRED</p>></p>
|
| 27 | <p></p>
|
| 28 | <p class="ConfigMarkupElementDesc">
|
| 29 | 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.</p>
|
| 30 | <br>
|
| 31 | <ul class="ConfigMarkupAttlistDesc">
|
| Xiaoying Gu | 2d3e2a7 | 2010-11-26 08:01:08 +0000 | [diff] [blame] | 32 | <li><b>consumerApplicationId</b> - The unique identifier of an ODA consumer application, such as a J2EE application, which embeds an engine that uses the ODA consumer helper framework. |
| Linda Chan | 11f26ff | 2011-09-28 16:32:28 -0700 | [diff] [blame] | 33 | 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.</li>
|
| 34 | <li><b>providerClass</b> - The concrete class that implements the <code>org.eclipse.datatools.connectivity.oda.consumer.services.IPropertyProvider</code> interface to provide an application-specific service to obtain and adjust the data source connection properties. |
| 35 | <p> |
| 36 | See <code>org.eclipse.datatools.connectivity.oda.consumer.services.impl.PropertyProviderImpl</code> for an exemplary base class implementation of the <code>IPropertyProvider</code> interface.</li>
|
| 37 | </ul>
|
| 38 | <br><h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>[Provisional] An extension must implement the IPropertyProvider interface defined in the <i>org.eclipse.datatools.connectivity.oda.consumer.services</i> package. See the package's JavaDoc documentation for more information.
|
| 39 | <p></p>
|
| 40 |
|
| 41 | <br>
|
| 42 | <p class="note SchemaCopyright">
|
| Xiaoying Gu | 2d3e2a7 | 2010-11-26 08:01:08 +0000 | [diff] [blame] | 43 | Copyright (c) 2006 Actuate Corporation. |
| Linda Chan | 11f26ff | 2011-09-28 16:32:28 -0700 | [diff] [blame] | 44 | 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 .
|
| 45 |
|
| 46 | </p>
|
| 47 | </BODY>
|
| 48 | </HTML>
|