RAS Import Engine Task
Identifier:
com.ibm.ras.impord.engineTask
Since:
6.0.0
Description:
This extension point is used to plug in additional tasks for use by the RAS import service. When a RAS asset is imported, each registered task will be executed once. The sum of all tasks constitutes the import operation.
Configuration Markup:
<!ELEMENT extension (task+)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
- point - extension point com.ibm.ras.import.importEngineTask is extended for all RAS Import tasks.
- id - id of the extension point
- name - name of the extension
<!ELEMENT task EMPTY>
<!ATTLIST task
id CDATA #REQUIRED
name CDATA #REQUIRED
class CDATA #REQUIRED
type (Initialize|Extract|Update|Finalize) "Initialize"
priority CDATA "50"
progress_description CDATA #IMPLIED>
- id - A unique id that will be used to identify this particular task.
- name - The name of the task.
- class - A fully qualified name of the Java class that implements com.ibm.ras.impord.engine.IEngineTask interface
- type - Type of task that indicates at which phase of the import operation the task will be executed.
- Initialize: Read and validate the data model.
- Extract: Extract the artifacts.
- Update: Updates the target location with the artifacts.
- Finalize: Puts out a RAS status log file and finishes the consumption of assets.
- 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 localized 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.ras.impord.engineTask"
>
<task
name=
"Sample Engine Task"
id=
"com.example.SampleImportEngineTask.initialize"
class=
"com.example.SampleImportEngineTask"
type=
"Extract"
priority=
"75"
>
</task>
</extension>
API Information:
Plug-ins that want to extend this extension point must implement com.ibm.ras.impord.engine.tasks.IImportEngineTask interface
Licensed Materials - Property of IBM
© Copyright IBM Corp. 2003, 2004 All Rights Reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.