Google Git
Sign in
eclipse / www.eclipse.org / datatools / 715f3193bef4e49bed27db341dd6ec5ce1d43cca / . / project_connectivity / connectivity_doc / CMF_I101905.html
blob: dd8aa781bd485acff4ba4b29d7f1c72c23a88124 [file] [log] [blame]
<html>
<head>
<meta http-equiv=Content-Type content="text/html; charset=windows-1252">
<meta name=Generator content="Microsoft Word 11 (filtered)">
<title>Connection Profile Extension</title>
<style>
<!--
/* Font Definitions */
@font-face
{font-family:Courier;
panose-1:2 7 4 9 2 2 5 2 4 4;}
@font-face
{font-family:Wingdings;
panose-1:5 0 0 0 0 0 0 0 0 0;}
/* Style Definitions */
p.MsoNormal, li.MsoNormal, div.MsoNormal
{margin:0in;
margin-bottom:.0001pt;
font-size:12.0pt;
font-family:"Times New Roman";
color:windowtext;}
h1
{margin-top:3.75pt;
margin-right:0in;
margin-bottom:.75pt;
margin-left:0in;
font-size:18.0pt;
font-family:Arial;
color:black;
font-weight:bold;}
h6
{margin-right:0in;
margin-left:0in;
font-size:10.0pt;
font-family:Arial;
color:black;
font-weight:bold;}
a:link, span.MsoHyperlink
{color:blue;
text-decoration:underline;}
a:visited, span.MsoHyperlinkFollowed
{color:purple;
text-decoration:underline;}
p
{margin-top:7.5pt;
margin-right:0in;
margin-bottom:7.5pt;
margin-left:0in;
font-size:10.0pt;
font-family:Arial;
color:black;}
pre
{margin-top:0in;
margin-right:0in;
margin-bottom:0in;
margin-left:4.5pt;
margin-bottom:.0001pt;
font-size:9.0pt;
font-family:Courier;
color:#4444CC;}
samp
{font-family:"Courier New";}
p.code, li.code, div.code
{margin-top:0in;
margin-right:0in;
margin-bottom:0in;
margin-left:15.0pt;
margin-bottom:.0001pt;
font-size:10.0pt;
font-family:"Courier New";
color:#4444CC;}
p.configmarkup, li.configmarkup, div.configmarkup
{margin-top:7.5pt;
margin-right:0in;
margin-bottom:7.5pt;
margin-left:0in;
font-size:10.0pt;
font-family:Arial;
color:black;}
@page Section1
{size:8.5in 11.0in;
margin:1.0in 1.25in 1.0in 1.25in;}
div.Section1
{page:Section1;}
/* List Definitions */
ol
{margin-bottom:0in;}
ul
{margin-bottom:0in;}
-->
</style>
</head>
<body lang=EN-US link=blue vlink=purple>
<div class=Section1>
<h1 align=center style='text-align:center'>Connection Profile Extension</h1>
<h6 style='margin-top:3.0pt;margin-right:0in;margin-bottom:11.0pt;margin-left:
0in;vertical-align:baseline' id=header><i><span style='font-size:9.0pt'>Identifier:
</span></i></h6>
<p class=MsoNormal><span style='font-size:10.0pt;font-family:Arial;color:black'>org.eclipse.datatools.connectivity.connectionProfile
</span></p>
<h6 style='margin-top:3.0pt;margin-right:0in;margin-bottom:11.0pt;margin-left:
0in;vertical-align:baseline' id=header><i><span style='font-size:9.0pt'>Since: </span></i></h6>
<p class=MsoNormal><span style='font-size:10.0pt;font-family:Arial;color:black'>DTP
v. 0.x </span></p>
<h6 style='margin-top:3.0pt;margin-right:0in;margin-bottom:11.0pt;margin-left:
0in;vertical-align:baseline' id=header><i><span style='font-size:9.0pt'>Description:
</span></i></h6>
<p class=MsoNormal><span style='font-size:10.0pt;font-family:Arial;color:black'>This
extension point provides a place for plug-ins to add support for different
types of connection profiles. It also allows extensions to extend the
capabilities of defined extension points. </span></p>
<p>Connection profiles are defined using the <samp>connectionProfile</samp>
element. A connection profile will belong to a single category and a single
configuration type. Categories are used for grouping like types of connection
profiles (e.g. queue, database, etc.). Configuration types are used for
specifying the type of configuration information provided by the profile (e.g.
New Era Open Transport, JDBC, etc.).</p>
<p>The provider must define a corresponding <samp>newWizard</samp> element for
creating the resource.</p>
<p>The provider must define a corresponding <samp>org.eclipse.ui.propertyPages</samp>
for editing the connection profile's properties. The provider should ensure a <samp>filter</samp>
element is defined to verify the selected connection profile's provider ID
matches the <samp>id</samp> specified for the <samp>connectionProfile</samp>
(this is accomplished using the <samp>org.eclipse.datatools.profile.property.id</samp>
property). <samp>org.eclipse.datatools.connectivity.ui.wizards.ProfileDetailsPropertyPage</samp>
is a base property page implementation intended to be extended by connection
profile providers for this purpose.</p>
<p>Connection factories supporting a given profile may be registered using the <samp>connectionFactory</samp>
element. Connection factories allow plug-ins to create a connection to a server
from a connection profile. A connection profile provider should provide a
connection factory extension. Ideally, a connection factory's ID should
correspond with the type of object created when connected (e.g. <samp>java.sql.Connection</samp>).
A connection profile provider should implement a <samp>connectionFactory</samp>
with an ID of <samp>org.eclipse.datatools.connectivity.connectionFactory.pingFactory</samp>
to enable the ping functionality provided in the base implementations and
framework. </p>
<p>Connection profiles may be extended by other plug-ins by defining the
following extension elements: </p>
<ul style='margin-top:0in' type=disc>
<li class=MsoNormal style='color:black'><samp><span style='font-size:10.0pt'>connectionFactory
- </span></samp><span style='font-size:10.0pt;font-family:Arial'>This
element enables a plug-in to provide connection creation support for the
specified connection profile. </span></li>
<li class=MsoNormal style='color:black'><samp><span style='font-size:10.0pt'>profileExtension
- </span></samp><span style='font-size:10.0pt;font-family:Arial'>This
element enables a plug-in to provide additional configuration properties
for the specified connection profile. If you are extending a connection
profile in this manner and these properties need to be specified when
connecting to the server defined by the connection profile, you will need
to provide a connection factory extension that makes use of the additional
properties. </span></li>
</ul>
<p>Tooling providers can choose to integrate with connection profiles using a
variety of mechanisms. Tooling can be keyed to a specific profile type (by
checking the profile's ID attribute; e.g. the mechanism used for contributing
property pages as noted above). Tooling can also be keyed to work with profiles
with a specified connection factory (e.g. DB specific tooling might be keyed to
use any profile with a <samp>java.sql.Connection</samp> factory). This approach
allows tooling to work with any type of connection profile that can be
represented through a particular connection API.</p>
<p>The following filter properties are provided for filtering connection
profile instances: (These are defined in <samp>org.eclipse.datatools.connectivity.ui.IConnectionProfileActionFilter</samp>.)
</p>
<ul style='margin-top:0in' type=disc>
<li class=MsoNormal style='color:black'><samp><span style='font-size:10.0pt'>org.eclipse.datatools.profile.property.id</span></samp><span
style='font-size:10.0pt;font-family:Arial'> - Use for filtering profile
instances of a specific type. </span></li>
<li class=MsoNormal style='color:black'><samp><span style='font-size:10.0pt'>org.eclipse.datatools.connectivity.profile.property.categoryID</span></samp><span
style='font-size:10.0pt;font-family:Arial'> - Use for filtering profile
instances belonging to a specific category. </span></li>
<li class=MsoNormal style='color:black'><samp><span style='font-size:10.0pt'>org.eclipse.datatools.connectivity.profile.property.factoryID</span></samp><span
style='font-size:10.0pt;font-family:Arial'> - Use for filtering profile
instances implementing a specific type of connection factory. </span></li>
<li class=MsoNormal style='color:black'><samp><span style='font-size:10.0pt'>org.eclipse.datatools.connectivity.profile.property.hasExtendedProperties</span></samp><span
style='font-size:10.0pt;font-family:Arial'> - Use for filtering profile
instances with one or more </span><samp><span style='font-size:10.0pt'>profileExtension</span></samp><span
style='font-size:10.0pt;font-family:Arial'>s defined. </span></li>
<li class=MsoNormal style='color:black'><samp><span style='font-size:10.0pt'>org.eclipse.datatools.connectivity.profile.property.extensionID</span></samp><span
style='font-size:10.0pt;font-family:Arial'> - Use for filtering profile
instances implementing a specific type of </span><samp><span
style='font-size:10.0pt'>profileExtension</span></samp><span
style='font-size:10.0pt;font-family:Arial'>. </span></li>
<li class=MsoNormal style='color:black'><samp><span style='font-size:10.0pt'>org.eclipse.datatools.connectivity.profile.property.containingViewID</span></samp><span
style='font-size:10.0pt;font-family:Arial'> - Use for filtering profile
instances contained within a specific view. </span></li>
<li class=MsoNormal style='color:black'><samp><span style='font-size:10.0pt'>org.eclipse.datatools.connectivity.profile.property.isConnected</span></samp><span
style='font-size:10.0pt;font-family:Arial'> - Use for filtering profile instances
based on their connection state. </span></li>
<li class=MsoNormal style='color:black'><samp><span style='font-size:10.0pt'>org.eclipse.datatools.connectivity.profile.property.supportsPing</span></samp><span
style='font-size:10.0pt;font-family:Arial'> - Use for filtering profile
instances implementing a ping connection factory (shortcut for
name=org.eclipse.datatools.connectivity.profile.property.factoryID,
value=org.eclipse.datatools.connectivity.connectionFactory.pingFactory). </span></li>
</ul>
<h6 style='margin-top:3.0pt;margin-right:0in;margin-bottom:11.0pt;margin-left:
0in;vertical-align:baseline' id=header><i><span style='font-size:9.0pt'>Configuration
Markup:</span></i></h6>
<p class=code id=dtd>&lt;!ELEMENT <a name=e.extension>extension</a> (<a
href="#e.category">category</a>* , <a
href="#e.configurationType">configurationType</a>*
, <a href="#e.connectionProfile">connectionProfile</a>*
, <a href="#e.connectionFactory">connectionFactory</a>*
, <a href="#e.profileExtension">profileExtension</a>*
, <a href="#e.newWizard">newWizard</a>*
, <a href="#e.wizardCategory">wizardCategory</a>*)*&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST extension</p>
<p class=code id=dtdAttlist>point&nbsp;CDATA #REQUIRED </p>
<p class=code id=dtdAttlist>id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED </p>
<p class=code id=dtdAttlist>name&nbsp;&nbsp;CDATA #IMPLIED&gt;</p>
<ul style='margin-top:0in' type=disc id=attlistDesc>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>point</span></b><span style='font-size:10.0pt;
font-family:Arial'> - a fully qualified identifier of the target extension
point, </span><samp><span style='font-size:10.0pt'>org.eclipse.datatools.connectivity.connectionProfile</span></samp><span
style='font-size:10.0pt;font-family:Arial'> </span></li>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>id</span></b><span style='font-size:10.0pt;font-family:
Arial'> - an optional identifier of the extension instance </span></li>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>name</span></b><span style='font-size:10.0pt;
font-family:Arial'> - an optional name of the extension instance </span></li>
</ul>
<p class=MsoNormal><span style='font-size:10.0pt;font-family:Arial;color:black'><br>
<br>
</span></p>
<p class=code>&lt;!ELEMENT <a name=e.category>category</a> EMPTY&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST category</p>
<p class=code id=dtdAttlist>id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA
#REQUIRED </p>
<p class=code id=dtdAttlist>parentCategory&nbsp;CDATA #IMPLIED </p>
<p class=code id=dtdAttlist>name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA
#IMPLIED&gt;</p>
<p class=configmarkup id=elementDesc>This element is used to identify a
category. Categories are used to group related connection profile types (e.g.
databases).</p>
<p class=MsoNormal><span style='font-size:10.0pt;font-family:Arial;color:black'><br>
<br>
</span></p>
<ul style='margin-top:0in' type=disc>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>id</span></b><span style='font-size:10.0pt;font-family:
Arial'> - The id of this category. This value is referenced by </span><samp><span
style='font-size:10.0pt'>connectionProfile</span></samp><span
style='font-size:10.0pt;font-family:Arial'> elements. </span></li>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>parentCategory</span></b><span style='font-size:10.0pt;
font-family:Arial'> - The id of a parent category, if this category has a
parent. </span></li>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>name</span></b><span style='font-size:10.0pt;
font-family:Arial'> - The display name for this category. </span></li>
</ul>
<p class=MsoNormal><span style='font-size:10.0pt;font-family:Arial;color:black'><br>
<br>
</span></p>
<p class=code>&lt;!ELEMENT <a name=e.connectionProfile>connectionProfile</a>
EMPTY&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST connectionProfile</p>
<p class=code id=dtdAttlist>id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA
#REQUIRED </p>
<p class=code id=dtdAttlist>name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA
#IMPLIED </p>
<p class=code id=dtdAttlist>category&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA
#REQUIRED </p>
<p class=code id=dtdAttlist>configurationType&nbsp;&nbsp;CDATA #REQUIRED </p>
<p class=code id=dtdAttlist>icon&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA
#IMPLIED </p>
<p class=code id=dtdAttlist>maintainConnection&nbsp;CDATA #IMPLIED&gt;</p>
<p class=configmarkup id=elementDesc>This element is used to define a
connection profile type.</p>
<p class=MsoNormal><span style='font-size:10.0pt;font-family:Arial;color:black'><br>
<br>
</span></p>
<ul style='margin-top:0in' type=disc>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>id</span></b><span style='font-size:10.0pt;font-family:
Arial'> - The id of this connection profile. This must uniquely identify
this connection profile. </span></li>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>name</span></b><span style='font-size:10.0pt;
font-family:Arial'> - The display name for this connection profile type. </span></li>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>category</span></b><span style='font-size:10.0pt;
font-family:Arial'> - The category that this connection profile belongs
to. This must map back to a </span><samp><span style='font-size:10.0pt'>category/id</span></samp><span
style='font-size:10.0pt;font-family:Arial'>. </span></li>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>configurationType</span></b><span style='font-size:
10.0pt;font-family:Arial'> - The configuration type for this connection
profile. This must map back to a </span><samp><span style='font-size:10.0pt'>configurationType/id</span></samp><span
style='font-size:10.0pt;font-family:Arial'>. </span></li>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>icon</span></b><span style='font-size:10.0pt;
font-family:Arial'> - The plug-in relative path to an image file. This
image will be used to identify resources of this type in the servers view.
</span></li>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>maintainConnection</span></b><span style='font-size:
10.0pt;font-family:Arial'> - </span></li>
</ul>
<p class=MsoNormal><span style='font-size:10.0pt;font-family:Arial;color:black'><br>
<br>
</span></p>
<p class=code>&lt;!ELEMENT <a name=e.configurationType>configurationType</a>
EMPTY&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST configurationType</p>
<p class=code id=dtdAttlist>id&nbsp;&nbsp;&nbsp;CDATA #REQUIRED </p>
<p class=code id=dtdAttlist>name&nbsp;CDATA #IMPLIED&gt;</p>
<p class=configmarkup id=elementDesc>This element is used to identify a
configuration type. A configuration type is used for determining the format of
the configuration data used by a connection profile. For example, &quot;New Era
Open Transport&quot; or &quot;JDBC Connection URL&quot;</p>
<p class=MsoNormal><span style='font-size:10.0pt;font-family:Arial;color:black'><br>
<br>
</span></p>
<ul style='margin-top:0in' type=disc>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>id</span></b><span style='font-size:10.0pt;font-family:
Arial'> - The unique identifier for this configuration type. </span></li>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>name</span></b><span style='font-size:10.0pt;
font-family:Arial'> - The name of this configuration type. </span></li>
</ul>
<p class=MsoNormal><span style='font-size:10.0pt;font-family:Arial;color:black'><br>
<br>
</span></p>
<p class=code>&lt;!ELEMENT <a name=e.connectionFactory>connectionFactory</a>
EMPTY&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST connectionFactory</p>
<p class=code id=dtdAttlist>profile&nbsp;CDATA #REQUIRED </p>
<p class=code id=dtdAttlist>name&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED </p>
<p class=code id=dtdAttlist>id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA
#REQUIRED </p>
<p class=code id=dtdAttlist>class&nbsp;&nbsp;&nbsp;CDATA #REQUIRED&gt;</p>
<p class=configmarkup id=elementDesc>This element defines a connection factory
that can be used to create connections to a server using the properties stored
in a connection profile resource.</p>
<p class=MsoNormal><span style='font-size:10.0pt;font-family:Arial;color:black'><br>
<br>
</span></p>
<ul style='margin-top:0in' type=disc>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>profile</span></b><span style='font-size:10.0pt;
font-family:Arial'> - The connection profile supported by this factory.
This should reference a </span><samp><span style='font-size:10.0pt'>connectionProfile/id</span></samp><span
style='font-size:10.0pt;font-family:Arial'>. </span></li>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>name</span></b><span style='font-size:10.0pt;
font-family:Arial'> - The name of this connection factory. </span></li>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>id</span></b><span style='font-size:10.0pt;font-family:
Arial'> - The unique identifier for this connection factory. This id may be
used by plug-ins to retrieve an instance of this connection factory. </span></li>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>class</span></b><span style='font-size:10.0pt;
font-family:Arial'> - The class that implements this connection factory.
The specified class must be an instance of IConnectionFactory. </span></li>
</ul>
<p class=MsoNormal><span style='font-size:10.0pt;font-family:Arial;color:black'><br>
<br>
</span></p>
<p class=code>&lt;!ELEMENT <a name=e.profileExtension>profileExtension</a>
EMPTY&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST profileExtension</p>
<p class=code id=dtdAttlist>profile&nbsp;CDATA #REQUIRED </p>
<p class=code id=dtdAttlist>name&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED </p>
<p class=code id=dtdAttlist>id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA
#REQUIRED&gt;</p>
<p class=configmarkup id=elementDesc>This element is used to define an
extension that provides support for setting additional properties on a
connection profile. When implementing this extension point, you should also
implement a connection factory if required.</p>
<p class=MsoNormal><span style='font-size:10.0pt;font-family:Arial;color:black'><br>
<br>
</span></p>
<ul style='margin-top:0in' type=disc>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>profile</span></b><span style='font-size:10.0pt;
font-family:Arial'> - The connection profile that this extension supports.
This should map to a </span><samp><span style='font-size:10.0pt'>connectionProfile/id</span></samp><span
style='font-size:10.0pt;font-family:Arial'>. </span></li>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>name</span></b><span style='font-size:10.0pt;
font-family:Arial'> - The name of this extension. </span></li>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>id</span></b><span style='font-size:10.0pt;font-family:
Arial'> - A unique identifier for this extension. </span></li>
</ul>
<p class=MsoNormal><span style='font-size:10.0pt;font-family:Arial;color:black'><br>
<br>
</span></p>
<p class=code>&lt;!ELEMENT <a name=e.newWizard>newWizard</a> EMPTY&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST newWizard</p>
<p class=code id=dtdAttlist>id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA
#REQUIRED </p>
<p class=code id=dtdAttlist>name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA
#REQUIRED </p>
<p class=code id=dtdAttlist>class&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA
#REQUIRED </p>
<p class=code id=dtdAttlist>icon&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA
#IMPLIED </p>
<p class=code id=dtdAttlist>description&nbsp;CDATA #IMPLIED </p>
<p class=code id=dtdAttlist>profile&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA
#REQUIRED </p>
<p class=code id=dtdAttlist>category&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED&gt;</p>
<p class=configmarkup id=elementDesc>This element is used to identify a
connection profile wizard. A wizard is used to create a connection profile</p>
<p class=MsoNormal><span style='font-size:10.0pt;font-family:Arial;color:black'><br>
<br>
</span></p>
<ul style='margin-top:0in' type=disc>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>id</span></b><span style='font-size:10.0pt;font-family:
Arial'> - The unique identifier for the new wizard. </span></li>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>name</span></b><span style='font-size:10.0pt;
font-family:Arial'> - </span></li>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>class</span></b><span style='font-size:10.0pt;
font-family:Arial'> - The class that implements this new wizard. The
specified class must be an instance of IWizard. </span><samp><span
style='font-size:10.0pt'>org.eclipse.datatools.connectivity.ui.wizards.NewConnectionProfileWizard</span></samp><span
style='font-size:10.0pt;font-family:Arial'> is a base implementation
intended to be extended by connection profile providers. </span><samp><span
style='font-size:10.0pt'>org.eclipse.datatools.connectivity.ui.wizards.ConnectionProfileDetailsPage</span></samp><span
style='font-size:10.0pt;font-family:Arial'> is a base wizard page implementation
intended for use with the above wizard implementation. </span></li>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>icon</span></b><span style='font-size:10.0pt;
font-family:Arial'> - The plug-in relative path to an image file. This
image will be used to identify the new wizard. </span></li>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>description</span></b><span style='font-size:10.0pt;
font-family:Arial'> - Description of the new wizard. </span></li>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>profile</span></b><span style='font-size:10.0pt;
font-family:Arial'> - The connection profile supported by this new wizard.
This should reference a </span><samp><span style='font-size:10.0pt'>connectionProfile/id</span></samp><span
style='font-size:10.0pt;font-family:Arial'>. </span></li>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>category</span></b><span style='font-size:10.0pt;
font-family:Arial'> - </span></li>
</ul>
<p class=MsoNormal><span style='font-size:10.0pt;font-family:Arial;color:black'><br>
<br>
</span></p>
<p class=code>&lt;!ELEMENT <a name=e.wizardCategory>wizardCategory</a>
EMPTY&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST wizardCategory</p>
<p class=code id=dtdAttlist>id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA
#REQUIRED </p>
<p class=code id=dtdAttlist>parentCategory&nbsp;&nbsp;&nbsp;&nbsp;CDATA
#IMPLIED </p>
<p class=code id=dtdAttlist>name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA
#IMPLIED </p>
<p class=code id=dtdAttlist>icon&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA
#IMPLIED </p>
<p class=code id=dtdAttlist>description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA
#IMPLIED </p>
<p class=code id=dtdAttlist>wizardTitle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA
#IMPLIED </p>
<p class=code id=dtdAttlist>wizardDescription&nbsp;CDATA #IMPLIED&gt;</p>
<ul style='margin-top:0in' type=disc id=attlistDesc>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>id</span></b><span style='font-size:10.0pt;font-family:
Arial'> - This element is used to identify a wizard category. Categories
are used to group related connection profile wizards (e.g. databases). </span></li>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>parentCategory</span></b><span style='font-size:10.0pt;
font-family:Arial'> - The id of a parent category, if this category has a
parent. </span></li>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>name</span></b><span style='font-size:10.0pt;
font-family:Arial'> - The display name for this category. </span></li>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>icon</span></b><span style='font-size:10.0pt;
font-family:Arial'> - The plug-in relative path to an image file. This
image will be used to identify wizard category in the new connection profile
wizard. </span></li>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>description</span></b><span style='font-size:10.0pt;
font-family:Arial'> - Description of the new wizard category. </span></li>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>wizardTitle</span></b><span style='font-size:10.0pt;
font-family:Arial'> - wizard title </span></li>
<li class=MsoNormal style='color:black'><b><span style='font-size:10.0pt;
font-family:Arial'>wizardDescription</span></b><span style='font-size:
10.0pt;font-family:Arial'> - wizard description </span></li>
</ul>
<p class=MsoNormal><span style='font-size:10.0pt;font-family:Arial;color:black'><br>
<br>
</span></p>
<h6 style='margin-top:3.0pt;margin-right:0in;margin-bottom:11.0pt;margin-left:
0in;vertical-align:baseline'><i><span style='font-size:9.0pt'>Examples: </span></i></h6>
<pre> </pre>
<p class=code style='margin-left:19.5pt'>&lt;extension</p>
<p class=code style='margin-left:19.5pt'>   id=</p>
<p class=code style='margin-left:19.5pt' id=cstring>&quot;sample&quot;</p>
<p class=code style='margin-left:19.5pt' id=tag>&nbsp;</p>
<p class=code style='margin-left:19.5pt'>   name=</p>
<p class=code style='margin-left:19.5pt' id=cstring>&quot;Sample Server
Extension&quot;</p>
<p class=code style='margin-left:19.5pt' id=tag>&nbsp;</p>
<p class=code style='margin-left:19.5pt'>   point=</p>
<p class=code style='margin-left:19.5pt' id=cstring>&quot;org.eclipse.datatools.connectivity.connectionProfile&quot;</p>
<p class=code style='margin-left:19.5pt' id=tag>&gt;&nbsp;</p>
<pre>&nbsp;</pre><pre>  </pre>
<p class=code style='margin-left:19.5pt'>&lt;category</p>
<p class=code style='margin-left:19.5pt'>    name=</p>
<p class=code style='margin-left:19.5pt' id=cstring>&quot;Sample Server
Category&quot;</p>
<p class=code style='margin-left:19.5pt' id=tag>&nbsp;</p>
<p class=code style='margin-left:19.5pt'>    id=</p>
<p class=code style='margin-left:19.5pt' id=cstring>&quot;org.eclipse.datatools.connectivity.example.sampleCategory&quot;</p>
<p class=code style='margin-left:19.5pt' id=tag>&gt;&nbsp;</p>
<pre>&nbsp;</pre><pre>  </pre>
<p class=code style='margin-left:19.5pt'>&lt;/category&gt;</p>
<pre>&nbsp;</pre><pre>  </pre>
<p class=code style='margin-left:19.5pt'>&lt;configurationType</p>
<p class=code style='margin-left:19.5pt'>    name=</p>
<p class=code style='margin-left:19.5pt' id=cstring>&quot;Sample Configuration
Type&quot;</p>
<p class=code style='margin-left:19.5pt' id=tag>&nbsp;</p>
<p class=code style='margin-left:19.5pt'>    id=</p>
<p class=code style='margin-left:19.5pt' id=cstring>&quot;org.eclipse.datatools.connectivity.example.sampleConfigurationType&quot;</p>
<p class=code style='margin-left:19.5pt' id=tag>&gt;&nbsp;</p>
<pre>&nbsp;</pre><pre>  </pre>
<p class=code style='margin-left:19.5pt'>&lt;/configurationType&gt;</p>
<pre>&nbsp;</pre><pre>  </pre>
<p class=code style='margin-left:19.5pt'>&lt;connectionFactory</p>
<p class=code style='margin-left:19.5pt'>    profile=</p>
<p class=code style='margin-left:19.5pt' id=cstring>&quot;org.eclipse.datatools.connectivity.example.sampleConnectionProfile&quot;</p>
<p class=code style='margin-left:19.5pt' id=tag>&nbsp;</p>
<p class=code style='margin-left:19.5pt'>    name=</p>
<p class=code style='margin-left:19.5pt' id=cstring>&quot;Shared Connection
Factory&quot;</p>
<p class=code style='margin-left:19.5pt' id=tag>&nbsp;</p>
<p class=code style='margin-left:19.5pt'>    id=</p>
<p class=code style='margin-left:19.5pt' id=cstring>&quot;org.eclipse.datatools.connectivity.example.sharedConnectionFactory&quot;</p>
<p class=code style='margin-left:19.5pt' id=tag>&nbsp;</p>
<p class=code style='margin-left:19.5pt'>    class=</p>
<p class=code style='margin-left:19.5pt' id=cstring>&quot;org.eclipse.datatools.connectivity.example.SharedConnectionFactory&quot;</p>
<p class=code style='margin-left:19.5pt' id=tag>&gt;&nbsp;</p>
<pre>&nbsp;</pre><pre>  </pre>
<p class=code style='margin-left:19.5pt'>&lt;/connectionFactory&gt;</p>
<pre>&nbsp;</pre><pre>  </pre>
<p class=code style='margin-left:19.5pt'>&lt;connectionFactory</p>
<p class=code style='margin-left:19.5pt'>    profile=</p>
<p class=code style='margin-left:19.5pt' id=cstring>&quot;org.eclipse.datatools.connectivity.example.sampleConnectionProfile&quot;</p>
<p class=code style='margin-left:19.5pt' id=tag>&nbsp;</p>
<p class=code style='margin-left:19.5pt'>    name=</p>
<p class=code style='margin-left:19.5pt' id=cstring>&quot;Ping Connection
Factory&quot;</p>
<p class=code style='margin-left:19.5pt' id=tag>&nbsp;</p>
<p class=code style='margin-left:19.5pt'>    id=</p>
<p class=code style='margin-left:19.5pt' id=cstring>&quot;org.eclipse.datatools.connectivity.connectionFactory.pingFactory&quot;</p>
<p class=code style='margin-left:19.5pt' id=tag>&nbsp;</p>
<p class=code style='margin-left:19.5pt'>    class=</p>
<p class=code style='margin-left:19.5pt' id=cstring>&quot;org.eclipse.datatools.connectivity.example.SharedConnectionFactory&quot;</p>
<p class=code style='margin-left:19.5pt' id=tag>&gt;&nbsp;</p>
<pre>&nbsp;</pre><pre>  </pre>
<p class=code style='margin-left:19.5pt'>&lt;/connectionFactory&gt;</p>
<pre>&nbsp;</pre><pre>  </pre>
<p class=code style='margin-left:19.5pt'>&lt;profileExtension</p>
<p class=code style='margin-left:19.5pt'>    profile=</p>
<p class=code style='margin-left:19.5pt' id=cstring>&quot;org.eclipse.datatools.connectivity.example.sampleConnectionProfile&quot;</p>
<p class=code style='margin-left:19.5pt' id=tag>&nbsp;</p>
<p class=code style='margin-left:19.5pt'>    name=</p>
<p class=code style='margin-left:19.5pt' id=cstring>&quot;Sample Extraneous
Properties&quot;</p>
<p class=code style='margin-left:19.5pt' id=tag>&nbsp;</p>
<p class=code style='margin-left:19.5pt'>    id=</p>
<p class=code style='margin-left:19.5pt' id=cstring>&quot;org.eclipse.datatools.connectivity.example.sampleConnectionProfileExtension&quot;</p>
<p class=code style='margin-left:19.5pt' id=tag>&gt;&nbsp;</p>
<pre>&nbsp;</pre><pre>  </pre>
<p class=code style='margin-left:19.5pt'>&lt;/profileExtension&gt;</p>
<pre>&nbsp;</pre><pre>  </pre>
<p class=code style='margin-left:19.5pt'>&lt;connectionProfile</p>
<p class=code style='margin-left:19.5pt'>    configurationType=</p>
<p class=code style='margin-left:19.5pt' id=cstring>&quot;org.eclipse.datatools.connectivity.example.sampleConfigurationType&quot;</p>
<p class=code style='margin-left:19.5pt' id=tag>&nbsp;</p>
<p class=code style='margin-left:19.5pt'>    name=</p>
<p class=code style='margin-left:19.5pt' id=cstring>&quot;Sample Connection
Profile&quot;</p>
<p class=code style='margin-left:19.5pt' id=tag>&nbsp;</p>
<p class=code style='margin-left:19.5pt'>    icon=</p>
<p class=code style='margin-left:19.5pt' id=cstring>&quot;icons/sample.gif&quot;</p>
<p class=code style='margin-left:19.5pt' id=tag>&nbsp;</p>
<p class=code style='margin-left:19.5pt'>    category=</p>
<p class=code style='margin-left:19.5pt' id=cstring>&quot;org.eclipse.datatools.connectivity.example.sampleCategory&quot;</p>
<p class=code style='margin-left:19.5pt' id=tag>&nbsp;</p>
<p class=code style='margin-left:19.5pt'>    id=</p>
<p class=code style='margin-left:19.5pt' id=cstring>&quot;org.eclipse.datatools.connectivity.example.sampleConnectionProfile&quot;</p>
<p class=code style='margin-left:19.5pt' id=tag>&gt;&nbsp;</p>
<pre>&nbsp;</pre><pre>  </pre>
<p class=code style='margin-left:19.5pt'>&lt;/connectionProfile&gt;</p>
<pre>&nbsp;</pre><pre> </pre>
<p class=code style='margin-left:19.5pt'>&lt;/extension&gt;</p>
<pre>&nbsp;</pre>
<h6 style='margin-top:3.0pt;margin-right:0in;margin-bottom:11.0pt;margin-left:
0in;vertical-align:baseline' id=header><i><span style='font-size:9.0pt'>API
Information: </span></i></h6>
<p class=MsoNormal><span style='font-size:10.0pt;font-family:Arial;color:black'>[Enter
API information here.] </span></p>
<p class=MsoNormal><span style='font-size:10.0pt;font-family:Arial;color:black'><br>
<br>
</span></p>
<p>Copyright (c) 2004-2005 Sybase, Inc.</p>
<p>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 <a
href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a></p>
<p>Contributors: rcernich - initial API and implementation</p>
<p class=MsoNormal>&nbsp;</p>
</div>
</body>
</html>