Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Equinox p2 Touchpoint Instructions"

(Native Touchpoint)
 
(29 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{CommentBox|Work in Progress}}
+
#REDIRECT [[Equinox/p2/Engine/Touchpoint Instructions]]
 
+
A P2 installable Unit (IU) can be installed into one touchpoint. The IU meta data consists of a reference to the touchpoint (Touchpoint Type), and describes a set of actions/instructions to execute on the referenced touchpoint. Currently, two touchpoints (native, and eclipse) have been implemented. The native touchpoint has aprox 5 different actions, and the eclipse touchpoint has aprox 20. Some of these actions take parameters. The actions and parameters are encoded in a Map where they keys are the references to actions, and the value is a single parameter, or a map of multiple parameters. This wiki page describes the two touchpoints, and the instructions they understand.
+
 
+
=Native Touchpoint=
+
The native touchpoint is used to install things "outside of eclipse".
+
 
+
{| {{Greytable}}
+
|-valign="top" style="background-color:#eeeeee;color:#444444;"
+
| '''instruction'''
+
| '''parameters'''
+
| '''description'''
+
|- valign="top"
+
| style="font-weight:bold;font-family:monospace"|cleanupzip
+
| <code>source, target</code>
+
| removes unzipped files and directoreis that where unzipped from ''source'' into ''target'' - i.e. an "undo operation" of an ''unzip'' instruction.
+
|- valign="top"
+
| <code>'''unzip'''</code>
+
| <code>source, target</code>
+
| unzips the ''source'' into the ''target'' directory. The ''source'' can be the special <code>@artifact</code> source path, which denotes the download cache location for the first artifact key in the IU. ''Comments in code indicates that the use of <code>@artifact</code> may be deprecated.''
+
|- valign="top"
+
| <code>'''chmod'''</code>
+
| targetDir, targetFile, permissions
+
| changes mode on the ''targetFile'' in the ''targetDir'' (a path), ''permissions'' is written the same way as to the system command ''chmod'',
+
|- valign="top"
+
| <code>'''collect'''</code>
+
| -
+
|{{CommentBox|Need help to describe what this action does - it seems to add the needed artifacts from an installable unit that is replacing another, to a set of artifacts to download from an artifact repository. The instruction does not seem to take any parameters other than those already injected by the engine.}}
+
|- valign="top"
+
| <code>'''link'''</code>
+
| targetDir, linkTarget, linkName, force
+
| Performs the system action <code>ln -s</code> with the parameters ''linkTarget'' being the source-file, ''targetDir'' is the directory where the symbolic link will be created, and ''linkName'' is the name of the resulting link in the ''targetDir''. The ''force'' parameter is a boolean in string form (i.e. "true"/"false" and indicates if an existing link with the same name should be removed before the new link is created. {{CommentBox|the parameter names are quite confusing}}
+
|}
+
 
+
=Eclipse Touchpoint=
+
{| {{Greytable}}
+
|-
+
| '''instruction'''
+
| '''description'''
+
|- valign="top"
+
| collect
+
|
+
|-valign="top"
+
| installBundle
+
|
+
|-valign="top"
+
| uninstallBundle
+
|
+
|-valign="top"
+
| addSourceBundle
+
|
+
|-valign="top"
+
| removeSourceBundle
+
|
+
|-valign="top"
+
| installFeature
+
|
+
|-valign="top"
+
| uninstallFeature
+
|
+
|-valign="top"
+
| setLauncherName
+
|
+
|-valign="top"
+
| addProgramArgument
+
|
+
|-valign="top"
+
| removeProgramArgument
+
|
+
|-valign="top"
+
| setStartLevel
+
|
+
|-valign="top"
+
| markStarted
+
|
+
|-valign="top"
+
| setFrameworkDependentProperty
+
|
+
|-valign="top"
+
| setFrameworkIndependentProperty
+
|
+
|-valign="top"
+
| setProgramProperty
+
|
+
|-valign="top"
+
| addJVMArgument
+
|
+
|-valign="top"
+
| mkdir
+
|
+
|-valign="top"
+
| rmdir
+
|
+
|-valign="top"
+
| link
+
|
+
|-valign="top"
+
| chmod(targetDir, targetFile, permissions)
+
| changes permission on a file using the system chmod command. The ''targetDir'' parameter is either a path, or the special <code>@artifact</code> which is a reference to the directory where the first artifact included in the installable unit is located. The parameter ''targetFile'' is the name of a file, and ''permissions'' is written like for the ''chmod'' system command.
+
|-valign="top"
+
| checkTrust
+
|
+
|-valign="top"
+
|}
+
[[Category:Equinox p2|Metadata Authoring]]
+

Latest revision as of 10:16, 25 September 2008

Back to the top