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.
Difference between revisions of "SMILA/Documentation/SMILA Versioning"
m (→Getting version via REST API) |
m (→org.eclipse.smila.versions.SMILAVersionProvider) |
||
(One intermediate revision by the same user not shown) | |||
Line 1: | Line 1: | ||
− | = SMILA | + | = SMILA Version Information = |
− | The current SMILA version is displayed via REST API. The version is delivered by a ''VersionManager'' service via registered ''VersionProvider'' service(s). | + | The current SMILA version is displayed via REST API. The version is delivered by a ''VersionManager'' service via registered ''VersionProvider'' service(s). Although only one version - the ''smila'' version - is currently used, there may be other VersionProvider components whose version information could also be added. |
== Getting version via REST API == | == Getting version via REST API == | ||
Line 16: | Line 16: | ||
* ''<version number>'' (e.g. "1.1.0"): comes from <tt>configuration/org.eclipse.smila.versions/version.properties</tt> | * ''<version number>'' (e.g. "1.1.0"): comes from <tt>configuration/org.eclipse.smila.versions/version.properties</tt> | ||
* ''<SVN revision>''(e.g. "2885"): current SVN revision at time of build | * ''<SVN revision>''(e.g. "2885"): current SVN revision at time of build | ||
− | |||
− | |||
== Bundle org.eclipse.smila.versions == | == Bundle org.eclipse.smila.versions == | ||
Line 25: | Line 23: | ||
=== org.eclipse.smila.versions.VersionProvider === | === org.eclipse.smila.versions.VersionProvider === | ||
− | Services implementing this interface (and providing it via OSGI DS) are able to deliver their own version. | + | Services implementing this interface (and providing it via OSGI DS) are able to deliver their own version information. |
=== org.eclipse.smila.versions.VersionManager === | === org.eclipse.smila.versions.VersionManager === | ||
− | This service provides an API for dynamically registering VersionProvider services. | + | This service provides an API for dynamically registering VersionProvider services. It delivers the sum of all provided version information which is displayed in the REST API. |
− | === org.eclipse.smila.versions. | + | === org.eclipse.smila.versions.SmilaVersionProvider === |
− | The <tt>VersionProvider</tt> implementation that reads the SMILA version from the <tt>configuration/org.eclipse.smila.versions/version.properties</tt> | + | The <tt>VersionProvider</tt> implementation that reads the SMILA version from the <tt>configuration/org.eclipse.smila.versions/version.properties</tt>. |
Latest revision as of 05:53, 29 June 2012
Contents
SMILA Version Information
The current SMILA version is displayed via REST API. The version is delivered by a VersionManager service via registered VersionProvider service(s). Although only one version - the smila version - is currently used, there may be other VersionProvider components whose version information could also be added.
Getting version via REST API
After starting SMILA, the main site of the REST API will show you the SMILA version:
version: { smila: "1.1.0.2885" }, ...
The smila version is a compound of: <version number>.<SVN revision>
- <version number> (e.g. "1.1.0"): comes from configuration/org.eclipse.smila.versions/version.properties
- <SVN revision>(e.g. "2885"): current SVN revision at time of build
Bundle org.eclipse.smila.versions
The JavaDoc for the bundle can be found here.
org.eclipse.smila.versions.VersionProvider
Services implementing this interface (and providing it via OSGI DS) are able to deliver their own version information.
org.eclipse.smila.versions.VersionManager
This service provides an API for dynamically registering VersionProvider services. It delivers the sum of all provided version information which is displayed in the REST API.
org.eclipse.smila.versions.SmilaVersionProvider
The VersionProvider implementation that reads the SMILA version from the configuration/org.eclipse.smila.versions/version.properties.