Attachment 79770 Details for Bug 203158 – Final version

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Final version

Best practices for enablement plug-in structure(Final version).rtf (text/plain), 12.67 KB, created by Larry Dunnell

on 2007-10-04 16:02:18 EDT

(hide)

Description:

Filename:

MIME Type:

Creator: Larry Dunnell

Created: 2007-10-04 16:02:18 EDT

Size: 12.67 KB

patch

obsolete

>{\rtf1\ansi\ansicpg1252\uc1\deff0\stshfdbch0\stshfloch0\stshfhich0\stshfbi0\deflang1033\deflangfe1033{\fonttbl{\f0\froman\fcharset0\fprq2{\*\panose 02020603050405020304}Times New Roman;}{\f1\fswiss\fcharset0\fprq2{\*\panose 020b0604020202020204}Arial;}
>{\f7\fswiss\fcharset0\fprq2{\*\panose 020b0604020202030204}Helv{\*\falt Arial};}{\f149\froman\fcharset238\fprq2 Times New Roman CE;}{\f150\froman\fcharset204\fprq2 Times New Roman Cyr;}{\f152\froman\fcharset161\fprq2 Times New Roman Greek;}
>{\f153\froman\fcharset162\fprq2 Times New Roman Tur;}{\f154\froman\fcharset177\fprq2 Times New Roman (Hebrew);}{\f155\froman\fcharset178\fprq2 Times New Roman (Arabic);}{\f156\froman\fcharset186\fprq2 Times New Roman Baltic;}
>{\f157\froman\fcharset163\fprq2 Times New Roman (Vietnamese);}{\f159\fswiss\fcharset238\fprq2 Arial CE;}{\f160\fswiss\fcharset204\fprq2 Arial Cyr;}{\f162\fswiss\fcharset161\fprq2 Arial Greek;}{\f163\fswiss\fcharset162\fprq2 Arial Tur;}
>{\f164\fswiss\fcharset177\fprq2 Arial (Hebrew);}{\f165\fswiss\fcharset178\fprq2 Arial (Arabic);}{\f166\fswiss\fcharset186\fprq2 Arial Baltic;}{\f167\fswiss\fcharset163\fprq2 Arial (Vietnamese);}}{\colortbl;\red0\green0\blue0;\red0\green0\blue255;
>\red0\green255\blue255;\red0\green255\blue0;\red255\green0\blue255;\red255\green0\blue0;\red255\green255\blue0;\red255\green255\blue255;\red0\green0\blue128;\red0\green128\blue128;\red0\green128\blue0;\red128\green0\blue128;\red128\green0\blue0;
>\red128\green128\blue0;\red128\green128\blue128;\red192\green192\blue192;}{\stylesheet{\ql \li0\ri0\widctlpar\wrapdefault\aspalpha\aspnum\faauto\adjustright\rin0\lin0\itap0 \fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 \snext0 Normal;}{
>\s1\ql \li0\ri0\sb240\sa60\keepn\widctlpar\wrapdefault\aspalpha\aspnum\faauto\outlinelevel0\adjustright\rin0\lin0\itap0 \b\f1\fs32\lang1033\langfe1033\kerning32\cgrid\langnp1033\langfenp1033 \sbasedon0 \snext0 \styrsid11284265 heading 1;}{
>\s2\ql \li0\ri0\sb240\sa60\keepn\widctlpar\wrapdefault\aspalpha\aspnum\faauto\outlinelevel1\adjustright\rin0\lin0\itap0 \b\i\f1\fs28\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 \sbasedon0 \snext0 \styrsid11284265 heading 2;}{
>\s3\ql \li0\ri0\sb240\sa60\keepn\widctlpar\wrapdefault\aspalpha\aspnum\faauto\outlinelevel2\adjustright\rin0\lin0\itap0 \b\f1\fs26\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 \sbasedon0 \snext0 \styrsid11284265 heading 3;}{\*\cs10 \additive 
>\ssemihidden Default Paragraph Font;}{\*
>\ts11\tsrowd\trftsWidthB3\trpaddl108\trpaddr108\trpaddfl3\trpaddft3\trpaddfb3\trpaddfr3\trcbpat1\trcfpat1\tblind0\tblindtype3\tscellwidthfts0\tsvertalt\tsbrdrt\tsbrdrl\tsbrdrb\tsbrdrr\tsbrdrdgl\tsbrdrdgr\tsbrdrh\tsbrdrv 
>\ql \li0\ri0\widctlpar\wrapdefault\aspalpha\aspnum\faauto\adjustright\rin0\lin0\itap0 \fs20\lang1024\langfe1024\cgrid\langnp1024\langfenp1024 \snext11 \ssemihidden Normal Table;}}{\*\pgptbl {\pgp\ipgp0\itap0\li0\ri0\sb0\sa0}{\pgp\ipgp0\itap0\li0\ri0\sb0
>\sa0}{\pgp\ipgp0\itap0\li0\ri0\sb0\sa0}}{\*\rsidtbl \rsid31448\rsid149667\rsid934108\rsid4724926\rsid4736644\rsid10112346\rsid11108200\rsid11284265\rsid13048642\rsid14371184\rsid14515321}{\*\generator Microsoft Word 10.0.6829;}{\info
>{\title Guidelines for Enablement Plug-in Structure}{\author IBM_USER}{\operator IBM_USER}{\creatim\yr2007\mo10\dy4\hr12\min59}{\revtim\yr2007\mo10\dy4\hr13}{\version3}{\edmins2}{\nofpages2}{\nofwords297}{\nofchars2760}{\*\company IBM}{\nofcharsws3026}
>{\vern16393}{\*\password 00000000}}{\*\xmlnstbl }\paperw12240\paperh15840\margl1800\margr1800\margt1440\margb1440\gutter0 \widowctrl\ftnbj\aenddoc\grfdocevents0\noxlattoyen\expshrtn\noultrlspc\dntblnsbdb\nospaceforul\formshade\horzdoc\dgmargin\dghspace180
>\dgvspace180\dghorigin1701\dgvorigin1984\dghshow1\dgvshow1
>\jexpand\viewkind4\viewscale100\pgbrdrhead\pgbrdrfoot\splytwnine\ftnlytwnine\htmautsp\nolnhtadjtbl\useltbaln\alntblind\lytcalctblwd\lyttblrtgr\lnbrkrule\nobrkwrptbl\snaptogridincell\allowfieldendsel\wrppunct\asianbrkrule\rsidroot14371184 \fet0
>{\*\wgrffmtfilter 013f}\sectd \linex0\sectdefaultcl\sectrsid4724926\sftnbj {\*\pnseclvl1\pnucrm\pnstart1\pnindent720\pnhang {\pntxta .}}{\*\pnseclvl2\pnucltr\pnstart1\pnindent720\pnhang {\pntxta .}}{\*\pnseclvl3\pndec\pnstart1\pnindent720\pnhang 
>{\pntxta .}}{\*\pnseclvl4\pnlcltr\pnstart1\pnindent720\pnhang {\pntxta )}}{\*\pnseclvl5\pndec\pnstart1\pnindent720\pnhang {\pntxtb (}{\pntxta )}}{\*\pnseclvl6\pnlcltr\pnstart1\pnindent720\pnhang {\pntxtb (}{\pntxta )}}{\*\pnseclvl7
>\pnlcrm\pnstart1\pnindent720\pnhang {\pntxtb (}{\pntxta )}}{\*\pnseclvl8\pnlcltr\pnstart1\pnindent720\pnhang {\pntxtb (}{\pntxta )}}{\*\pnseclvl9\pnlcrm\pnstart1\pnindent720\pnhang {\pntxtb (}{\pntxta )}}\pard\plain 
>\s2\ql \li0\ri0\sb240\sa60\keepn\widctlpar\wrapdefault\aspalpha\aspnum\faauto\outlinelevel1\adjustright\rin0\lin0\itap0\pararsid11284265 \b\i\f1\fs28\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {\insrsid14515321 Guidelines for }{\insrsid149667 
>Enablement Plug-in Structure
>\par }\pard\plain \ql \li0\ri0\widctlpar\tx-720\tx0\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\wrapdefault\faauto\rin0\lin0\itap0\pararsid934108 \fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {\f7\fs20\cf1\insrsid934108 The main purpose of this 
>proposal is to provide a means to fulfill the following requirement:
>\par 
>\par There needs to be a strict separation between plug-ins with UI dependencies and non-UI dependencies.  Adopters have the need to access core functionality such as connection profiles, dri
>ver templates, connection management, DDL generators and catalog loaders from command-line tooling or without the UI components installed in the product.  Some of the use-cases include programmatically creating a connection to a database, browsing the cat
>alog metadata, generating DDL and executing DDL.
>\par 
>\par The following describes the four plug-ins that would make up support for a specific database in the enablement project.
>\par }\pard \ql \li0\ri0\widctlpar\tx-720\tx0\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\wrapdefault\faauto\rin0\lin0\itap0\pararsid149667 {\b\f7\fs20\cf1\insrsid149667 
>\par Naming standard note:}{\f7\fs20\cf1\insrsid149667    The naming standard is intended for plug-ins being contributed
> to DTP.  The <database sub-product> segment is optional.  If the <database company> and <database name> segments are identical then only one segment is specified.
>\par 
>\par }\pard\plain \s3\ql \li0\ri0\sb240\sa60\keepn\widctlpar\wrapdefault\aspalpha\aspnum\faauto\outlinelevel2\adjustright\rin0\lin0\itap0\pararsid11284265 \b\f1\fs26\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {\insrsid11284265 1) }{\insrsid149667 
>Database Definition Plu}{\insrsid11284265 g-in (non-UI)}{\insrsid149667 
>\par }\pard\plain \ql \li0\ri0\widctlpar\tx-720\tx0\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\wrapdefault\faauto\rin0\lin0\itap0\pararsid149667 \fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {\b\f7\fs20\cf1\insrsid149667 
>\par Purpose:
>\par }{\f7\fs20\cf1\insrsid149667 Contains the dbdefinition instances for specific database vendors and versions.
>\par 
>\par }\pard \ql \li0\ri0\widctlpar\wrapdefault\faauto\rin0\lin0\itap0\pararsid149667 {\b\f7\fs20\cf1\insrsid149667 Naming Standard:
>\par }{\f7\fs20\cf1\insrsid149667 org.eclipse.datatools.<sub-project>.<database company>.<database name>.<database sub-product>.dbdefinition
>\par 
>\par }{\b\f7\fs20\cf1\insrsid149667 Examples:
>\par }\pard \ql \li0\ri0\widctlpar\tx-720\tx0\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\wrapdefault\faauto\rin0\lin0\itap0\pararsid149667 {\f7\fs20\cf1\insrsid149667 org.eclipse.datatools.connectivity.dbdefinition.genericJDBC (should be called org
>.eclipse.datatools.connectivity.generic.dbdefinition)
>\par org.eclipse.datatools.enablement.oracle.dbdefinition
>\par }{\f7\fs20\cf1\insrsid13048642\charrsid13048642 org.eclipse.datatools.enablement.ibm.db2.iseries.dbdefinition
>\par }{\f7\fs20\cf1\insrsid149667 
>\par }\pard\plain \s3\ql \li0\ri0\sb240\sa60\keepn\widctlpar\wrapdefault\aspalpha\aspnum\faauto\outlinelevel2\adjustright\rin0\lin0\itap0\pararsid11284265 \b\f1\fs26\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {\insrsid11284265 2) Core Plug-in (non-UI)}{
>\insrsid149667 
>\par }\pard\plain \ql \li0\ri0\widctlpar\wrapdefault\faauto\rin0\lin0\itap0\pararsid149667 \fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {\b\f7\fs20\cf1\insrsid149667 
>\par }\pard \ql \li0\ri0\widctlpar\tx-720\tx0\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\wrapdefault\faauto\rin0\lin0\itap0\pararsid149667 {\b\f7\fs20\cf1\insrsid149667 Purpose:
>\par }{\f7\fs20\cf1\insrsid149667 Contains the non-UI elements required for database connectivity support.  Features in this plug-in include connection profiles, driver templates, connection factories, catalog loaders, ddl gen}{\f7\fs20\cf1\insrsid31448 
>erators and containment providers.}{\f7\fs20\cf1\insrsid149667 
>\par 
>\par }\pard \ql \li0\ri0\widctlpar\wrapdefault\faauto\rin0\lin0\itap0\pararsid149667 {\b\f7\fs20\cf1\insrsid149667 Naming Standard:
>\par }{\f7\fs20\cf1\insrsid149667 org.eclipse.datatools.<sub-project>.<database company>.<database name>.<database sub-product>
>\par 
>\par }{\b\f7\fs20\cf1\insrsid149667 Examples:
>\par }\pard \ql \li0\ri0\widctlpar\tx-720\tx0\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\wrapdefault\faauto\rin0\lin0\itap0\pararsid149667 {\f7\fs20\cf1\insrsid149667 
>org.eclipse.datatools.connectivity.db.generic (should be called org.eclipse.datatools.connectivity.generic)
>\par org.eclipse.datatools.connectivity.derby (should be called org.eclipse.datatools.connectivity.apache.derby)
>\par }{\f7\fs20\cf1\insrsid13048642\charrsid13048642 org.eclipse.datatools.enablement.ibm.db2.iseries
>\par }{\f7\fs20\cf1\insrsid149667 
>\par }\pard\plain \s3\ql \li0\ri0\sb240\sa60\keepn\widctlpar\wrapdefault\aspalpha\aspnum\faauto\outlinelevel2\adjustright\rin0\lin0\itap0\pararsid11284265 \b\f1\fs26\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {\insrsid11284265 3) UI Plug-in (UI)}{
>\insrsid149667 
>\par }\pard\plain \ql \li0\ri0\widctlpar\wrapdefault\faauto\rin0\lin0\itap0\pararsid149667 \fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {\b\f7\fs20\cf1\insrsid149667 
>\par }\pard \ql \li0\ri0\widctlpar\tx-720\tx0\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\wrapdefault\faauto\rin0\lin0\itap0\pararsid149667 {\b\f7\fs20\cf1\insrsid149667 Purpose:
>\par }{\f7\fs20\cf1\insrsid149667 Contains the UI elements required for database connectivity support.  Features in this plug-in include connection profile wizards and Data Source Explorer content providers.
>\par 
>\par }\pard \ql \li0\ri0\widctlpar\wrapdefault\faauto\rin0\lin0\itap0\pararsid149667 {\b\f7\fs20\cf1\insrsid149667 Naming Standard:
>\par }{\f7\fs20\cf1\insrsid149667 org.eclipse.datatools.<sub-project>.<database company>.<database name>.<database sub-product>.ui
>\par 
>\par }{\b\f7\fs20\cf1\insrsid149667 Examples:
>\par }\pard \ql \li0\ri0\widctlpar\tx-720\tx0\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\wrapdefault\faauto\rin0\lin0\itap0\pararsid149667 {\f7\fs20\cf1\insrsid149667 org.eclipse.datatools.connectivity.db.generic.ui (should be called org.eclipse.
>datatools.connectivity.generic.ui )
>\par org.eclipse.datatools.connectivity.derby.ui (should be called org.eclipse.datatools.connectivity.apache.derby.ui)
>\par }{\f7\fs20\cf1\insrsid13048642\charrsid13048642 org.eclipse.datatools.enablement.ibm.db2.iseries.ui
>\par }\pard \ql \li0\ri0\widctlpar\wrapdefault\faauto\rin0\lin0\itap0\pararsid149667 {\f7\fs20\cf1\insrsid149667 
>\par }\pard\plain \s3\ql \li0\ri0\sb240\sa60\keepn\widctlpar\wrapdefault\aspalpha\aspnum\faauto\outlinelevel2\adjustright\rin0\lin0\itap0\pararsid11284265 \b\f1\fs26\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {\insrsid11284265 4) Models Plug-in (non-UI)
>}{\insrsid149667 
>\par }\pard\plain \ql \li0\ri0\widctlpar\wrapdefault\faauto\rin0\lin0\itap0\pararsid149667 \fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {\b\f7\fs20\cf1\insrsid149667 
>\par }\pard \ql \li0\ri0\widctlpar\tx-720\tx0\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\wrapdefault\faauto\rin0\lin0\itap0\pararsid149667 {\b\f7\fs20\cf1\insrsid149667 Purpose:
>\par }{\f7\fs20\cf1\insrsid149667 Contains the models and model extensions for specific database vendors and versions.
>\par 
>\par }\pard \ql \li0\ri0\widctlpar\wrapdefault\faauto\rin0\lin0\itap0\pararsid149667 {\b\f7\fs20\cf1\insrsid149667 Naming Standard:
>\par }{\f7\fs20\cf1\insrsid149667 org.eclipse.datatools.<sub-project>.<database company>.<database name>.<database sub-product>.models
>\par 
>\par }{\b\f7\fs20\cf1\insrsid149667 Examples:
>\par }\pard \ql \li0\ri0\widctlpar\tx-720\tx0\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\wrapdefault\faauto\rin0\lin0\itap0\pararsid149667 {\f7\fs20\cf1\insrsid149667 org.eclipse.datatools.enablement.sybase.asa.models
>\par }\pard \ql \li0\ri0\widctlpar\wrapdefault\aspalpha\aspnum\faauto\adjustright\rin0\lin0\itap0 {\insrsid11108200 
>\par }}

Actions: View

Attachments on bug 203158: 78235 | 79770 | 79771 | 79782 | 79783 | 79784 | 79840 | 80178 | 80254 | 80269 | 80612 | 80613 | 87290