Interface LicenceInformation


public interface LicenceInformation
Licence information.
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    Deprecated, for removal: This API element is subject to removal in a future version.
    For serialisation compatibility with pre-17.0.0.
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    Gets the amount of days the licence needs to be activated.
    Gets the included features which are additionally included besides the standard features of the licensed edition.
    Returns additional licence attributes.
    Returns the customer ID.
    Returns the ID of the distributor, or null if not applicable.
    Gets the name of the licensed edition.
    byte[]
    Gets the IP address limit as byte[] or null if there is no limit
    byte
    Returns the mask value, or 0 if there is no mask or no limit.
    int
    Returns the overall number of users which are allowed to be known by the product or 0 if there is no user limit.
    int
    Returns the ID of the licence.
    Returns the licence type.
    Returns the name of the person or organisation to whom the licence has been issued, as it is displayed e.g.
    Gets the mail addresses of the licensee.
    Returns the names of the process types which are allowed for execution or null if unlimited.
    default String
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use getReleaseName() instead.
    Gets the release name for which this licence applies.
    Gets the date until the licence is valid, or null if the usage time is not limited.
    int
    Returns the transactions which are allowed per day, or 0 if the daily transactions are not limited.
    int
    Returns the number of users which are allowed to be logged on concurrently or 0 if there is no user limit.
  • Method Details

    • getLicenceID

      int getLicenceID()
      Returns the ID of the licence.
      Returns:
      The licence ID.
    • getCustomerID

      String getCustomerID()
      Returns the customer ID.
      Returns:
      The ID of the customer.
    • getDistributorID

      String getDistributorID()
      Returns the ID of the distributor, or null if not applicable.
      Returns:
      The ID of the distributor, or null if not applicable.
    • getLicenceType

      String getLicenceType()
      Returns the licence type.
      Returns:
      The licence type.
    • getLicensee

      String getLicensee()
      Returns the name of the person or organisation to whom the licence has been issued, as it is displayed e.g. in the user interface.
      Returns:
      The licensee.
    • getMailAddresses

      List<String> getMailAddresses()
      Gets the mail addresses of the licensee. This addresses will be notified in case of severe licence violations.
      For very old licences this can be an empty collection.
      Returns:
      The mail addresses of the licensee which to notify in case of severe licence violations.
    • getRelaseName

      @Deprecated(since="17.0.0", forRemoval=true) default String getRelaseName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use getReleaseName() instead.
      Gets the release name for which this licence applies.
      Returns:
      The release name for which this licence applies. This is never null.
    • getReleaseName

      String getReleaseName()
      Gets the release name for which this licence applies.
      Returns:
      The release name for which this licence applies. This is never null.
    • getEdition

      String getEdition()
      Gets the name of the licensed edition.
      Returns:
      The name of the licensed edition. This is never null.
    • getActivationInterval

      int getActivationInterval()
      Gets the amount of days the licence needs to be activated. 0 indicates a licence without activation, 2147483647 a one-time activation.
      Returns:
      The amount of days the licence needs to be activated.
    • getTimeLimit

      LocalDate getTimeLimit()
      Gets the date until the licence is valid, or null if the usage time is not limited.
      Returns:
      The date until the licence is valid, or null if the usage time is not limited.
    • getTransactionLimit

      int getTransactionLimit()
      Returns the transactions which are allowed per day, or 0 if the daily transactions are not limited.
      Returns:
      The transactions which are allowed per day, or 0 if unlimited.
    • getKnownUserLimit

      int getKnownUserLimit()
      Returns the overall number of users which are allowed to be known by the product or 0 if there is no user limit.
      Returns:
      The overall number of users which are allowed to use the product or 0 if there is no user limit.
    • getUsingUserLimit

      int getUsingUserLimit()
      Returns the number of users which are allowed to be logged on concurrently or 0 if there is no user limit.
      Returns:
      The overall number of users which are allowed to be logged on concurrently or 0 if there is no user limit.
    • getIpAddressLimit

      byte[] getIpAddressLimit()
      Gets the IP address limit as byte[] or null if there is no limit
      Returns:
      The IP address limit as byte[] or null if there is no limit.
    • getIPAddressMask

      byte getIPAddressMask()
      Returns the mask value, or 0 if there is no mask or no limit.
      Returns:
      The mask value, or 0 if there is no mask or no limit.
    • getProcessTypeLimit

      String[] getProcessTypeLimit()
      Returns the names of the process types which are allowed for execution or null if unlimited.
      Returns:
      The names of the process types which are allowed for execution or null if unlimited.
    • getAdditions

      Map<String,String> getAdditions()
      Returns additional licence attributes.
      Returns:
      Additional licence attributes.
    • getAdditionalFeatures

      String[] getAdditionalFeatures()
      Gets the included features which are additionally included besides the standard features of the licensed edition.
      Returns:
      The additionally included features besides the standard features of the licensed edition. If only the standard features are licensed, null will be returned.