Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Service Editor"

(New page: == Introduction == == Service Editor in detail== === Service Overview Page === ==== Screenshots ==== === Policy Page === ==== Screenshots ==== === OSGI Page === ==== Screenshots ==== === A...)
 
(Service Overview Page)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
== Introduction ==
 
== Introduction ==
== Service Editor in detail==
+
We have property, wsdl, launch config, code generation, context menu ...etc in different places in the current service creation. I am hoping to have the service editor to mushup all functions related with service creation. That means, users can setup the code generation flags(such as namespace), endpoint address(defined in wsdl and code), policies(defined in wsdl), osgi bundles, assemble and deployment(defined in soas?) all within the one editor.
 +
 
 +
It is a multiple pages editor, which consists of following pages:
 +
* service overview page (for service.xml file)
 +
* service policy page (for policy.xml file, or wsdl file)
 +
* service osgi page (for MANIFEST.MF file)
 +
* service assemble page (for service.assemble file)
 +
* service deploy.page (for service.deploy file)
 +
 
 +
== Service Editor Design ==
 
=== Service Overview Page ===
 
=== Service Overview Page ===
 +
The overview page is used to capture most attributes for one service, such as service name, name space, endpoint address, wsdl contract...etc.
 +
It will also hold service related shortcuts. For example, shortcut to start service component within eclipse for debugging.
 +
 +
==== Extension Point ====
 +
We should define ServiceAttributesSection extension point to allow developers to add more attributes sections to the overview page.
 +
For example, the wsdl/endpoint address section is one extension provided by the sc.jaxws plugin
 +
==== File ====
 +
service.xml
 
==== Screenshots ====
 
==== Screenshots ====
 +
[[Image:Service_overview.PNG]]
 +
 
=== Policy Page ===
 
=== Policy Page ===
 +
The policy editor is used to add/remove policy to a service. We have two policy editors in stp, the following design are based on the xef policy editor.
 +
 +
==== Extension Point ====
 +
The xef policy editor defines a ISchemaProvider to allow users to register policy schema. In order to use the ISchemaProvider I/F, we need to define a SchemaProvider extension point in service creation,  and we will provide DirSchemaProvider by default. Which will load all schemas from a working directory. Add/remove shema to/from the working directory can be done from policy preference page.
 +
 +
Also need to define a similar extension point to support policy snippets as well.
 +
 +
==== Files ====
 +
Policy Editor has multiple input files:
 +
  --- policy schema files
 +
  --- policy snippets
 +
  --- policy file or wsdl file
 +
  --- service.policy (hold the mapping between the service name and policy file (/or wsdl file), thus we can setup to show the policy editor for this service )
 +
 
==== Screenshots ====
 
==== Screenshots ====
 +
[[Image:Service_policy.PNG]]
 +
 
=== OSGI Page ===
 
=== OSGI Page ===
 +
The OSGI page is the place to configure OSGI dependencies and exports to support OSGI container.  Those bundles are retrieved from user selected OSGI runtime.
 +
==== File ====
 +
/META-INF/MANIFEST.MF
 +
 +
We won's show the osgi page if the MANIFEST.MF file doesn't exists.
 +
 
==== Screenshots ====
 
==== Screenshots ====
 +
[[Image:Service_osgi.PNG]]
 
=== Assembly Page ===
 
=== Assembly Page ===
 +
This page allow user to select folders and files to be included in the generated deployable package. Users can also add extra libraries to the deployable package.
 +
==== File ====
 +
The output of this editor page is a service.assemble file. SOAS will create configurable logical package based on this assemble information. Package constructor extensions should use the configurable logical package if exists
 +
 
==== Screenshots ====
 
==== Screenshots ====
 +
[[Image:Service_assemble.PNG]]
 +
 
=== Deploy Page ===
 
=== Deploy Page ===
 +
Save deployment information. User can deploy the service from this page in addition to the context menu.
 +
 +
==== File ====
 +
service.deploy
 
==== Screenshots ====
 
==== Screenshots ====
 +
[[Image:Service_deploy.PNG]]

Latest revision as of 10:38, 28 October 2007

Introduction

We have property, wsdl, launch config, code generation, context menu ...etc in different places in the current service creation. I am hoping to have the service editor to mushup all functions related with service creation. That means, users can setup the code generation flags(such as namespace), endpoint address(defined in wsdl and code), policies(defined in wsdl), osgi bundles, assemble and deployment(defined in soas?) all within the one editor.

It is a multiple pages editor, which consists of following pages:

* service overview page (for service.xml file)
* service policy page (for policy.xml file, or wsdl file)
* service osgi page (for MANIFEST.MF file)
* service assemble page (for service.assemble file)
* service deploy.page (for service.deploy file)

Service Editor Design

Service Overview Page

The overview page is used to capture most attributes for one service, such as service name, name space, endpoint address, wsdl contract...etc. It will also hold service related shortcuts. For example, shortcut to start service component within eclipse for debugging.

Extension Point

We should define ServiceAttributesSection extension point to allow developers to add more attributes sections to the overview page. For example, the wsdl/endpoint address section is one extension provided by the sc.jaxws plugin

File

service.xml

Screenshots

Service overview.PNG

Policy Page

The policy editor is used to add/remove policy to a service. We have two policy editors in stp, the following design are based on the xef policy editor.

Extension Point

The xef policy editor defines a ISchemaProvider to allow users to register policy schema. In order to use the ISchemaProvider I/F, we need to define a SchemaProvider extension point in service creation, and we will provide DirSchemaProvider by default. Which will load all schemas from a working directory. Add/remove shema to/from the working directory can be done from policy preference page.

Also need to define a similar extension point to support policy snippets as well.

Files

Policy Editor has multiple input files:

 --- policy schema files
 --- policy snippets
 --- policy file or wsdl file
 --- service.policy (hold the mapping between the service name and policy file (/or wsdl file), thus we can setup to show the policy editor for this service )

Screenshots

Service policy.PNG

OSGI Page

The OSGI page is the place to configure OSGI dependencies and exports to support OSGI container. Those bundles are retrieved from user selected OSGI runtime.

File

/META-INF/MANIFEST.MF

We won's show the osgi page if the MANIFEST.MF file doesn't exists.

Screenshots

Service osgi.PNG

Assembly Page

This page allow user to select folders and files to be included in the generated deployable package. Users can also add extra libraries to the deployable package.

File

The output of this editor page is a service.assemble file. SOAS will create configurable logical package based on this assemble information. Package constructor extensions should use the configurable logical package if exists

Screenshots

Service assemble.PNG

Deploy Page

Save deployment information. User can deploy the service from this page in addition to the context menu.

File

service.deploy

Screenshots

Service deploy.PNG

Back to the top