Package com.inductiveautomation.ignition.gateway.licensing

Interface LicenseManager

  • public interface LicenseManager

    • Method Detail

      • addLicenseStateUpdateListener

        void addLicenseStateUpdateListener​(java.lang.String moduleId,
                                   LicenseStateUpdateListener listener)
        Register with the LicenseManager to receive updates about a specified modules LicenseState.
        Parameters:
        moduleId - The id of the module you want to receive LicenseState updates for.
        listener - LicenseStateUpdateListener that will receive the updates.

      • addLicenseStateUpdateListener

        void addLicenseStateUpdateListener​(LicenseStateUpdateListener listener)
        Register with the LicenseManager to receive updates about any license change, regardless of module.
        Parameters:
        listener - LicenseStateUpdateListener that will receive the updates.

      • addPlatformLicenseStateUpdateListener

        void addPlatformLicenseStateUpdateListener​(LicenseStateUpdateListener listener)
        Register with the LicenseManager to receive updates about the license state of the platform
        Parameters:
        listener - LicenseStateUpdateListener that will receive the updates.

      • removeLicenseStateUpdateListener

        void removeLicenseStateUpdateListener​(java.lang.String moduleId,
                                      LicenseStateUpdateListener listener)
        Stop receiving LicenseState updates for a specified module.
        Parameters:
        moduleId - The id of the module you want to stop receiving LicenseState updates for.
        listener - LicenseStateUpdateListener that will no longer receive the updates.

      • removeLicenseStateUpdateListener

        void removeLicenseStateUpdateListener​(LicenseStateUpdateListener listener)
        Remove a LicenseStateUpdateListener that is not registered to a specific module
        Parameters:
        listener - LicenseStateUpdateListener that will no longer receive the updates.

      • removePlatformLicenseStateUpdateListener

        void removePlatformLicenseStateUpdateListener​(LicenseStateUpdateListener listener)
        Remove a LicenseStateUpdateListener that is listening to platform changes
        Parameters:
        listener - LicenseStateUpdateListener that will no longer receive the updates.

      • getModuleLicense

        java.util.Optional<LicenseDetails> getModuleLicense​(java.lang.String moduleId)
        Looks up the module license details for a specific module. This method will look through all installed licenses, not just the primary license.

      • getPlatformLicense

        java.util.Optional<LicenseDetails> getPlatformLicense()

      • isActivated

        boolean isActivated()
        Returns:
        true if there is a valid platform license installed.

      • getLicenseState

        LicenseState getLicenseState​(java.lang.String moduleId)
        Gets the current LicenseState for a specified module.
        Parameters:
        moduleId - The id of the module you want the LicenseState for.
        Returns:
        LicenseState of the specified module.

      • getPlatformLicenseState

        LicenseState getPlatformLicenseState()

      • getDemoTimeRemaining

        int getDemoTimeRemaining()
        Returns the amount of demo time remaining in seconds.