Package com.polarion.alm.tracker.oslc

Interface IOslcLicenseCheck

public interface IOslcLicenseCheck
This interface can be used to perform a license check for the OSLC use cases in Polarion. The use cases are:
  • Add a friend server to Polarion.
  • Add a project association to Polarion for a configured friend server.
  • Add an OSLC link to a Polarion Work Item or LiveDoc.
  • Retrieve an OSLC preview when hovering over an OSLC link.

If any class implementing this interface returns a license error string, the use cases above will be blocked, and the user will be presented with a license error string. If a license is discovered, the implementing classes return null, and the use cases work.

To contribute an implementation of this interface, please use Guice.

Since:
3.24.4

  • Method Details

    • checkLicenseByFriendServerUrl

      @Nullable String checkLicenseByFriendServerUrl(@NotNull String friendRootServicesUrl)
      Checks if there is an OSLC license for the given OSLC friend server URL.
      Parameters:
      friendRootServicesUrl - The URL where the friend's root services are located.
      Returns:
      A String indicating the license problem (e.g.: missing, expired), or null to indicate that there is a license.

    • checkLicenseByResourceUrl

      @Nullable String checkLicenseByResourceUrl(@NotNull String resourceUrl)
      Checks if there is an OSLC license for the given OSLC resource URL.
      Parameters:
      resourceUrl - The URL of the OSLC resource (typically, the item that a link points to).
      Returns:
      A String indicating the license problem (e.g.: missing, expired), or null to indicate that there is a license.