RAS Export Engine Task
Identifier:
com.ibm.xtools.ras.export.exportEngineTask
Since:
6.0.0
Description:
This extension point is used to plug in additional tasks for use by the RAS export service. When a RAS asset is exported, each registered task will be executed once based on type and priority. The sum of all tasks constitutes the export operation.
Configuration Markup:
<!ELEMENT extension (task+)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
- point - The extension point com.ibm.xtools.ras.export.exportEngineTask that must be extended for all RAS Export tasks.
- id - The ID given to the the extension.
- name - The name given to the extension.
<!ELEMENT task EMPTY>
<!ATTLIST task
id CDATA #REQUIRED
name CDATA #REQUIRED
class CDATA #REQUIRED
type (Initialize|Update|Validate|Finalize)
priority CDATA #REQUIRED
progress_description CDATA #IMPLIED>
- id - A unique id that will be used to identify this particular task.
- name - The name of the task.
- class - The fully qualified name of the Java class that implements com.ibm.xtools.ras.export.engine.IExportEngineTask.
- type - Indicates which of the 4 steps during an export operation this task should execute in.
- Initialize: Intialize the export process, data model and asset.
- Update: Analyze and modify the asset.
- Validate: Verify the asset for correctness.
- Finalize: The asset is packaged and the manifest is created.
- priority - A positive integer between 0 and 100. The larger the number the higher the priority of the task within any given type.
- progress_description - A translatable progress description that will be presented while the task is executing.
Examples:
The following is an example of the extension point usage:
<extension point=
"com.ibm.xtools.ras.export.exportTask"
>
<task
name=
"Sample Export Engine Task"
id=
"com.example.SampleExportEngineTask.initialize"
class=
"com.example.SampleExportEngineTask"
type=
"Initialize"
priority=
"50"
>
</task>
</extension>
API Information:
Plug-ins that want to extend this extension point must implement the com.ibm.xtools.ras.export.engine.tasks.IExportEngineTask interface.
Licensed Materials - Property of IBM
© Copyright IBM Corp. 2004 All Rights Reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.