| <!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html> |
| |
| <head> |
| <title>Tasks (Oomph Setup Documentation)</title> |
| |
| <link rel="stylesheet" href="../book.css"> |
| |
| <noscript></noscript> |
| <script type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Tasks (Oomph Setup Documentation)"; |
| } |
| } |
| </script> |
| </head> |
| |
| <body bgcolor="white" onload="windowTitle();"> |
| <!-- <div class="help_breadcrumbs breadcrumbs_top"><a href="../Overview.html" title="Oomph Setup Documentation">Oomph Setup Documentation</a> > <a href="index.html" title="Category in Oomph Setup Documentation">Concepts</a></div> --> |
| |
| <table border="0"> |
| <tr> |
| <td width="100%"><h1>Tasks</h1></td> |
| <td align="right" valign="middle" nowrap><a href="DocTaskExecution.html" title="Backward to Task Execution"><img src="../../images/backward.png" border="0"></a> <a href="DocVariableRecording.html" title="Forward to Variable Recording"><img src="../../images/forward.png" border="0"></a></td> |
| </tr> |
| </table> |
| <p> |
| A setup <a href="../../javadoc/org/eclipse/oomph/setup/SetupTask.html" title="Interface in org.eclipse.oomph.setup"><code>task</code></a> is the fine-grained unit of work in the overall setup process. |
| A task is declarative in nature, |
| i.e., it describes what needs to be achieved rather than how it's achieved. |
| Each task is contained within a <a href="DocScope.html" title="Article in Oomph Setup Documentation">scope</a>. |
| The overall setup process involves <a href="DocTaskComposition.html" title="Article in Oomph Setup Documentation">gathering</a> tasks from various scopes |
| and then <a href="DocTaskExecution.html" title="Article in Oomph Setup Documentation">performing</a> those tasks. |
| </p> |
| |
| <a name="DocTask.properties"> |
| <p> |
| Each task has the following properties: |
| <ul> |
| |
| <a name="DocTask.id"> |
| <li> |
| An optional <a href="../../javadoc/org/eclipse/oomph/setup/SetupTask.html#getID()" title="Method in org.eclipse.oomph.setup.SetupTask"><code>ID</code></a> attribute. |
| The value of this attribute, |
| if present, |
| must be unique within the containing <a href="DocSetupResource.html" title="Article in Oomph Setup Documentation">resource</a>. |
| If the task has an ID, |
| a <a href="DocTask.html#DocVariableTask" title="Chapter in Oomph Setup Documentation">variable</a> is inferred for each populated String-typed attribute of that task. |
| This variable behaves as if it were logically contained just before the task in the task's container. |
| </li> |
| |
| <a name="DocTask.excludedTriggers"> |
| <p> |
| An <a href="../../javadoc/org/eclipse/oomph/setup/SetupTask.html#getExcludedTriggers()" title="Method in org.eclipse.oomph.setup.SetupTask"><code>excluded</code></a> <a href="DocTask.html#DocTrigger" title="Chapter in Oomph Setup Documentation">triggers</a> attribute |
| that specifies the triggers for which that task is not applicable. |
| This affects which tasks will be <a href="DocTaskComposition.html" title="Article in Oomph Setup Documentation">gathered</a>. |
| Most task implementations exclude the bootstrap trigger |
| because they must execute within a running product where the task implementation along with the supporting infrastructure are installed. |
| As such, task implementations hard-code the <a href="../../javadoc/org/eclipse/oomph/setup/SetupTask.html#getValidTriggers()" title="Method in org.eclipse.oomph.setup.SetupTask"><code>permissible</code></a> triggers |
| and task authors can further exclude triggers from those that are permissible. |
| In the end, |
| by logical exclusion, |
| this induces an overall set of <a href="../../javadoc/org/eclipse/oomph/setup/SetupTask.html#getTriggers()" title="Method in org.eclipse.oomph.setup.SetupTask"><code>allowed</code></a> triggers. |
| </li> |
| |
| <a name="DocTask.disabled"> |
| <li> |
| A <a href="../../javadoc/org/eclipse/oomph/setup/SetupTask.html#isDisabled()" title="Method in org.eclipse.oomph.setup.SetupTask"><code>disabled</code></a> attribute that specifies whether or not the task should be gathered. |
| </li> |
| |
| <a name="DocTask.restrictions"> |
| <li> |
| An optional <a href="../../javadoc/org/eclipse/oomph/setup/SetupTask.html#getRestrictions()" title="Method in org.eclipse.oomph.setup.SetupTask"><code>restrictions</code></a> reference |
| that specifies the set of <a href="DocScope.html" title="Article in Oomph Setup Documentation">scopes</a> to which the task inclusively applies. |
| TODO |
| </li> |
| |
| <a name="DocTask.order"> |
| <li> |
| Both a <a href="../../javadoc/org/eclipse/oomph/setup/SetupTask.html#getPredecessors()" title="Method in org.eclipse.oomph.setup.SetupTask"><code>predecessors</code></a> references and a <a href="../../javadoc/org/eclipse/oomph/setup/SetupTask.html#getSuccessors()" title="Method in org.eclipse.oomph.setup.SetupTask"><code>successors</code></a> reference, |
| that specify that tasks that must be performed, respectively, before or after, the task itself is performed. |
| Furthermore, a task has an intrinsic <a href="../../javadoc/org/eclipse/oomph/setup/SetupTask.html#getPriority()" title="Method in org.eclipse.oomph.setup.SetupTask"><code>priority</code></a> that is determined by the task implementor. |
| All these properties affect the <a href="DocTaskComposition.html#Reorder" title="Chapter in Oomph Setup Documentation">order</a> in which tasks are performed. |
| </li> |
| |
| <a name="DocTask.operations"> |
| </ul> |
| <p> |
| Each task supports the following operations: |
| <ul> |
| |
| <a name="DocTask.performance"> |
| <li> |
| Logic for determining whether the task <a href="../../javadoc/org/eclipse/oomph/setup/SetupTask.html#isNeeded(org.eclipse.oomph.setup.SetupTaskContext)" title="Method in org.eclipse.oomph.setup.SetupTask"><code>needs</code></a> to perform |
| as well the logic for <a href="../../javadoc/org/eclipse/oomph/setup/SetupTask.html#perform(org.eclipse.oomph.setup.SetupTaskContext)" title="Method in org.eclipse.oomph.setup.SetupTask"><code>performing</code></a> the task. |
| The determination of whether that the task needs to perform |
| is influenced by the <a href="DocTask.html#DocTrigger" title="Chapter in Oomph Setup Documentation">trigger</a>, |
| i.e., |
| it affects how detailed will be the analysis for determining whether the task needs to be performed |
| with the general goal being to <a href="DocTaskExecution.html" title="Article in Oomph Setup Documentation">perform</a> only those tasks strictly needed for the <a href="DocTask.html#DocTrigger.startup" title="Section in Oomph Setup Documentation">startup</a> trigger. |
| This behavior is documented on a per-task basis. |
| </li> |
| |
| <a name="DocTask.override"> |
| <li> |
| A task, in general, can be <a href="../../javadoc/org/eclipse/oomph/setup/SetupTask.html#overrideFor(org.eclipse.oomph.setup.SetupTask)" title="Method in org.eclipse.oomph.setup.SetupTask"><code>overridden</code></a> by other tasks during the process of <a href="DocTaskComposition.html" title="Article in Oomph Setup Documentation">gathering</a> tasks. |
| Which tasks are overridden by which other tasks, |
| and how that override merges two tasks into a single combined task |
| is specific to each task implementation and is therefore documented on a per-task basis. |
| A task implement supports overrides by yielding a so called <a href="../../javadoc/org/eclipse/oomph/setup/SetupTask.html#getOverrideToken()" title="Method in org.eclipse.oomph.setup.SetupTask"><code>override token</code></a>. |
| Two tasks that yield equal override tokens are merged during the <a href="DocTaskComposition.html#InitialPhase" title="Chapter in Oomph Setup Documentation">initial</a> task gathering phase. |
| </li> |
| |
| <a name="DocTask.consolidate"> |
| <li> |
| A task, in general, can be <a href="../../javadoc/org/eclipse/oomph/setup/SetupTask.html#consolidate()" title="Method in org.eclipse.oomph.setup.SetupTask"><code>consolidated</code></a>. |
| At the end of the task gathering phase, |
| each task is <a href="DocTaskComposition.html#Consolidation" title="Chapter in Oomph Setup Documentation">consolidated</a> to optimize its representation in preparation before the task is <a href="DocTaskExecution.html" title="Article in Oomph Setup Documentation">performed</a>. |
| </li> |
| |
| <a name="DocTask.footer"> |
| </ul> |
| </p> |
| |
| <h2><a name="DocTrigger"></a>1 Trigger</h2> |
| |
| |
| <a name="DocTrigger.introduction"> |
| <p> |
| There are three types of <a href="../../javadoc/org/eclipse/oomph/setup/Trigger.html" title="Class in org.eclipse.oomph.setup"><code>triggers</code></a>: |
| <ul> |
| |
| <a name="DocTrigger.bootstrap"> |
| <li> |
| <a href="../../javadoc/org/eclipse/oomph/setup/Trigger.html#BOOTSTRAP" title="Field in org.eclipse.oomph.setup.Trigger"><code>Bootstrap</code></a> applies when using the <a href="../user/wizard/DocInstallWizard.html" title="Article in Oomph Setup Documentation">installer wizard</a>. |
| </li> |
| |
| <a name="DocTrigger.startup"> |
| <li> |
| <a href="../../javadoc/org/eclipse/oomph/setup/Trigger.html#STARTUP" title="Field in org.eclipse.oomph.setup.Trigger"><code>Startup</code></a> applies when a product is first launched, automated task performance is enabled, and there are tasks that need to be performed, |
| at which point the <a href="../user/wizard/DocUpdateWizard.html" title="Article in Oomph Setup Documentation">execution wizard</a> will be opened on the <a href="../user/wizard/DocConfirmationPage.html" title="Article in Oomph Setup Documentation">progressPage page</a>. |
| </li> |
| |
| <a name="DocTrigger.manual"> |
| <li> |
| <a href="../../javadoc/org/eclipse/oomph/setup/Trigger.html#MANUAL" title="Field in org.eclipse.oomph.setup.Trigger"><code>Manual</code></a> applies when invoking the <a href="../user/wizard/DocImportWizard.html" title="Article in Oomph Setup Documentation">project wizard</a> or directly invoking <a href="../user/wizard/DocUpdateWizard.html" title="Article in Oomph Setup Documentation">execution wizard</a>. |
| </li> |
| |
| <a name="DocTrigger.summary"> |
| </ul> |
| <p> |
| Each task specifies its <a href="DocTask.html.excludedTriggers" title="Section in Oomph Setup Documentation">valid</a> triggers |
| determining whether that task is <a href="DocTaskComposition.html#Filter" title="Chapter in Oomph Setup Documentation">filtered</a> when tasks are gathered. |
| </p> |
| |
| <h2><a name="DocVariableTask"></a>2 Variable Task</h2> |
| |
| |
| <h2><a name="DocCompoundTask"></a>3 Compound Task</h2> |
| |
| |
| <h2><a name="DocP2Task"></a>4 P2 Task</h2> |
| |
| |
| <h2><a name="DocTargletTask"></a>5 Targlet Task</h2> |
| |
| |
| <p align="right"> |
| <a href="DocTaskExecution.html" title="Backward to Task Execution"><img src="../../images/backward.png" border="0"></a> <a href="DocVariableRecording.html" title="Forward to Variable Recording"><img src="../../images/forward.png" border="0"></a></p> |
| <!-- <div class="help_breadcrumbs breadcrumbs_bottom"><a href="../Overview.html" title="Oomph Setup Documentation">Oomph Setup Documentation</a> > <a href="index.html" title="Category in Oomph Setup Documentation">Concepts</a></div> --> |
| |
| <div class="copyright">Copyright (c) 2014 Eike Stepper (Loehne, Germany) and others.<br>All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v2.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v20.html</div> |
| </body> |
| </html> |
