SOA Assembly Framework Properties UI Documentation

SAF Properties UI API [Overview]

The SOA Assembly Framework Properties UI Contribution allows an editor to display and modify the SCA core model and extensions to that model in an integrated fashion. It provides the framework between the editor and a model extension provider. Both the editor and the extension model provider have a role in the framework.

It provides the following interfaces:

  • ISOAPropertiesContribution
  • IEditorHandler
  • ITabDescriptor

ISOAPropertiesContribution defines the interface that the SOA editing tool uses to interact with the contribution. The model extension provider must provide a class that implements this interface.

IEditorHandler defines the interface which the contribution uses to interact with the SOA editing tool. The editor provides an implementation of this class.

ITabDescriptor is provided for complex SOA model extensions. The class implementing ISOAPropertiesContribution may request multiple composites to display its content from the editing tool by providing two or more ITabDescriptor interfaces.

The SAF Properties UI Contribution provides the following classes:

  • SOAPropertiesRegistry
  • SOAPropertiesEntry

SOAPropertiesRegistry contains the list of contributions to the framework. Each contribution is represented by an instance of SOAPropertiesEntry. These classes allow editors to access the contributions.

Properties UI Extension Point [Top]

Groups who extend the SCA model must contribute to this extension point to allow instances of their model extensions to be displayed by an editor.

The following is an example of an org.eclipse.stp.core.saf.ui.propertiesContribution extension. This example shows a contribution for WebServiceBinding in the core SCA model.

<extension point=

"org.eclipse.stp.core.saf.ui.propertiesContribution"

>

<propertiesContribution id=

"org.eclipse.stp.core.sca.WebServiceBinding"

namespaceURI=

"http://www.osoa.org/xmlns/sca/0.9"

typeName=

"WebServiceBinding"

class=

"sample.WebServiceBinding"

/>

</extension>

This documentation is maintained by John Vandenbroek (vanbroek{at}ca.ibm.com). Questions or requests for clarifications should be made to the STP Developer mailing list (stp-dev@eclipse.org). See http://www.eclipse.org/mail/index_all.php for details on how to sign up.

Copyright (c) 2006 IBM Corporation. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html

[Overview] [Top]