|
|
| (16 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"
| + | |
| − | {{Command|unzip}}
| + | |
| − | {{Parameters|source, target}}
| + | |
| − | | 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"
| + | |
| − | {{Command|chmod}}
| + | |
| − | {{Parameters|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"
| + | |
| − | {{Command|collect}}
| + | |
| − | {{Parameters|}}
| + | |
| − | |{{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"
| + | |
| − | {{Command|link}}
| + | |
| − | {{Parameters|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}}
| + | |
| − | |-valign="top" style="background-color:#eeeeee;color:#444444;"
| + | |
| − | | '''instruction'''
| + | |
| − | | '''parameters'''
| + | |
| − | | '''description'''
| + | |
| − | |- valign="top"
| + | |
| − | {{Command|collect}}
| + | |
| − | {{Parameters|-}}
| + | |
| − | | {{CommentBox|Need help to describe what this instructions does (probably the same as the native touchpoint 'collect'}}
| + | |
| − | |-valign="top"
| + | |
| − | {{Command|installBundle}}
| + | |
| − | {{Parameters|bundle}}
| + | |
| − | | Installs a bundle artifact specified by the parameter ''bundle''
| + | |
| − | |-valign="top"
| + | |
| − | {{Command|uninstallBundle}}
| + | |
| − | {{Parameters|bundle}}
| + | |
| − | | Uninstalls a bundle artifact with a bundle-id specified by the paramter ''bundle''
| + | |
| − | |-valign="top"
| + | |
| − | {{Command|addSourceBundle}}
| + | |
| − | {{Parameters|bundle}}
| + | |
| − | | Installs a source bundle artifact with the bundle-id specified by the parameter ''bundle''
| + | |
| − | |-valign="top"
| + | |
| − | {{Command|removeSourceBundle}}
| + | |
| − | {{Parameters|bundle}}
| + | |
| − | | Removes/uninstalls the source bundle artifact with the bundle-id specified by the parameter ''bundle''
| + | |
| − | |-valign="top"
| + | |
| − | {{Command|installFeature}}
| + | |
| − | {{Parameters|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 <code>default</code>, 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 <code>default</code>
| + | |
| − | |-valign="top"
| + | |
| − | {{Command|uninstallFeature}}
| + | |
| − | {{Parameters|feature, featureId, version}}
| + | |
| − | | Uninstalls a feature. Parameters have the same meaning as for the command <code>installFeature</code>
| + | |
| − | |-valign="top"
| + | |
| − | {{Command|setLauncherName}}
| + | |
| − | {{Parameters|name}}
| + | |
| − | | Sets the name of the launcher to <code>name</code>. {{CommentBox|Can someone help with a better explanation? Example?}}
| + | |
| − | |-valign="top"
| + | |
| − | {{Command|addProgramArgument}}
| + | |
| − | {{Parameters|programArg}}
| + | |
| − | | Adds the string specified in the parameter ''programArg'' as an argument to the program. If the parameters is the special value <code>@artifact</code>, the location of the artifact referenced by the first artifact key in the IU is used as the parameter value. {{CommentBox|Is this description correct?}}
| + | |
| − | |-valign="top"
| + | |
| − | {{Command|removeProgramArgument}}
| + | |
| − | {{Parameters|programArg}}
| + | |
| − | | Removes the program argument specified in the string ''programArg'' - if the parameters is the special value <code>@artifact</code>, the location of the artifact referenced by the first artifact key in the IU is used as the parameter value.
| + | |
| − | |-valign="top"
| + | |
| − | {{Command|setStartLevel}}
| + | |
| − | {{Parameters|startLevel}}
| + | |
| − | | Sets the start level to the integer value specified in the parameter ''startValue''
| + | |
| − | |-valign="top"
| + | |
| − | {{Command|markStarted}}
| + | |
| − | {{Parameters|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").
| + | |
| − | |-valign="top"
| + | |
| − | {{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"
| + | |
| − | {{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"
| + | |
| − | {{Command|setProgramProperty}}
| + | |
| − | {{Parameters|propName, propValue}}
| + | |
| − | | Sets the program property named ''propName'' to the value specified in ''propValue''. {{CommentBox|What is a program property BTW?}}
| + | |
| − | |-valign="top"
| + | |
| − | {{Command|addJVMArg}}
| + | |
| − | {{Parameters|jvmArg}}
| + | |
| − | | Adds the string specified in the parameter ''jvmArg'' to the arguments passed to the JVM.
| + | |
| − | |-valign="top"
| + | |
| − | {{Command|removeJVMArg}}
| + | |
| − | {{Parameters|jvmArg}}
| + | |
| − | | Removes the string specified in the parameter ''jvmArg'' from the arguments passed to the JVM.
| + | |
| − | |-valign="top"
| + | |
| − | {{Command|mkdir}}
| + | |
| − | {{Parameters|path}}
| + | |
| − | | Creates the directory specified by the parameter ''path''.
| + | |
| − | |-valign="top"
| + | |
| − | {{Command|rmdir}}
| + | |
| − | {{Parameters|path}}
| + | |
| − | | Removes the directory specified by the parameter ''path''.
| + | |
| − | |-valign="top"
| + | |
| − | {{Command|link}}
| + | |
| − | {{Parameters|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. If the parameter ''targetDir'' is set to the special value <code>@artifact</code>, the source is the file specified by the first artifact key in the IU. {{CommentBox|the parameter names are quite confusing}}
| + | |
| − | |-valign="top"
| + | |
| − | {{Command|chmod}}
| + | |
| − | {{Parameters|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"
| + | |
| − | {{Command|checkTrust}}
| + | |
| − | {{Parameters|}}
| + | |
| − | | {{CommentBox|Nedd help describing what this instruction does...}}
| + | |
| − | |}
| + | |
| − | [[Category:Equinox p2|Metadata Authoring]]
| + | |
