Services Extension Point
Identifier:
org.topcased.bus.core.Services
Since:
Topcased 0.6.0
Description:
This extention point defines a Service directly plug onto the Topcased Core Bus which records all plugins or Topcased services which depend of it.
An Internal Service has a type, a class (implementing the interface IService) and requires some parameters to be executed.
Configuration Markup:
<!ELEMENT extension (service+)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT service (ontologyType , outputParam , listInputParam)>
<!ATTLIST service
id CDATA #REQUIRED
name CDATA #REQUIRED
class CDATA #REQUIRED>
Defines a Topcased service plugs to the Topcased Core Bus. A Topcased service requires a set of input parameters and returns one result. The kind of input parameters varies according to the service to run.
- id - The unique identifier of the defined Topcased service.
- name - The full name of the defined Topcased service.
- class - The java class representing the implementation of the defined Topcased service.
<!ELEMENT ontologyType EMPTY>
<!ATTLIST ontologyType
id CDATA #REQUIRED
name CDATA #REQUIRED
parentId (org.topcased.service.import|org.topcased.service.export)
category (Model Tools|Model Editors|Others|Administration Tools|Model Import/Export) >
Defines the Type of the Topcased service. This information will be used to chain the current service to another one or to classify services according to their kind (for instance in the Topcased Console).
- id - The ontology type identifier of the new Topcased service.
- name - The unique identifier of the defined Topcased service.
- parentId - The ontology type parent identifier is just uselful to plug the current service to the transformation service.
If your service is a contribution to Topcased import choose org.topcased.service.import
If your service is a contribution to Topcased export choose org.topcased.service.export
In all the other cases, let the field blank.
- category - The ontology type category enables to classifiy Topcased services according to their fonctionnality.
<!ELEMENT parameter EMPTY>
<!ATTLIST parameter
id CDATA #REQUIRED
name CDATA #IMPLIED
description CDATA #IMPLIED
kind (EObject|OCLExpression|String|Void|Map|IPath) >
Defines a Topcased parameter. There are two kinds of parameters used to call Topcased services : input or output.
- id - The full identifier of the service parameter.
- name - The name given to this service parameter.
- description - A short description about the service parameter.
- kind - The kind of the service parameter. The parameter kind must be an EObject, String, OCLExpression or Void.
<!ELEMENT listInputParam (parameter*)>
A Topcased service requires a set of input parameters to be correctly executed.
The set and the numbers of parameters depend on the implemented service.
<!ELEMENT outputParam (parameter)>
A Topcased service returns only one output parameter.
Examples:
(c) Copyright Topcased contributors. 2005, 2007. All rights reserved.
API Information:
[Enter API information here.]
Supplied Implementation:
[Enter information about supplied implementation of this extension point.]
(c) Copyright Topcased contributors. 2005, 2007. All rights reserved.