Package org.osgi.service.rest

Interface RestApiExtension

  • public interface RestApiExtension
    Marker interface for registering extensions to the Rest API service.

    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.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String NAME
      This service property describes the package name of the technology manageable by this REST API extension.
      static java.lang.String SERVICE
      This service property refers to the id of the service the REST API extension provides management capabilities for.
      static java.lang.String URI_PATH
      This service property describes a URI to the REST extension on this local machine.

    • Field Detail

      • URI_PATH

        static final java.lang.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 java.lang.String and the property is mandatory.
        See Also:
        Constant Field Values

      • NAME

        static final java.lang.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 java.lang.String and the property is mandatory.
        See Also:
        Constant Field Values

      • SERVICE

        static final java.lang.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 java.lang.Long and the property is optional; if the REST extension is not directly associated with a service in the service registry, the property should not be set.
        See Also:
        Constant Field Values