Package com.xwiki.licensing

Interface Licensor

  • All Known Implementing Classes:
    TestLicensor
    @Role
public interface Licensor
    The licensor component used while running functional tests for licensed applications.
    Since:
    1.21
    Version:
    $Id$

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.xwiki.licensing.License addLicense​(org.xwiki.extension.ExtensionId extensionId, com.xwiki.licensing.LicenseType licenseType)  
      com.xwiki.licensing.License addLicense​(org.xwiki.extension.ExtensionId extensionId, com.xwiki.licensing.LicenseType licenseType, int expirationDays, long maxUserCount)  
      com.xwiki.licensing.License addLicense​(org.xwiki.model.reference.EntityReference entityReference, com.xwiki.licensing.LicenseType licenseType)  
      com.xwiki.licensing.License addLicense​(org.xwiki.model.reference.EntityReference entityReference, com.xwiki.licensing.LicenseType licenseType, int expirationDays, long maxUserCount)  
      com.xwiki.licensing.License getLicense()
      Retrieve the currently applicable license for the current context document if any.
      com.xwiki.licensing.License getLicense​(org.xwiki.extension.ExtensionId extensionId)
      Retrieve the currently applicable license for the given installed extension.
      com.xwiki.licensing.License getLicense​(org.xwiki.model.reference.EntityReference reference)
      Get the license applicable to the given reference.
      boolean hasLicensure()  
      boolean hasLicensure​(org.xwiki.extension.ExtensionId extensionId)
      Check if the given extension is covered by a valid license.
      boolean hasLicensure​(org.xwiki.model.reference.EntityReference reference)
      Check if the given entity is covered by a valid license.

    • Method Detail

      • hasLicensure

        boolean hasLicensure​(org.xwiki.model.reference.EntityReference reference)
        Check if the given entity is covered by a valid license.
        Parameters:
        reference - the reference of the entity for which licensure should be checked.
        Returns:
        true if the given reference has a valid license or is not subject to licensing.

      • hasLicensure

        boolean hasLicensure​(org.xwiki.extension.ExtensionId extensionId)
        Check if the given extension is covered by a valid license.
        Parameters:
        extensionId - the identifier of the extension for which licensure should be checked.
        Returns:
        true if the given extension has a valid license or is not subject to licensing.

      • hasLicensure

        boolean hasLicensure()
        Returns:
        true if the current document has a valid license or is not subject to licensing.

      • getLicense

        com.xwiki.licensing.License getLicense()
        Retrieve the currently applicable license for the current context document if any.
        Returns:
        a license, or null if there is no current document, or the current document is not subject to licensing.

      • getLicense

        com.xwiki.licensing.License getLicense​(org.xwiki.extension.ExtensionId extensionId)
        Retrieve the currently applicable license for the given installed extension.
        Parameters:
        extensionId - identifier of an installed extension
        Returns:
        a license, or null if the given installed extension is not subject to licensing.

      • getLicense

        com.xwiki.licensing.License getLicense​(org.xwiki.model.reference.EntityReference reference)
        Get the license applicable to the given reference.
        Parameters:
        reference - the reference to get the license from.
        Returns:
        a license, or null if the given reference is not subject to licensing.

      • addLicense

        com.xwiki.licensing.License addLicense​(org.xwiki.extension.ExtensionId extensionId,
                                       com.xwiki.licensing.LicenseType licenseType)
        Parameters:
        extensionId - identifier of an installed extension
        licenseType - the type of License to add (FREE, TRIAL, PAID)
        Returns:
        the newly created License

      • addLicense

        com.xwiki.licensing.License addLicense​(org.xwiki.extension.ExtensionId extensionId,
                                       com.xwiki.licensing.LicenseType licenseType,
                                       int expirationDays,
                                       long maxUserCount)
        Parameters:
        extensionId - identifier of an installed extension
        licenseType - the type of License to add (FREE, TRIAL, PAID)
        expirationDays - the number of days until the license expires
        maxUserCount - the maximum number of users allowed under this license
        Returns:
        the newly created License

      • addLicense

        com.xwiki.licensing.License addLicense​(org.xwiki.model.reference.EntityReference entityReference,
                                       com.xwiki.licensing.LicenseType licenseType)
        Parameters:
        entityReference - the reference of the entity for which the license applies
        licenseType - the type of License to add (FREE, TRIAL, PAID)
        Returns:
        the newly created License

      • addLicense

        com.xwiki.licensing.License addLicense​(org.xwiki.model.reference.EntityReference entityReference,
                                       com.xwiki.licensing.LicenseType licenseType,
                                       int expirationDays,
                                       long maxUserCount)
        Parameters:
        entityReference - the reference of the entity for which the license applies
        licenseType - the type of License to add (FREE, TRIAL, PAID)
        expirationDays - the number of days until the license expires
        maxUserCount - the maximum number of users allowed under this license
        Returns:
        the newly created License