Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorslewis2008-03-08 00:21:37 +0000
committerslewis2008-03-08 00:21:37 +0000
commit068872916b711fd7559607e5c02a1c0b53924e86 (patch)
tree6accb8e282fc051efde957310a4610094703ea16
parent3e715fe4b2e279780f909ee36d8d5ddb1e68f902 (diff)
downloadorg.eclipse.ecf-068872916b711fd7559607e5c02a1c0b53924e86.tar.gz
org.eclipse.ecf-068872916b711fd7559607e5c02a1c0b53924e86.tar.xz
org.eclipse.ecf-068872916b711fd7559607e5c02a1c0b53924e86.zip
regenerated extension point documentation
-rw-r--r--doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_containerFactory.html129
-rw-r--r--doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_discovery_ui_serviceAccessHandler.html20
-rw-r--r--doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_identity_namespace.html3
-rw-r--r--doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_presence_bot_chatRoomMessageHandler.html20
-rw-r--r--doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_presence_bot_chatRoomRobot.html3
-rw-r--r--doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_presence_bot_imMessageHandler.html20
-rw-r--r--doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_presence_bot_imRobot.html3
-rw-r--r--doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_presence_ui_rosterViewerDropTarget.html36
-rw-r--r--doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_provider_filetransfer_browseFileTransferProtocolFactory.html26
-rw-r--r--doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_provider_filetransfer_retrieveFileTransferProtocolFactory.html26
-rw-r--r--doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_provider_filetransfer_sendFileTransferProtocolFactory.html26
-rw-r--r--doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_server_generic_configuration.html3
-rw-r--r--doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_sharedobject_sharedObjectFactory.html135
-rw-r--r--doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_start.html19
-rw-r--r--doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_ui_configurationWizards.html36
-rw-r--r--doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_ui_connectWizards.html25
16 files changed, 12 insertions, 518 deletions
diff --git a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_containerFactory.html b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_containerFactory.html
index 449d3c018..2163b311d 100644
--- a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_containerFactory.html
+++ b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_containerFactory.html
@@ -81,135 +81,6 @@ IContainer newContainer = ContainerFactory.getDefault().createContainer('fo
</span></pre>
<p></p>
-<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>The API for this extension point is provided by the <b>org.eclipse.ecf.core.ContainerFactory.getDefault()</b> methods. Specifically, the 'createContainer' methods are to be used by clients. The functionality provided by the extension point mechanism can be used at runtime via the <b>ContainerFactory.getDefault().addDescription(ContainerTypeDescription)</b> method. Here is the IContainerFactory interface
-contract:
-
-<pre class="Example"><span class="code SchemaTag">
-/**
- * Container factory contract {@link ContainerFactory} for default
- * implementation.
- */
-public interface IContainerFactory {
- /**
- * Add a ContainerTypeDescription to the set of known ContainerDescriptions.
- *
- * @param description
- * the ContainerTypeDescription to add to this factory. Must not
- * be null.
- * @return ContainerTypeDescription the old description of the same name,
- * null if none found
- */
- public ContainerTypeDescription addDescription(ContainerTypeDescription description);
-
- /**
- * Get a collection of the ContainerDescriptions currently known to this
- * factory. This allows clients to query the factory to determine what if
- * any other ContainerDescriptions are currently registered with the
- * factory, and if so, what they are.
- *
- * @return List of ContainerTypeDescription instances
- */
- public List /* ContainerTypeDescription */ getDescriptions();
-
- /**
- * Check to see if a given named description is already contained by this
- * factory
- *
- * @param description
- * the ContainerTypeDescription to look for
- * @return true if description is already known to factory, false otherwise
- */
- public boolean containsDescription(ContainerTypeDescription description);
-
- /**
- * Get the known ContainerTypeDescription given it&apos;s name.
- *
- * @param name
- * the name to use as key to find ContainerTypeDescription
- * @return ContainerTypeDescription found. Null if not found.
- */
- public ContainerTypeDescription getDescriptionByName(String name);
-
- /**
- * Make IContainer instance. Given a ContainerTypeDescription object, a
- * String [] of argument types, and an Object [] of parameters, this method
- * will
- * &lt;p&gt;
- * &lt;ul&gt;
- * &lt;li&gt;lookup the known ContainerDescriptions to find one of matching name&lt;/li&gt;
- * &lt;li&gt;if found, will retrieve or create an IContainerInstantiator for that
- * description&lt;/li&gt;
- * &lt;li&gt;Call the IContainerInstantiator.createInstance method to return an
- * instance of IContainer&lt;/li&gt;
- * &lt;/ul&gt;
- *
- * @param description
- * the ContainerTypeDescription to use to create the instance
- * @param parameters
- * an Object [] of parameters passed to the createInstance method
- * of the IContainerInstantiator
- * @return a valid instance of IContainer
- * @throws ContainerCreateException
- */
- public IContainer createContainer(ContainerTypeDescription description,
- Object[] parameters) throws ContainerCreateException;
-
- /**
- * Make IContainer instance. Given a ContainerTypeDescription name, this
- * method will
- * &lt;p&gt;
- * &lt;ul&gt;
- * &lt;li&gt;lookup the known ContainerDescriptions to find one of matching name&lt;/li&gt;
- * &lt;li&gt;if found, will retrieve or create an IContainerInstantiator for that
- * description&lt;/li&gt;
- * &lt;li&gt;Call the IContainerInstantiator.createInstance method to return an
- * instance of IContainer&lt;/li&gt;
- * &lt;/ul&gt;
- *
- * @param descriptionName
- * the ContainerTypeDescription name to lookup
- * @return a valid instance of IContainer
- * @throws ContainerCreateException
- */
- public IContainer createContainer(String descriptionName)
- throws ContainerCreateException;
-
- /**
- * Make IContainer instance. Given a ContainerTypeDescription name, this
- * method will
- * &lt;p&gt;
- * &lt;ul&gt;
- * &lt;li&gt;lookup the known ContainerDescriptions to find one of matching name&lt;/li&gt;
- * &lt;li&gt;if found, will retrieve or create an IContainerInstantiator for that
- * description&lt;/li&gt;
- * &lt;li&gt;Call the IContainerInstantiator.createInstance method to return an
- * instance of IContainer&lt;/li&gt;
- * &lt;/ul&gt;
- *
- * @param descriptionName
- * the ContainerTypeDescription name to lookup
- * @param parameters
- * the Object [] of parameters passed to the
- * IContainerInstantiator.createInstance method
- * @return a valid instance of IContainer
- * @throws ContainerCreateException
- */
- public IContainer createContainer(String descriptionName, Object[] parameters)
- throws ContainerCreateException;
-
- /**
- * Remove given description from set known to this factory.
- *
- * @param description
- * the ContainerTypeDescription to remove
- * @return the removed ContainerTypeDescription, null if nothing removed
- */
- public ContainerTypeDescription removeDescription(
- ContainerTypeDescription description);
-}
-</span></pre>
-<p></p>
-
<h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6>The supplied implementations of this extension point are:
org.eclipse.ecf.provider.generic.GenericContainerInstantiator
diff --git a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_discovery_ui_serviceAccessHandler.html b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_discovery_ui_serviceAccessHandler.html
index 9c40fe511..0ab097ec3 100644
--- a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_discovery_ui_serviceAccessHandler.html
+++ b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_discovery_ui_serviceAccessHandler.html
@@ -105,26 +105,6 @@ public class HttpServiceAccessHandler implements IServiceAccessHandler {
</span></pre>
<p></p>
-<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>The IServiceAccessHandler interface must be implemented by the class defined in the extension:
-
-<pre class="Example"><span class="code SchemaTag">
-public interface IServiceAccessHandler {
-
- /**
- * Get the menu items to contribute for the given IServiceInfo. Implementers should return
- * a non-null array of IContributionItem instances (menus or menu items). These will
- * be added to the context menu of the service entry identified by the given service info.
- *
- * @param serviceInfo the IServiceInfo for the contributions. Will not be &lt;code&gt;null&lt;/code&gt;.
- * @return IContributionItem [] any contribution to the context menu for the given service info. If &lt;code&gt;null&lt;/code&gt;,
- * then no items will be added to the context menu.
- */
- public IContributionItem[] getContributionsForService(IServiceInfo serviceInfo);
-
-}
-</span></pre>
-<p></p>
-
<h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6>None.
<p></p>
diff --git a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_identity_namespace.html b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_identity_namespace.html
index 83ce0b387..4288ab297 100644
--- a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_identity_namespace.html
+++ b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_identity_namespace.html
@@ -77,9 +77,6 @@ ID newID = IDFactory.getDefault().createID(new URI("testnamespace:email@emailser
</span></pre>
<p></p>
-<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>The client API for this extension point is provided by the <b>org.eclipse.ecf.core.IIDFactory.createID</b> methods. A valid IIDFactory is provided by the by the static <b>org.eclipse.ecf.core.identityIDFactory.getDefault()</b> method.
-<p></p>
-
<h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6>The following implementations of this extension point are provided by ECF itself:
<p>
StringID -- A namespace of ID instances that are implemented by <b>org.eclipse.ecf.core.identity.StringID</b>
diff --git a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_presence_bot_chatRoomMessageHandler.html b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_presence_bot_chatRoomMessageHandler.html
index d72af54fb..0a44d6952 100644
--- a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_presence_bot_chatRoomMessageHandler.html
+++ b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_presence_bot_chatRoomMessageHandler.html
@@ -59,26 +59,6 @@ Note that the given chatroomrobotid=<b>org.eclipse.ecf.presence.bot.defaultbot</
</span></pre>
<p></p>
-<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>The class implementation provided in extension point must implement the following interface:
-
-<pre class="Example"><span class="code SchemaTag">
-public interface IChatRoomMessageHandler extends IChatRoomContainerAdvisor {
-
- /**
- * This method is called when a {@link IChatRoomMessage} is received.
- *
- * @param message
- * the {@link IChatRoomMessage} received. Will not be
- * &lt;code&gt;null&lt;/code&gt;. Implementers should not block the
- * calling thread. Any methods on the given &lt;code&gt;message&lt;/code&gt;
- * parameter may be called.
- */
- public void handleRoomMessage(IChatRoomMessage message);
-
-}
-</span></pre>
-<p></p>
-
<h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6>No supplied implementation.
<p></p>
diff --git a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_presence_bot_chatRoomRobot.html b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_presence_bot_chatRoomRobot.html
index 94692a7c6..2d2a3fc8f 100644
--- a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_presence_bot_chatRoomRobot.html
+++ b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_presence_bot_chatRoomRobot.html
@@ -80,9 +80,6 @@ using the id for the chatRoomRobot given above. For example:
</span></pre>
<p></p>
-<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>See the API information for the chatRoomMessageHandler
-<p></p>
-
<h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6>No supplied implementation.
<p></p>
diff --git a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_presence_bot_imMessageHandler.html b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_presence_bot_imMessageHandler.html
index 0e0cb3610..25c20724a 100644
--- a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_presence_bot_imMessageHandler.html
+++ b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_presence_bot_imMessageHandler.html
@@ -58,26 +58,6 @@ Note that the given imrobotid=<b>org.eclipse.ecf.presence.imbot.defaultbot</b> m
</span></pre>
<p></p>
-<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>The class implementation provided in extension point must implement the following interface:
-
-<pre class="Example"><span class="code SchemaTag">
-public interface IIMMessageHandler extends IContainerAdvisor {
-
- /**
- * This method is called when a {@link IChatMessage} is received.
- *
- * @param message
- * the {@link IChatMessage} received. Will not be
- * &lt;code&gt;null&lt;/code&gt;. Implementers should not block the
- * calling thread. Any methods on the given &lt;code&gt;message&lt;/code&gt;
- * parameter may be called.
- */
- public void handleIMMessage(IChatMessage message);
-
-}
-</span></pre>
-<p></p>
-
<h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6>No supplied implementation.
<p></p>
diff --git a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_presence_bot_imRobot.html b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_presence_bot_imRobot.html
index bca42402a..1fd3ca56c 100644
--- a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_presence_bot_imRobot.html
+++ b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_presence_bot_imRobot.html
@@ -65,9 +65,6 @@ using the id for the imrobot given above. For example:
</span></pre>
<p></p>
-<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>See the API information for the immessagehandler.
-<p></p>
-
<h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6>No supplied implementation.
<p></p>
diff --git a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_presence_ui_rosterViewerDropTarget.html b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_presence_ui_rosterViewerDropTarget.html
index cdcd9fea9..3b4dfbffc 100644
--- a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_presence_ui_rosterViewerDropTarget.html
+++ b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_presence_ui_rosterViewerDropTarget.html
@@ -42,42 +42,6 @@ Drop target element.</p>
</span></pre>
<p></p>
-<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6><pre class="Example"><span class="code SchemaTag">
-/**
- * Roster viewer drop target. This interface defines the
- * required methods for implementers of the rosterViewerDropTarget
- * extension point.
- */
-public interface IRosterViewerDropTarget {
-
- /**
- * Validates dropping on the given roster item. This method is called whenever some
- * aspect of the drop operation changes.
- *
- * @param target the object that the mouse is currently hovering over, or
- * &lt;code&gt;null&lt;/code&gt; if the mouse is hovering over empty space
- * @param operation the current drag operation (copy, move, etc.)
- * @param transferType the current transfer type
- * @return &lt;code&gt;true&lt;/code&gt; if the drop is valid, and &lt;code&gt;false&lt;/code&gt;
- * otherwise
- */
- public boolean validateDrop(IRosterItem rosterItem, int operation,
- TransferData transferType);
-
- /**
- * Performs any work associated with the drop.
- *
- * @param data the drop data
- * @return &lt;code&gt;true&lt;/code&gt; if the drop was successful, and
- * &lt;code&gt;false&lt;/code&gt; otherwise
- */
-
- public boolean performDrop(Object data);
-}
-
-</span></pre>
-<p></p>
-
<h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6>No supplied implementation.
<p></p>
diff --git a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_provider_filetransfer_browseFileTransferProtocolFactory.html b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_provider_filetransfer_browseFileTransferProtocolFactory.html
index 81bd2939b..3a9ff5ff8 100644
--- a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_provider_filetransfer_browseFileTransferProtocolFactory.html
+++ b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_provider_filetransfer_browseFileTransferProtocolFactory.html
@@ -23,7 +23,7 @@
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.browseFileTransferProtocolFactory">browseFileTransferProtocolFactory</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST browseFileTransferProtocolFactory</p>
-<p class="code SchemaDtdAttlist">protocol&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">class&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED&gt;</p>
+<p class="code SchemaDtdAttlist">protocol&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">class&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">priority&nbsp;CDATA #IMPLIED&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
Browse remote file system protocol factory extention point</p>
@@ -31,39 +31,21 @@ Browse remote file system protocol factory extention point</p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>protocol</b> - Protocol to define factory for. For example, http, https, ftp, bittorrent, my.favorite.protocol.</li>
<li><b>class</b> - The factory class to use for given protocol. Must implement <b>org.eclipse.ecf.filetransfer.service.IRemoteFileSystemBrowserFactory</b></li>
+<li><b>priority</b> - Priority relative to other browseFileTransferProtocolFactory extensions. Valid priorities are 0 (highest priority) to 100 (lowest priority). If this optional attribute is not specified, it will automatically be assigned a default priority of 100.</li>
</ul>
<br><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6><pre class="Example"><span class="code SchemaTag">
&lt;extension
point=</span><span class="code SchemaCstring">&quot;org.eclipse.ecf.provider.filetransfer.browseFileTransferProtocolFactory&quot;</span><span class="code SchemaTag">&gt;
&lt;browseFileTransferProtocolFactory
class=</span><span class="code SchemaCstring">&quot;org.eclipse.ecf.provider.filetransfer.ssh.ScpBrowseFileTransferFactory&quot;</span><span class="code SchemaTag">
- protocol=</span><span class="code SchemaCstring">&quot;scp&quot;</span><span class="code SchemaTag">&gt;
+ protocol=</span><span class="code SchemaCstring">&quot;scp&quot;</span><span class="code SchemaTag">
+ priority=</span><span class="code SchemaCstring">&quot;90&quot;</span><span class="code SchemaTag">&gt;
&lt;/browseFileTransferProtocolFactory&gt;
&lt;/extension&gt;
</span></pre>
<p></p>
-<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>Here is the <b>org.eclipse.ecf.filetransfer.service.IRemoteFileSystemBrowserFactory</b>
-
-<pre class="Example"><span class="code SchemaTag">
-/**
- * Remote file browser factory. This service interface is used by clients to
- * create a new IRemoteFileSystemBrowser instance.
- */
-public interface IRemoteFileSystemBrowserFactory {
-
- /**
- * Get new instance of IRemoteFileSystemBrowser.
- *
- * @return IRemoteFileSystemBrowser for initiating a retrieval of a remote file.
- */
- public IRemoteFileSystemBrowser newInstance();
-
-}
-</span></pre>
-<p></p>
-
<h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6>None
<p></p>
diff --git a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_provider_filetransfer_retrieveFileTransferProtocolFactory.html b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_provider_filetransfer_retrieveFileTransferProtocolFactory.html
index 5ed7cf8f2..ff57a3b5d 100644
--- a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_provider_filetransfer_retrieveFileTransferProtocolFactory.html
+++ b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_provider_filetransfer_retrieveFileTransferProtocolFactory.html
@@ -23,7 +23,7 @@
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.retrieveFileTransferProtocolFactory">retrieveFileTransferProtocolFactory</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST retrieveFileTransferProtocolFactory</p>
-<p class="code SchemaDtdAttlist">protocol&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">class&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED&gt;</p>
+<p class="code SchemaDtdAttlist">protocol&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">class&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">priority&nbsp;CDATA #IMPLIED&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
Retrieve file transfer protocol factory extention point</p>
@@ -31,13 +31,15 @@ Retrieve file transfer protocol factory extention point</p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>protocol</b> - Protocol to define factory for. For example, http, https, ftp, bittorrent, my.favorite.protocol.</li>
<li><b>class</b> - The factory class to use for given protocol. Must implement <b>org.eclipse.ecf.filetransfer.service.IRetrieveFileTransferFactory</b></li>
+<li><b>priority</b> - Priority relative to other retrieveFileTransferProtocolFactory extensions. Valid priorities are 0 (highest priority) to 100 (lowest priority). If this optional attribute is not specified, it will automatically be assigned a default priority of 100.</li>
</ul>
<br><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6><pre class="Example"><span class="code SchemaTag">
&lt;extension
point=</span><span class="code SchemaCstring">&quot;org.eclipse.ecf.provider.filetransfer.retrieveFileTransferProtocolFactory&quot;</span><span class="code SchemaTag">&gt;
&lt;retrieveFileTransferProtocolFactory
class=</span><span class="code SchemaCstring">&quot;org.eclipse.ecf.provider.filetransfer.httpclient.HttpClientRetrieveFileTransferFactory&quot;</span><span class="code SchemaTag">
- protocol=</span><span class="code SchemaCstring">&quot;http&quot;</span><span class="code SchemaTag">&gt;
+ protocol=</span><span class="code SchemaCstring">&quot;http&quot;</span><span class="code SchemaTag">
+ priority=</span><span class="code SchemaCstring">&quot;10&quot;</span><span class="code SchemaTag">&gt;
&lt;/retrieveFileTransferProtocolFactory&gt;
&lt;retrieveFileTransferProtocolFactory
class=</span><span class="code SchemaCstring">&quot;org.eclipse.ecf.provider.filetransfer.httpclient.HttpClientRetrieveFileTransferFactory&quot;</span><span class="code SchemaTag">
@@ -48,26 +50,6 @@ Retrieve file transfer protocol factory extention point</p>
</span></pre>
<p></p>
-<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>Here is the <b>org.eclipse.ecf.filetransfer.service.IRetrieveFileTransferFactory</b>
-
-<pre class="Example"><span class="code SchemaTag">
-/**
- * Retrieve file transfer factory. This service interface is used by clients to
- * create a new IRetrieveFileTransfer instance.
- */
-public interface IRetrieveFileTransferFactory {
-
- /**
- * Get new instance of IRetrieveFileTransfer.
- *
- * @return IRetrieveFileTransfer for a given file transfer
- */
- public IRetrieveFileTransfer newInstance();
-
-}
-</span></pre>
-<p></p>
-
<h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6>None
<p></p>
diff --git a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_provider_filetransfer_sendFileTransferProtocolFactory.html b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_provider_filetransfer_sendFileTransferProtocolFactory.html
index 23c476035..202c04642 100644
--- a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_provider_filetransfer_sendFileTransferProtocolFactory.html
+++ b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_provider_filetransfer_sendFileTransferProtocolFactory.html
@@ -23,7 +23,7 @@
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.sendFileTransferProtocolFactory">sendFileTransferProtocolFactory</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST sendFileTransferProtocolFactory</p>
-<p class="code SchemaDtdAttlist">protocol&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">class&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED&gt;</p>
+<p class="code SchemaDtdAttlist">protocol&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">class&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">priority&nbsp;CDATA #IMPLIED&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
Send file transfer protocol factory extention point</p>
@@ -31,39 +31,21 @@ Send file transfer protocol factory extention point</p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>protocol</b> - Protocol to define factory for. For example, http, https, ftp, bittorrent, my.favorite.protocol.</li>
<li><b>class</b> - The factory class to use for given protocol. Must implement <b>org.eclipse.ecf.filetransfer.service.ISendFileTransferFactory</b></li>
+<li><b>priority</b> - Priority relative to other sendFileTransferProtocolFactory extensions. Valid priorities are 0 (highest priority) to 100 (lowest priority). If this optional attribute is not specified, it will automatically be assigned a default priority of 100.</li>
</ul>
<br><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6><pre class="Example"><span class="code SchemaTag">
&lt;extension
point=</span><span class="code SchemaCstring">&quot;org.eclipse.ecf.provider.filetransfer.sendFileTransferProtocolFactory&quot;</span><span class="code SchemaTag">&gt;
&lt;sendFileTransferProtocolFactory
class=</span><span class="code SchemaCstring">&quot;org.eclipse.ecf.provider.filetransfer.ssh.ScpOutgoingFileTransferFactory&quot;</span><span class="code SchemaTag">
- protocol=</span><span class="code SchemaCstring">&quot;scp&quot;</span><span class="code SchemaTag">&gt;
+ protocol=</span><span class="code SchemaCstring">&quot;scp&quot;</span><span class="code SchemaTag">
+ priority=</span><span class="code SchemaCstring">&quot;50&quot;</span><span class="code SchemaTag">&gt;
&lt;/sendFileTransferProtocolFactory&gt;
&lt;/extension&gt;
</span></pre>
<p></p>
-<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>Here is the <b>org.eclipse.ecf.filetransfer.service.IRetrieveFileTransferFactory</b>
-
-<pre class="Example"><span class="code SchemaTag">
-/**
- * Retrieve file transfer factory. This service interface is used by clients to
- * create a new IRetrieveFileTransfer instance.
- */
-public interface IRetrieveFileTransferFactory {
-
- /**
- * Get new instance of IRetrieveFileTransfer.
- *
- * @return IRetrieveFileTransfer for a given file transfer
- */
- public IRetrieveFileTransfer newInstance();
-
-}
-</span></pre>
-<p></p>
-
<h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6>None
<p></p>
diff --git a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_server_generic_configuration.html b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_server_generic_configuration.html
index 73679eb6b..e36f97f0a 100644
--- a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_server_generic_configuration.html
+++ b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_server_generic_configuration.html
@@ -63,9 +63,6 @@ A specific named group for the parent connector. e.g. 'server' in ecftcp://loca
Produces a server with groupID: ecftcp://localhost:3333/groupName
<p></p>
-<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>No public programmatic API
-<p></p>
-
<br>
<p class="note SchemaCopyright">
Copyright (c) 2004 Composent, Inc. and others.
diff --git a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_sharedobject_sharedObjectFactory.html b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_sharedobject_sharedObjectFactory.html
index a1c5db588..fa3a0c571 100644
--- a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_sharedobject_sharedObjectFactory.html
+++ b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_sharedobject_sharedObjectFactory.html
@@ -112,141 +112,6 @@ ISharedObject obj = SharedObjectFactory.getDefault().createSharedObject("ecf.tes
</span></pre>
<p></p>
-<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>The API for accessing the functionality provided via extensions is via <b>org.eclipse.ecf.core.sharedobject.SharedObjectFactory.getDefault()</b> methods. Specifically, the <b>org.eclipse.ecf.core.sharedobject.ISharedObjectFactory.createSharedObject()</b> methods are to be used to create shared
-object instances, where extensions implement the actual shared object creation
-
-Here is the <b>org.eclipse.ecf.core.sharedobject.ISharedObjectFactory</b> contract implemented by the <b>org.eclipse.ecf.core.sharedobject.SharedObjectFactory</b>:
-
-<pre class="Example"><span class="code SchemaTag">
-public interface ISharedObjectFactory {
- /*
- * Add a SharedObjectTypeDescription to the set of known
- * SharedObjectTypeDescriptions.
- *
- * @param scd the SharedObjectTypeDescription to add to this factory @return
- * SharedObjectTypeDescription the old description of the same name, null if
- * none found
- */
- public SharedObjectTypeDescription addDescription(
- SharedObjectTypeDescription description);
-
- /**
- * Get a collection of the SharedObjectTypeDescriptions currently known to
- * this factory. This allows clients to query the factory to determine what
- * if any other SharedObjectTypeDescriptions are currently registered with
- * the factory, and if so, what they are.
- *
- * @return List of SharedObjectTypeDescription instances. Will not be null.
- */
- public List getDescriptions();
-
- /**
- * Check to see if a given named description is already contained by this
- * factory
- *
- * @param description
- * the SharedObjectTypeDescription to look for
- * @return true if description is already known to factory, false otherwise
- */
- public boolean containsDescription(SharedObjectTypeDescription description);
-
- /**
- * Get the known SharedObjectTypeDescription given it&apos;s name.
- *
- * @param name
- * @return SharedObjectTypeDescription found. Null if description not found.
- * @throws SharedObjectCreateException
- */
- public SharedObjectTypeDescription getDescriptionByName(String name)
- throws SharedObjectCreateException;
-
- /**
- * Create ISharedObject instance. Given a SharedObjectTypeDescription
- * object, a String [] of argument types, and an Object [] of parameters,
- * this method will
- * &lt;p&gt;
- * &lt;ul&gt;
- * &lt;li&gt;lookup the known SharedObjectTypeDescriptions to find one of
- * matching name&lt;/li&gt;
- * &lt;li&gt;if found, will retrieve or create an ISharedObjectInstantiator for
- * that description&lt;/li&gt;
- * &lt;li&gt;Call the ISharedObjectInstantiator.createInstance method to return
- * an instance of ISharedObject&lt;/li&gt;
- * &lt;/ul&gt;
- *
- * @param typeDescription
- * the SharedObjectTypeDescription to use to create the instance
- * @param args
- * an Object [] of arguments passed to the createInstance method
- * of the ISharedObjectInstantiator
- * @return a valid instance of ISharedObject. Will not be null.
- * @throws SharedObjectCreateException
- * if shared object cannot be created
- */
- public ISharedObject createSharedObject(
- SharedObjectTypeDescription typeDescription, Object[] args)
- throws SharedObjectCreateException;
-
- /**
- * Create ISharedObject instance. Given a SharedObjectTypeDescription name,
- * this method will
- * &lt;p&gt;
- * &lt;ul&gt;
- * &lt;li&gt;lookup the known SharedObjectTypeDescriptions to find one of
- * matching name&lt;/li&gt;
- * &lt;li&gt;if found, will retrieve or create an ISharedObjectInstantiator for
- * that description&lt;/li&gt;
- * &lt;li&gt;Call the ISharedObjectInstantiator.createInstance method to return
- * an instance of ISharedObject&lt;/li&gt;
- * &lt;/ul&gt;
- *
- * @param descriptionName
- * the SharedObjectTypeDescription name to lookup
- * @return a valid instance of ISharedObject. Will not be null.
- * @throws SharedObjectCreateException
- */
- public ISharedObject createSharedObject(String descriptionName)
- throws SharedObjectCreateException;
-
- /**
- * Create ISharedObject instance. Given a SharedObjectTypeDescription name,
- * this method will
- * &lt;p&gt;
- * &lt;ul&gt;
- * &lt;li&gt;lookup the known SharedObjectTypeDescriptions to find one of
- * matching name&lt;/li&gt;
- * &lt;li&gt;if found, will retrieve or create an ISharedObjectInstantiator for
- * that description&lt;/li&gt;
- * &lt;li&gt;Call the ISharedObjectInstantiator.createInstance method to return
- * an instance of ISharedObject&lt;/li&gt;
- * &lt;/ul&gt;
- *
- * @param descriptionName
- * the SharedObjectTypeDescription name to lookup
- * @param args
- * the Object [] of arguments passed to the
- * ISharedObjectInstantiator.createInstance method
- * @return a valid instance of IContainer. Will not be null.
- * @throws SharedObjectCreateException
- */
- public ISharedObject createSharedObject(String descriptionName,
- Object[] args) throws SharedObjectCreateException;
-
- /**
- * Remove given description from set known to this factory.
- *
- * @param scd
- * the SharedObjectTypeDescription to remove
- * @return the removed SharedObjectTypeDescription, null if nothing removed
- */
- public SharedObjectTypeDescription removeDescription(
- SharedObjectTypeDescription scd);
-}
-</span></pre>
-
-See the "Examples" page for an example usage of the extension point.
-<p></p>
-
<br>
<p class="note SchemaCopyright">
Copyright (c) 2004 Composent, Inc. and others.
diff --git a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_start.html b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_start.html
index 47655054d..67cbe74c9 100644
--- a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_start.html
+++ b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_start.html
@@ -62,25 +62,6 @@ public class CollabStart implements IECFStart {
</span></pre>
<p></p>
-<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6><b>org.eclipse.ecf.startup.IECFStartup</b> interface:
-
-<pre class="Example"><span class="code SchemaTag">
-/**
- * Interface that must be implemented by extensions of the org.eclipse.ecf.start
- * extension point. Such extensions will have their start method called by a new
- * Job upon ECF startup.
- */
-public interface IECFStart {
- /**
- * Run some startup task.
- *
- * @return IStatus the status of the start
- */
- public IStatus run(IProgressMonitor monitor);
-}
-</span></pre>
-<p></p>
-
<h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6>No implementation supplied for this extensinion point.
<p></p>
diff --git a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_ui_configurationWizards.html b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_ui_configurationWizards.html
index a0b773207..a2dc47c56 100644
--- a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_ui_configurationWizards.html
+++ b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_ui_configurationWizards.html
@@ -76,42 +76,6 @@ of the export engine functionality.</p>
</span></pre>
<p></p>
-<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>The "class" attribute (required) must have a class that implements the <b>org.eclipse.ecf.ui.IConfigurationWizard</b> interface:
-
-<pre class="Example"><span class="code SchemaTag">
-/**
- * Required interface for implementing
- * &lt;b&gt;org.eclipse.ecf.ui.configurationWizards&lt;/b&gt; extension point. Extensions
- * for extension point &lt;b&gt;org.eclipse.ecf.ui.configurationWizards&lt;/b&gt; must
- * provide a class implementing this interface.
- */
-public interface IConfigurationWizard extends IWizard {
-
- /**
- * Initialize the wizard with the workbench and the desired container type
- * description
- *
- * @param workbench
- * the workbench for the wizard. Will not be null.
- * @param description
- * the {@link ContainerTypeDescription} to use to
- * create/configure the new IContainer instance
- */
- public void init(IWorkbench workbench,
- ContainerTypeDescription description);
-
- /**
- * Get result of configuration.
- *
- * @return ContainerHolder the result of the configuration. If null, the container could not be
- * created.
- */
- public ContainerHolder getConfigurationResult();
-}
-
-</span></pre>
-<p></p>
-
<br>
<p class="note SchemaCopyright">
/****************************************************************************
diff --git a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_ui_connectWizards.html b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_ui_connectWizards.html
index 8c826732e..634832791 100644
--- a/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_ui_connectWizards.html
+++ b/doc/bundles/org.eclipse.ecf.doc/html/reference/extension-points/org_eclipse_ecf_ui_connectWizards.html
@@ -76,31 +76,6 @@ of the export engine functionality.</p>
</span></pre>
<p></p>
-<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>The "class" attribute (required) must have a class that implements the <b>org.eclipse.ecf.ui.IConfigurationWizard</b> interface:
-
-<pre class="Example"><span class="code SchemaTag">
-/**
- * Required interface for implementing &lt;b&gt;org.eclipse.ecf.ui.connectWizards&lt;/b&gt;
- * extension point. Extensions for extension point
- * &lt;b&gt;org.eclipse.ecf.ui.connectWizards&lt;/b&gt; must provide a class implementing
- * this interface.
- */
-public interface IConnectWizard extends IWizard {
-
- /**
- * Initialize the connect wizard.
- *
- * @param workbench
- * the currently working workbench instance. Will not be null.
- * @param container
- * the container that is to be connected. Will not be null.
- */
- public void init(IWorkbench workbench, IContainer container);
-}
-
-</span></pre>
-<p></p>
-
<br>
<p class="note SchemaCopyright">
/****************************************************************************

Back to the top