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.
Difference between revisions of "Equinox p2 Touchpoint Instructions"
(→Eclipse Touchpoint) |
(→Eclipse Touchpoint) |
||
| Line 88: | Line 88: | ||
| Marks the bundle referenced by the first artifact key in the IU as started / not started, as controlled by the boolean parameter ''started'' (in string form i.e. "true"/"false"). | | Marks the bundle referenced by the first artifact key in the IU as started / not started, as controlled by the boolean parameter ''started'' (in string form i.e. "true"/"false"). | ||
|-valign="top" | |-valign="top" | ||
| − | | setFrameworkDependentProperty | + | {{Command|setFrameworkDependentProperty}} |
| − | | | + | {{Parameters|propName, propValue}} |
| + | | Sets the framework dependant property named ''propName'' to the value specified in ''propValue''. {{CommentBox|What is a FW dependant property BTW?}} | ||
|-valign="top" | |-valign="top" | ||
| − | | setFrameworkIndependentProperty | + | {{Command|setFrameworkIndependentProperty}} |
| − | | | + | {{Parameters|propName, propValue}} |
| + | | Sets the framework independant property named ''propName'' to the value specified in ''propValue''. {{CommentBox|What is a FW independant property BTW?}} | ||
|-valign="top" | |-valign="top" | ||
| setProgramProperty | | setProgramProperty | ||
Revision as of 19:39, 19 June 2008
Work in Progress
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".
| instruction | parameters | description |
| cleanupzip | source, target
|
removes unzipped files and directoreis that where unzipped from source into target - i.e. an "undo operation" of an unzip instruction. |
| unzip | source, target | unzips the source into the target directory. The source can be the special @artifact source path, which denotes the download cache location for the first artifact key in the IU. Comments in code indicates that the use of @artifact may be deprecated.
|
| chmod | 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, |
| collect | 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.
| |
| link | targetDir, linkTarget, linkName, force | Performs the system action ln -s 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. the parameter names are quite confusing
|
Eclipse Touchpoint
| instruction | parameters | description |
| collect | - | Need help to describe what this instructions does (probably the same as the native touchpoint 'collect'
|
| installBundle | bundle | Installs a bundle artifact specified by the parameter bundle |
| uninstallBundle | bundle | Uninstalls a bundle artifact with a bundle-id specified by the paramter bundle |
| addSourceBundle | bundle | Installs a source bundle artifact with the bundle-id specified by the parameter bundle |
| removeSourceBundle | bundle | Removes/uninstalls the source bundle artifact with the bundle-id specified by the parameter bundle |
| installFeature | feature, featureId, version | Installs the feature referenced by the parameter feature (matched against artifacts in the iu). The feature is installed with the id specified by the parameter featureId, or if this parameter has the value default, with the id specified in the artifact referenced by feature. The features is installed with the version specified in version, or with the version specified in the artifact referenced by the feature parameter if the version parameter has the value default
|
| uninstallFeature | feature, featureId, version | Uninstalls a feature. Parameters have the same meaning as for the command installFeature
|
| setLauncherName | name | Sets the name of the launcher to name. Can someone help with a better explanation? Example?
|
| addProgramArgument | programArg | Adds the string specified in the parameter programArg as an argument to the program. If the parameters is the special value @artifact, the location of the artifact referenced by the first artifact key in the IU is used as the parameter value. Is this description correct?
|
| removeProgramArgument | programArg | Removes the program argument specified in the string programArg - if the parameters is the special value @artifact, the location of the artifact referenced by the first artifact key in the IU is used as the parameter value.
|
| setStartLevel | startLevel | Sets the start level to the integer value specified in the parameter startValue |
| markStarted | started | Marks the bundle referenced by the first artifact key in the IU as started / not started, as controlled by the boolean parameter started (in string form i.e. "true"/"false"). |
| setFrameworkDependentProperty | propName, propValue | Sets the framework dependant property named propName to the value specified in propValue. What is a FW dependant property BTW?
|
| setFrameworkIndependentProperty | propName, propValue | Sets the framework independant property named propName to the value specified in propValue. What is a FW independant property BTW?
|
| setProgramProperty | ||
| addJVMArgument | ||
| mkdir | ||
| rmdir | ||
| link | ||
| chmod(targetDir, targetFile, permissions) | changes permission on a file using the system chmod command. The targetDir parameter is either a path, or the special @artifact 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.
| |
| checkTrust |