Package oracle.dbtools.plugin.api.servlet

Interface VersionedPlugin

  • public interface VersionedPlugin
    Represents the versioned API plugin, specified in a META-INF/plugin.json, that corresponds to a particular request and the servlets @BelongsTo annotation. Use VersionedPlugins to get an instance of this based on the HttpServletRequest at runtime.
    Author:
    peobrie
  • <section role="region">

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.net.URI basePathURI()
      Returns the base path for the corresponding API plugin that the request belongs to.
      java.net.URI metadataCatalogURI()
      Returns the URI for the metadata-catalog of API plugin that the request belongs to.
      java.lang.String versionNumber()
      Identifies at runtime the version specified, in the request URL, by the client.
    </section>
  • <section role="region">

    • Method Detail

      • versionNumber

        java.lang.String versionNumber()
        Identifies at runtime the version specified, in the request URL, by the client.
        Returns:
        String representing the version number in the request

      • basePathURI

        java.net.URI basePathURI()
        Returns the base path for the corresponding API plugin that the request belongs to.
        Returns:
        URI instance

      • metadataCatalogURI

        java.net.URI metadataCatalogURI()
        Returns the URI for the metadata-catalog of API plugin that the request belongs to. The URI will include the version number in the path as specified by the request.
        Returns:
        URI instance
    </section>