The REST service provides a RESTful interface to clients that need to manage an OSGi framework through a network connection. Other components running on the same framework can contribute their own specific REST interface and make it available and discoverable by registering this marker service using the Whiteboard pattern.
Integration of third-party REST interfaces with the framework REST service on the implementation level might not always be possible since it requires knowledge about the underlying implementation and an extension mechanism on that level. Specific technologies such as servlets might support this but the REST service could as well be implemented without the use of a supporting abstraction layer and not offer extensibility.
Using this marker service, the REST service includes the advertised service in the Extensions Resource, allowing clients to discover it and use the extension's functionality.
| Modifier and Type | Field and Description |
|---|---|
| public static final String | NAME
This service property describes the package name of the technology manageable by this REST API extension. |
| public static final String | SERVICE
This service property refers to the id of the service the REST API extension provides management capabilities for. |
| public static final String | URI_PATH
This service property describes a URI to the REST extension on this local machine. |
| NAME | back to summary |
|---|---|
| public static final String NAME This service property describes the package name of the technology
manageable by this REST API extension. Services specified in OSGi
specifications must use their canonical package name as the name.
Third-party technologies should also use their package names. The type of this
property is | |
| SERVICE | back to summary |
|---|---|
| public static final String SERVICE This service property refers to the id of the service the REST API
extension provides management capabilities for. This can be useful if more
than one service of a given type is present in the framework. For example
if more than one Http Service is available this property is used to
associate a REST extension managing the Http Service with a specific
service instance.
The type of the property is
| |
| URI_PATH | back to summary |
|---|---|
| public static final String URI_PATH This service property describes a URI to the REST extension on this local
machine. It is either an fully qualified URI with a different port if no
integration with the framework REST service is possible or a relative URI
implicitly using the same port if integration is possible.
The type of this property is
| |