Difference between revisions of "Extenstion Points in STP.SC"

Revision as of 02:19, 1 March 2007

The following extension points can be used to extend the capabilities of the STP platform infrastructure:

Annotation Editing Extension

Extension Reference

• Identifier: org.eclipse.stp.sc.common.AnnotationSupport
• Since: 1.0
• Description: The AnnotationSupport extension point allows plug-ins to declaratively register supported annotations for the STP annotation editing. This information is used by the annotation view to allow user add/modify annotations in the java editor
• Configuration Markup:

<!ELEMENT extension (annotation)>
<!ATTLIST extension
point CDATA #REQUIRED
id    CDATA #IMPLIED
name  CDATA #IMPLIED>
<!ELEMENT annotation EMPTY>
<!ATTLIST annotation
annotationClass  CDATA #REQUIRED
initializerClass CDATA #IMPLIED
name             CDATA #IMPLIED
nature           CDATA #IMPLIED
interfaceOnly    (true | false) 
classOnly        (true | false) >

Define one supported annotation in Annotation Properties View

• • annotationClass - the full name of annotation class
  • initializerClass - User should provider the initializer class to create suitable init value in the Annotation Properties View
  • name - The display name shows in the Annotation Properties view for this annotation
  • nature - Project nature ID if this annotation should be only apply for one type of project. In our case, for example, those JAX-WS annoations only applicable to JAX-WS project.
  • interfaceOnly - Indicate the annotation is only applicable to interface. default is false
  • classOnly - Indicate the annotation is only applicable to class. default is false

• Examples: Following is an example of a @WebMethod annotation configuration. It allow user to add javax.jws.WebMethod annotation from the STP annotation View, and the default vaule of that annotation will be setup by CoreAnnotationInitializer class. Also notice here, the @WebMethod annotation will only show when it is JAX-WS project.

<extension point="org.eclipse.stp.sc.common.AnnotationSupport">
<annotation
annotationClass="javax.jws.WebMethod"
initializerClass="org.eclipse.stp.sc.jaxws.utils.ext.CoreAnnotationInitializer"
name="WebMethod"
nature="org.eclipse.stp.sc.jaxws.nature"/>
</extension> 

• API Information:
• Supplied Implementation:
  • org.eclipse.stp.sc.jaxws plugin registered all JSR181 and JAX-WS annotations by extending the AnnotationSupport
  • org.eclipse.stp.sc.sca.java plugin registered all SCA annotations by extending the AnnotationSupport
  • org.eclipse.stp.sc.sca.java.tuscany plugin registered all Tuscany(1.0) annotations by extending the AnnotationSupport

Annotation Validation Extension

Extension Reference

• Identifier:org.eclipse.stp.sc.xmlvalidator.ruleset
• Since: 1.0
• Description:The RuleSet extension point allows plug-ins to declaratively register validation rules. This information is used by the annotation validator to validate annotations defined in the java source code

Runtime Provider Extension

Extension Reference

Todo