blob: 37054801e7b6c988cc1c8504babf2d8b7bdaac9c [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<style type="text/css">@import url("../../book.css");</style>
<style type="text/css">@import url("../../schema.css");</style>
<H1 style="text-align:center">Publishers</H1>
<h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>org.eclipse.wst.server.core.publishers<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Since: </h6>3.0
<h6 class="CaptionFigColumn SchemaHeader">Description: </h6>This extension point is used to provide a task that is run while publishing to a server.
<b>Provisional API:</b>
This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6>
<p class="code SchemaDtd">&lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.publisher">publisher</a>+)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST extension</p>
<p class="code SchemaDtdAttlist">point&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class="code SchemaDtdAttlist">name&nbsp;&nbsp;CDATA #IMPLIED&gt;</p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>point</b> - a fully qualified identifier of the target extension point</li>
<li><b>id</b> - an optional identifier of the extension instance</li>
<li><b>name</b> - an optional name of the extension instance</li>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.publisher">publisher</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST publisher</p>
<p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">typeIds&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">description&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">class&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">order&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED&gt;</p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>id</b> - specifies a unique identifier for this extension point</li>
<li><b>typeIds</b> - a comma separated list of server type ids that this task may apply to. Used for memory & performance reasons</li>
<li><b>name</b> - a translatable name used to identify this publisher</li>
<li><b>description</b> - a translatable description of this publisher</li>
<li><b>class</b> - specifies the fully qualified name of the Java class that implements <samp>org.eclipse.wst.server.core.model.PublisherDelegate</samp>.
Publish instances of this type will delegate to instances of this class.</li>
<li><b>order</b> - an integer that specifies the order that the publisher is processed. if the value is less than 0 it will be processed before calling the server behaviour delegate's publishing methods, and may modify the workspace. if the value is more than 0, it will be called after the server behaviour delegate's publishing methods and may not modify the workspace</li>
<br><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6>The following is an example of a publisher extension point:
<pre class="Example"><span class="code SchemaTag">
<p class="note SchemaCopyright">
Copyright (c) 2008 IBM Corporation and others.<br>
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=""></a>