Interface LicenseDescriptor


  • public interface LicenseDescriptor
    Provides access to License information.
    Author:
    davidc
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getCloudSyncKey()
      Get the cloud sync key or null
      java.lang.Integer getDays()
      Gets the length (in days) of license validity
      java.util.Map<java.lang.String,​java.lang.Object> getExtras()
      Get the extra public parameters in the license.
      java.lang.String getHeartBeatUrl()
      Gets an alternative URL that the heart beat should post data to, or null if the default URL is to be used.
      java.security.Principal getHolder()
      Gets the holder of the license
      java.lang.String getHolderOrganisation()
      Gets the Organisation that the license was granted to.
      java.util.Date getIssued()
      Gets the date license was issued
      java.security.Principal getIssuer()
      Gets the issuer of the license
      RepoUsage.LicenseMode getLicenseMode()
      Get the license mode e.g TEAM or ENTERPRISE or any future license mode.
      java.lang.Long getMaxDocs()
      Gets the maximum number of documents.
      java.lang.Long getMaxUsers()
      Gets the maximum number of users.
      java.lang.Integer getRemainingDays()
      Ges the number of remaining days left on license
      java.lang.String getSubject()
      Gets the subject of the license
      java.lang.String getTransformationServerExpiryDate()
      ATS Transformation Server Expiry Date
      java.util.Date getValidUntil()
      Gets the date license is valid till
      boolean isClusterEnabled()
      Does this license allow clustering?
      boolean isCryptodocEnabled()
      Does this license allow cryptodoc
      boolean isHeartBeatDisabled()
      Does this license allow the heartbeat to be disabled?
    • Method Detail

      • getIssued

        java.util.Date getIssued()
        Gets the date license was issued
        Returns:
        issue date
      • getValidUntil

        java.util.Date getValidUntil()
        Gets the date license is valid till
        Returns:
        valid until date (or null, if no time limit)
      • getDays

        java.lang.Integer getDays()
        Gets the length (in days) of license validity
        Returns:
        length in days of license validity (or null, if no time limit)
      • getRemainingDays

        java.lang.Integer getRemainingDays()
        Ges the number of remaining days left on license
        Returns:
        remaining days (or null, if no time limit)
      • getSubject

        java.lang.String getSubject()
        Gets the subject of the license
        Returns:
        the subject
      • getHolder

        java.security.Principal getHolder()
        Gets the holder of the license
        Returns:
        the holder
      • getHolderOrganisation

        java.lang.String getHolderOrganisation()
        Gets the Organisation that the license was granted to.
        Returns:
        the holder
      • getIssuer

        java.security.Principal getIssuer()
        Gets the issuer of the license
        Returns:
        the issuer
      • isHeartBeatDisabled

        boolean isHeartBeatDisabled()
        Does this license allow the heartbeat to be disabled?
        Returns:
        true if this license allow the heartbeat to be disabled
      • getHeartBeatUrl

        java.lang.String getHeartBeatUrl()
        Gets an alternative URL that the heart beat should post data to, or null if the default URL is to be used.
        Returns:
        a URL or null
      • getMaxDocs

        java.lang.Long getMaxDocs()
        Gets the maximum number of documents.
        Returns:
        the maximum number of documents or null if there is no limit
      • getMaxUsers

        java.lang.Long getMaxUsers()
        Gets the maximum number of users.
        Returns:
        the maximum number of users or null if there is no limit
      • getLicenseMode

        RepoUsage.LicenseMode getLicenseMode()
        Get the license mode e.g TEAM or ENTERPRISE or any future license mode.
        Returns:
        the license mode.
      • getCloudSyncKey

        java.lang.String getCloudSyncKey()
        Get the cloud sync key or null
        Returns:
        the cloud sync key
      • isClusterEnabled

        boolean isClusterEnabled()
        Does this license allow clustering?
        Returns:
        true if the license allows clustering
      • isCryptodocEnabled

        boolean isCryptodocEnabled()
        Does this license allow cryptodoc
        Returns:
        true if the license allows cryptodoc
      • getTransformationServerExpiryDate

        java.lang.String getTransformationServerExpiryDate()
        ATS Transformation Server Expiry Date
        Returns:
        the ATS Transformation Server Expiry Date or null
      • getExtras

        java.util.Map<java.lang.String,​java.lang.Object> getExtras()
        Get the extra public parameters in the license.
        Returns:
        the parameters