Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Platform.doc.isv #2428

Merged
merged 4 commits into from
Oct 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<link rel="stylesheet" type="text/css" HREF="../book.css">
</HEAD>
<BODY>
<h1>Platform Ant support</h1>
<h1>Platform Ant Support</h1>
<p>Ant is a Java-based build tool that uses XML-based configuration files to
describe build tasks.&nbsp; The Eclipse platform allows you to run Ant buildfiles
from your plug-in and contribute new Ant <a href="../reference/extension-points/org_eclipse_ant_core_antTasks.html">tasks</a>,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
</HEAD>
<BODY>
<h2>
Contributing tasks and types</h2>
Contributing Tasks and Types</h2>
<p>When your plug-in contributes Ant tasks and types, the tasks and types have access to all
of the classes inside the contributing plug-in. For example, the <b>eclipse.refreshLocal</b> task
contributed by <b>org.eclipse.core.resources</b> plug-in is
Expand Down Expand Up @@ -72,7 +72,7 @@ <h2>


<h3 >
Important rules when contributing tasks and types</h3>
Important Rules When Contributing Tasks and Types</h3>


<p>
Expand All @@ -87,7 +87,7 @@ <h3 >


<A NAME="jar"></A>
<h3>Why a separate JAR for tasks and types?</h3>
<h3>Why a Separate JAR for Tasks and Types?</h3>
<p>
There are basically two requirements for running Ant in Eclipse that do not fit
the plug-in model very well:</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
</HEAD>
<BODY>
<h2>
Developing Ant tasks and types within Eclipse</h2>
Developing Ant Tasks and Types Within Eclipse</h2>
<p>
Ant tasks and types must be loaded by an Ant classloader instead of a plug-in
classloader. This can cause problems when developing and testing new tasks and types
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
</HEAD>
<BODY>
<h2>
Ant tasks provided by the platform</h2>
Ant Tasks Provided by the Platform</h2>
<p>The platform provides some useful Ant tasks and properties that
interact with the workspace. They can be used with buildfiles that are set to build within the same JRE as the workspace.</p>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
</HEAD>
<BODY>
<h2>
Expanding the Ant classpath</h2>
Expanding the Ant Classpath</h2>
<p>Plug-ins can contribute
<a href="../reference/extension-points/org_eclipse_ant_core_extraClasspathEntries.html">extra JAR files</a>
to the Ant classpath. The plug-in contributing the JARs is added to the Ant classpath, and as a result,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
</HEAD>
<BODY>
<h2>
Running Ant buildfiles programmatically</h2>
Running Ant Buildfiles Programmatically</h2>
<p>
The Ant support built into Eclipse allows plug-ins to programmatically run Ant buildfiles.
This is done via the <a href="../reference/api/org/eclipse/ant/core/AntRunner.html"><b>AntRunner</b></a>
Expand Down Expand Up @@ -44,7 +44,7 @@ <h2>
</p>

<h3>
Special care for native libraries if build occurs within the same JRE as the workspace</h3>
Special Care for Native Libraries if Build Occurs Within the Same JRE as the Workspace</h3>
<P >
Every time an Ant buildfile runs in Eclipse a new classloader is created. Since a library can only be
loaded by one classloader in Java, tasks making use of native libraries could run into problems during
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<link rel="stylesheet" type="text/css" HREF="../book.css">
</HEAD>
<BODY>
<h1>Platform architecture </h1>
<h1>Platform Architecture </h1>

<p>The Eclipse platform is structured around the concept of <b>plug-ins</b>. Plug-ins are
structured bundles of code and/or data that contribute functionality to the system. Functionality can be
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
</head>
<BODY>

<h1>Signed bundles and protecting against malicious code</h1>
<h1>Signed Bundles and Protecting Against Malicious Code</h1>

<h2>Overview</h2>

Expand All @@ -21,7 +21,7 @@ <h2>Overview</h2>
<li>Authorize the installation and runtime behaviour of code</li>
</ol>

<h2>Authenticating code packaged in a bundle</h2>
<h2>Authenticating Code Packaged in a Bundle</h2>

<p>The first step towards protecting the platform from malicious code is 'authentication', or proving the identity of the person who is distributing the code in a bundle. This is facilitated by the use of a Public Key Infrastructure (PKI), where users are issued public certificates and private keys that uniquely identify them. Another common and well know use of certificates is the SSL protocol by which secured web sites are accessed.</p>

Expand All @@ -45,7 +45,7 @@ <h2>Authenticating code packaged in a bundle</h2>
<li><a href="http://www.onjava.com/pub/a/onjava/2001/04/12/signing_jar.html?page=1">http://www.onjava.com/pub/a/onjava/2001/04/12/signing_jar.html?page=1</a></li>
</ul>

<h2>Signing code packaged in a bundle</h2>
<h2>Signing Code Packaged in a Bundle</h2>

<p>In order to sign a bundle, an Eclipse developer has a handful of options:</p>

Expand All @@ -67,7 +67,7 @@ <h2>Signing code packaged in a bundle</h2>
</li>
</ol>

<h2>Verifying signed code packaged in a bundle</h2>
<h2>Verifying Signed Code Packaged in a Bundle</h2>

<p>As with generation of signed bundles, verification of signed code can be done by an Eclipse developer in several ways:</p>

Expand All @@ -87,7 +87,7 @@ <h2>Verifying signed code packaged in a bundle</h2>
</li>
</ol>

<h1>Authorization of signed code</h1>
<h1>Authorization of Signed Code</h1>

<p>Once the signer(s) of code packaged in a bundle is established via authentication, the next step to perform is 'authorization'. Authorization is the process by which the system decides whether a piece of code should be able to perform a specified action. Although the Java runtime supports a fine grained runtime permission model, Eclipse also supports two additional enforcement points with respect to signed code packaged in bundles. This gives Eclipse platform deployers a range of security solutions that allow tradeoffs to be made between flexibility and complexity versus manageability and performance. In Eclipse 3.4 or later, authorization based on signatures can be performed:</p>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ <h2>Drag and Drop Support</h2>
provide handling of additional (non-standard) transfer types or
validation in the event of a drop.</p>

<h2>Link with Editor Support</h2>
<h2>Link With Editor Support</h2>

<p>The link helper extension point provides a flexible mechanism of
determining the appropriate selection in the navigator when an editor is
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<h1>Operational Topics</h1>
<p>This section covers the operation of the CNF in detail.</p>

<h2>Content Provider selection</h2>
<h2>Content Provider Selection</h2>
<p>Selecting the content provider is done by finding one or more
NCEs associated with an object. The CNF is registered as a content
provider a viewer and thus gets called at the content provider APIs in
Expand Down Expand Up @@ -56,23 +56,5 @@ <h2>Content Provider selection</h2>
current page. Thus, the initial input becomes the first object that is
evaluated for the selection of NCEs.</p>

<!--

<h2>Label Provider selection</h2>

<p>TBS - talk about the association of the object with the NCE that
is associated with the object's content provider.</p>

<p>More ???TBS</p>

<h2>Pipelining</h2>

<p>Pipelining works with the override mechanism to allow reshaping
the tree of objects. To use pipelining service, your content provider
must implement the <b>IPipedlinedTreeContentProvider</b> interface.</p>
<p>??? More TBS</p>

-->

</BODY>
</HTML>
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<link rel="stylesheet" type="text/css" HREF="../book.css">
</HEAD>
<BODY>
<h1>Migrating from the ResourceNavigator</h1>
<h1>Migrating From the ResourceNavigator</h1>

<p>
First follow the steps to <a href="cnf_steps_general.htm">add the Common Navigator</a> and check that the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ <H1>
</ul>
<p>These services are used in the platform to assist with user tasks such as
integrating patch files and comparing/merging the workspace with local history.</p>
<h2>Compare viewers</h2>
<h2>Compare Viewers</h2>
<p>
All compare viewers are standard <a href="jface_viewers.htm"> JFace viewers</a> that expect an input object implementing the
<b><a href="../reference/api/org/eclipse/compare/structuremergeviewer/ICompareInput.html">ICompareInput</a></b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ <H2>
This section provides additional information about advanced API in the compare
plug-in.</p>

<h3>Writing compare operations</h3>
<h3>Writing Compare Operations</h3>

<p>A compare operation must be implemented as a subclass of
<a href="../reference/api/org/eclipse/compare/CompareEditorInput.html"><b>CompareEditorInput</b></a>.&nbsp;
Expand Down Expand Up @@ -85,7 +85,7 @@ <h3>Writing compare operations</h3>
It can be used without modification as the input to the differencing engine.</p>


<h3>Compare functionality outside of compare editors</h3>
<h3>Compare Functionality Outside of Compare Editors</h3>


<p>If you want to use compare functionality outside of the standard compare editor
Expand All @@ -102,7 +102,7 @@ <h3>Compare functionality outside of compare editors</h3>
supports <b>dynamic viewer switching</b>, that is the viewer installed in the pane is dynamically
determined by the pane's input object.</p>

<h3><a name="Single">Comparing a single file in an editor</a></h3>
<h3><a Name="single">comparing a Single File in an Editor</a></h3>

<p>The <a href="../reference/api/org/eclipse/compare/CompareEditorInput.html"><b>CompareEditorInput</b></a> supports
the comparison of an arbitrary file/folder structure which can be displayed in an editor, dialog or view.
Expand All @@ -118,7 +118,7 @@ <h3><a name="Single">Comparing a single file in an editor</a></h3>
<li>initializes asynchronously.</li>
</ul>

<h3><a name="Patch">Working with patches</a></h3>
<h3><a Name="patch">working With Patches</a></h3>

<p>The <a href="../reference/api/org/eclipse/compare/patch/ApplyPatchOperation.html"><b>ApplyPatchOperation</b></a> provides
the ability to launch the Apply Patch wizard programmatically. The pages shown by the wizard are determined using the inputs to the operation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ <H2>


<h3>
Simple content viewers</h3>
Simple Content Viewers</h3>


<p>
Expand Down Expand Up @@ -50,7 +50,7 @@ <h3>
<p>You may also use the <b>contentTypeBinding</b> element to associate a <a href="runtime_content.htm">content type</a>
with a content viewer.
</p>
<h3>Content merge viewers</h3>
<h3>Content Merge Viewers</h3>
<p> A <b> content merge viewer </b> performs a two-way or three-way compare of its inputs
and presents the result side-by-side or in any other suitable way.&nbsp; The viewer lets the user
merge between the inputs. Content merge viewers are common for text or images.</p>
Expand Down Expand Up @@ -113,7 +113,7 @@ <h3>Content merge viewers</h3>
<a href="../reference/api/org/eclipse/compare/contentmergeviewer/IMergeViewerContentProvider.html"><b>IMergeViewerContentProvider</b></a> interface.</p>


<h4><a name="Text">Text merging</a></h4>
<h4><a name="Text">Text Merging</a></h4>


<p> If your viewer uses text, additional classes that&nbsp; compare
Expand Down Expand Up @@ -153,7 +153,7 @@ <h4><a name="Text">Text merging</a></h4>
TextMergeViewer that provide syntax highlighting must implement both the <code>getDocumentPartitioner()</code> and
<code>getDocumentPartitioning()</code> methods to support shared documents. </p>

<h4>Range differencing</h4>
<h4>Range Differencing</h4>
<p>
<a href="../reference/api/org/eclipse/compare/rangedifferencer/RangeDifferencer.html"><b>RangeDifferencer</b></a>
finds the longest sequences of matching and
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ <H2>
in a hierarchical view, and lets the user merge between the inputs.&nbsp;
Structure merge viewers are common for workspace resources or the members of
an archive file.</p>
<h3>Tree-like structure viewers</h3>
<h3>Tree-like Structure Viewers</h3>
<p>Because the implementation of many structure compare viewers is based
on a tree, the compare plug-in provides a generic tree-based
<a href="../reference/api/org/eclipse/compare/structuremergeviewer/StructureDiffViewer.html"><b>StructureDiffViewer</b></a>.
Expand All @@ -33,7 +33,7 @@ <h3>Tree-like structure viewers</h3>
The JDT plug-in defines several contributions for
<a href="../reference/extension-points/org_eclipse_compare_structureCreators.html"><b>org.eclipse.compare.structureCreators</b></a>.</p>

<h3>Other hierarchical structure viewers</h3>
<h3>Other Hierarchical Structure Viewers</h3>
<p>In some cases, the tree-based <a href="../reference/api/org/eclipse/compare/structuremergeviewer/StructureDiffViewer.html"><b>StructureDiffViewer</b></a>
may not be appropriate for your plug-in.&nbsp; The <a href="../reference/extension-points/org_eclipse_compare_structureMergeViewers.html"><b>org.eclipse.compare.structureMergeViewers</b></a>
extension point allows you to define your own implementation for a structure
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<BODY>
<h1>Console Shell</h1>

<h2>General features</h2>
<h2>General Features</h2>

<p>The Equinox OSGi console is based on Apache Felix Gogo, which provides a Unix-like shell
for OSGi frameworks. The OSGi console is useful for runtime configuration and management of the
Expand Down Expand Up @@ -114,7 +114,7 @@ <h2>Starting a Telnet Session</h2>
option at all, but if <code>-console</code> is passed it will override any setting present in the
<b>configuration/config.ini</b> file.</p>

<h2>Starting an SSH Session with JAAS Authentication</h2>
<h2>Starting an SSH Session With JAAS Authentication</h2>

<p>To start a console session in an SSH session, a few more bundles are needed:</p>

Expand Down Expand Up @@ -229,7 +229,7 @@ <h3>Custom JAAS Authentication Login Providers</h3>
must be specified in the <b>configuration/console.auth.config</b> file instead of the default
entry there.</p>

<h2>Starting an SSH Session with Public Key Authentication</h2>
<h2>Starting an SSH Session With Public Key Authentication</h2>

<p>It's common to want to use public key authentication with SSH and it is possible to configure
Equinox to do that instead of using JAAS authentication. First an SSH key-pair should be created
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<link rel="stylesheet" type="text/css" HREF="../book.css">
</HEAD>
<BODY>
<h2>Debugging a program</h2>
<h2>Debugging a Program</h2>
<p>When you define a <a href="debug_launch.htm">launch configuration</a> for
running a program, you can specify which modes (run, debug, profile, etc.) are supported
by your program. If you support debug mode, then you need to implement a debug
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<link rel="stylesheet" type="text/css" HREF="../book.css">
</HEAD>
<BODY>
<h2>Launching a program</h2>
<h2>Launching a Program</h2>
<p>The platform debug plug-ins allow your plug-in to extend the platform so that your
partiticular type of program can be launched from the workbench, obtaining input from the user if
necessary. A unique type of program that can be launched in the platform is called a
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<link rel="stylesheet" type="text/css" HREF="../book.css">
</HEAD>
<BODY>
<h3>Adding launchers to the platform</h3>
<h3>Adding Launchers to the Platform</h3>
<p>Your plug-in can add launch configuration types to the platform using the <a href="../reference/extension-points/org_eclipse_debug_core_launchConfigurationTypes.html"><b>org.eclipse.debug.core.launchConfigurationTypes</b></a>
extension point.&nbsp; This extension point allows you to declare a
configuration type using a unique id.&nbsp; You must provide a corresponding
Expand Down Expand Up @@ -40,7 +40,7 @@ <h3>Adding launchers to the platform</h3>
&lt;/extension&gt;</pre>
<p>This extension defines a launch configuration delegate that can be used to run or debug programs that
are launched using the local Java launch configuration.</p>
<h4>Defining new launch modes</h4>
<h4>Defining New Launch Modes</h4>
<p>We mentioned previously that the platform defines launch modes for running, debugging, or profiling
a program. These modes are defined using the <a href="../reference/extension-points/org_eclipse_debug_core_launchModes.html"><b>org.eclipse.debug.core.launchModes</b></a>
extension point. This extension point allows you to declare a launch mode by defining its string mode
Expand All @@ -64,7 +64,7 @@ <h4>Defining new launch modes</h4>
</pre>
<p>Note that the mode is not associated with any particular launch configuration type. As shown earlier, that association
occurs when a launch delegate is specified for a configuration type. </p>
<h4>Defining launch delegates</h4>
<h4>Defining Launch Delegates</h4>
<p>Since launch modes can be specified independently of launch configuration types, it's possible that new modes
are defined that are not implemented by the original delegate for a launch configuration. In this case, a plug-in
may define a launch delegate that implements a particular mode for a particular launch configuration type.
Expand All @@ -87,7 +87,7 @@ <h4>Defining launch delegates</h4>
modes. As seen previously, the delegate must implement <a href="../reference/api/org/eclipse/debug/core/model/ILaunchConfigurationDelegate.html"><b>ILaunchConfigurationDelegate</b></a>,
and can optionally implement <a href="../reference/api/org/eclipse/debug/core/model/ILaunchConfigurationDelegate2.html"><b>ILaunchConfigurationDelegate2</b></a> for
more control over the launch sequence.</p>
<h4>Other references</h4>
<h4>Other References</h4>
<p><a href="http://www.eclipse.org/articles/Article-Launch-Framework/launch.html">We Have Lift-off: The Launching Framework in Eclipse</a>
provides a start to finish example for defining your own launch type.</p>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
</HEAD>
<BODY>

<h4>Comparing launch configurations</h4>
<h4>Comparing Launch Configurations</h4>
<p>We've seen how a plug-in can use named attributes and values to store important data with a
launch configuration. Since the interpretation of a plug-in's attributes are not known by the platform,
an extension point is provided that allows you to supply a comparator for a specific attribute.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<link rel="stylesheet" type="text/css" HREF="../book.css">
</HEAD>
<BODY>
<h3>Launch groups</h3>
<h3>Launch Groups</h3>
<p>The <b>Launch Group</b> launch configuration type allows you to launch multiple other launch configurations
sequentially, with configurable actions after launching each group member:
<ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<link rel="stylesheet" type="text/css" HREF="../book.css">
</HEAD>
<BODY>
<h4>Launching Java applications</h4>
<h4>Launching Java Applications</h4>
<p>
In <a href="debug_launch_processfactories.htm">Process factories</a>, we saw how a system process is used to invoke
a program and how wrapping it with an <a href="../reference/api/org/eclipse/debug/core/model/IProcess.html"><b>IProcess</b></a>
Expand Down
Loading
Loading