Package ch.autumo.commons.application

Interface LicensedApplication

All Superinterfaces:
SecureApplication
All Known Implementing Classes:
BaseApp
public interface LicensedApplication extends SecureApplication
Licensed application - every licensed application must implement this and providing the following constructor:
- public MyApplication(RegistrationVersion)

  • Field Details

  • Method Details

    • initializeBaseConfig

      void initializeBaseConfig(String rootFolder) throws Exception
      Initializes the base configuration if any ('base.ifc'). The root folder is usually base application configuration path where the file application configuration 'app.cfg' lies. It is given as a parameter, because the base configuration will possibly be loaded on demand in different context (e.g. registration tool, GUI desktop, etc.). In some cases you might want to overwrite this method to get access to more encrypted base configuration values. The encrypted values follow the encryption scheme of Encoder. Use this encoder with the 'internal'-option to get such values.
      Parameters:
      rootFolder - base configuration root folder or null when the configuration context must be resolved differently, e.g. within a desktop application.
      Throws:
      Exception - if initializarion fails

    • getRegVersion

      RegistrationVersion getRegVersion()
      Returns the registration version for this application. This version is usually lower than the current application version; It is the base or main release that can have minor/major updates. Part of the whole licensing mechanism, if applied.
      Returns:
      registration version

    • getAppTitle

      String getAppTitle()
      Get application title. Part of the online license check, if applied.
      Returns:
      application title

    • getAppVersion

      String getAppVersion()
      Get current application version as string "x.x.x". It is also used for online upgrade checks, if applied.
      Returns:
      current application version

    • getProductKey

      String getProductKey()
      Every product has a unique key. Part of the online license check, if applied.
      Returns:
      product key

    • getLicInfoTitle

      String getLicInfoTitle()
      Get license info title - unique for every application.
      Returns:
      license info title

    • isAllowed2ReadEnvData

      boolean isAllowed2ReadEnvData()
      Identifies if this application is allowed to read environment data during online registration.
      Returns:
      true if so

    • setAllowed2ReadEnvData

      void setAllowed2ReadEnvData(boolean allow)
      Set application to allow to read user's environment data through online registration process.
      Parameters:
      allow - allow to read client environment data

    • getRuntimeType

      String getRuntimeType()
      Get runtime type. Part of the local runtime check.
      Returns:
      RT type
      See Also:

    • getLicType

      String getLicType()
      Get license type. Part of the online license check, if applied.
      Returns:
      lic type

    • getInlineChecks

      InlineChecks getInlineChecks()
      Get inline checks.
      Returns:
      inline checks

    • getLicSrvUrl

      String getLicSrvUrl()
      Get license server URL.
      Returns:
      license serevr URL

    • getApiKey

      String getApiKey()
      Get API key for online license server.
      Returns:
      API key

    • getLicensePath

      String getLicensePath()
      Get local path to license.
      Returns:
      license path