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
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the base path for the corresponding API plugin that the request belongs to.
    Returns the URI for the metadata-catalog of API plugin that the request belongs to.
    Identifies at runtime the version specified, in the request URL, by the client.
  • Method Details

    • versionNumber

      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

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

      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