Jump to: navigation, search

Difference between revisions of "EMIWG/SDKProviderGuideline"

(Organizational Requirements)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
==Objective==
+
==Overview==
The objective of this document is to describe the requirements that an SDK Provider need to fullfill in orther to be integrated into Pulsar Server. Those requirements are broken in two categories: mandatory and optional.  
+
 
 +
[[Image:PulsarSDKProviderPlan.1.png]]
 +
 
 +
This timeline shows the tasks which have to be performed by each SDK provider who is participating in the
 +
Galileo timeframe Pulsar launch.
 +
 
 +
 
 +
 
 +
==Requirements Overview==
 +
The objective of this document is to describe in detail the requirements that an SDK Provider need to fullfill in order to be integrated into Pulsar Server. Those requirements are broken in three categories: organizational, technical mandatory and technical optional.
 +
 
 +
==Organizational Requirements==
 +
 
 +
To participate as an SDK Provider an organization (“Organization”) must agree to the following requirements:
 +
 
 +
# Organization must be a member of the Pulsar Working Group, and by definition a member of the Eclipse Foundation.
 +
# Organization must identify a primary and secondary contact to answer support related questions for their update site.
 +
# Organization must participate in the testing of the milestones release of the Pulsar package. Each organization will be asked to confirm testing of each milestone before the Pulsar package is released.
 +
# Each Organization recognizes that an installable unit will be made available to users which may be comprised of content made available by the Eclipse Foundation and Organization and other SDK Providers. Content provided by SDK Providers will be distributed to users from their servers.
 +
 
 +
## Each SDK Provider assumes the responsibility of making their SDK available under a software license agreement. It is recommended that each SDK Provider ensure that such license is made available to and accepted by users prior to downloading content to the user.
 +
 
 +
## Eclipse Foundation content is made available under the Eclipse Foundation Website Terms of Use.
 +
 
 +
# Each Organization must agree to abide by these guidelines by stating their desire to be included as a Pulsar SDK Provider on the public mailing list. This email must be sent by the Organization’s representative to the Mobile IWG.
  
 
==Mandatory Requirements==
 
==Mandatory Requirements==
Line 46: Line 70:
  
 
===REQ10: MTJ SDK Extension===
 
===REQ10: MTJ SDK Extension===
The SDK Provider might implement the MTJ SDK extension point that will automatically register the SDK on MTJ.
+
The SDK Provider might implement the MTJ SDK extension point that will automatically register the SDK on MTJ.
  
 
===REQ11: MTJ JAD Extension===
 
===REQ11: MTJ JAD Extension===
 
If the SDK provider defines some proprietary JAD attributed, the SDK provider can implement MTJ JAD Extensions to provide an specific editor to those attributed.
 
If the SDK provider defines some proprietary JAD attributed, the SDK provider can implement MTJ JAD Extensions to provide an specific editor to those attributed.
 
==Sample SDK Provider Repository==
 
The sample SDK Provider is based on microemu SDK which is a JavaME SDK implemented ontop of JavaSE. The SDJ is deployable as a zip file but it is not included on the package.
 

Latest revision as of 01:28, 20 May 2009

Overview

PulsarSDKProviderPlan.1.png

This timeline shows the tasks which have to be performed by each SDK provider who is participating in the Galileo timeframe Pulsar launch.


Requirements Overview

The objective of this document is to describe in detail the requirements that an SDK Provider need to fullfill in order to be integrated into Pulsar Server. Those requirements are broken in three categories: organizational, technical mandatory and technical optional.

Organizational Requirements

To participate as an SDK Provider an organization (“Organization”) must agree to the following requirements:

  1. Organization must be a member of the Pulsar Working Group, and by definition a member of the Eclipse Foundation.
  2. Organization must identify a primary and secondary contact to answer support related questions for their update site.
  3. Organization must participate in the testing of the milestones release of the Pulsar package. Each organization will be asked to confirm testing of each milestone before the Pulsar package is released.
  4. Each Organization recognizes that an installable unit will be made available to users which may be comprised of content made available by the Eclipse Foundation and Organization and other SDK Providers. Content provided by SDK Providers will be distributed to users from their servers.
    1. Each SDK Provider assumes the responsibility of making their SDK available under a software license agreement. It is recommended that each SDK Provider ensure that such license is made available to and accepted by users prior to downloading content to the user.
    1. Eclipse Foundation content is made available under the Eclipse Foundation Website Terms of Use.
  1. Each Organization must agree to abide by these guidelines by stating their desire to be included as a Pulsar SDK Provider on the public mailing list. This email must be sent by the Organization’s representative to the Mobile IWG.

Mandatory Requirements

REQ1: P2

The SDK Provider must provide a p2 enabled repository.

REQ2: Server layout

The server layouyt must be:

   - content.xml -> server metadata
   - artifacts.xml -> server artifacts
   - binary/ -> Executable or zip file of the SDK (if using the .zip of .exe formats)
   - plugin/ -> SDK Provider plugins
   - feature/ -> SDK Provider features


REQ3: Netwok Access

The SDK Provider website must only be available via HTTPS. The content.xml file must be directly available on the internet (without any password). The rest of the content on the server might be password protected.

REQ4: SDK Feature

Each SDK that is available on the SDK Provider repository must have its own SDK Feature associated to it. For example. a Serie 40 SDK, must have a feature com.nokia.sdk.javame.serie40 . this feature must have the EULA that will be accepted by the user during the download process.

REQ5: Host Dependencies

The SDK feature must indicate its host dependencies based on eclipse standards (host, windowing toolit and architecture). For example if one specific SDK is only available on windows, its must featured must be filtered to win,win,x86.

REQ6: Software Dependencies

Features and plugins available on the SDK provider must depend only on other features / plugins that are available on the Eclipse servers (External dependencies must be avoided). For instance, a SDK provider plugin can depende on a JDT plugin, but is must not depend on a plugin that is hosted on sourceforge.

Optional Requirements

REQ7: SDK Provider Image

The server layout might optionally include an image that represents the SDK provider (SDK provider logo). If the image is available it will be downloaded and presented on the quickinstall view. If the image is not available, the logo will not be presented, but all the content will. The imagem must have its name as <sdkprovider.png> and must follow the below requirements

   - max width:  TBD
   - max height: TBD
   - number of colors: TBD 

REQ8: SDK Provider Repository Name

The repository name should be <SDK Provider Name> Repository.

REQ9: SDK Provider Categories

The SDK Provider might group their SDKs into categories. For instance: Serie 40 SDKs, Serie 60 SDKs, etc.

REQ10: MTJ SDK Extension

The SDK Provider might implement the MTJ SDK extension point that will automatically register the SDK on MTJ.

REQ11: MTJ JAD Extension

If the SDK provider defines some proprietary JAD attributed, the SDK provider can implement MTJ JAD Extensions to provide an specific editor to those attributed.