Module com.esri.arcgisruntime
Package com.esri.arcgisruntime

Class License

java.lang.Object
com.esri.arcgisruntime.License
public final class License extends Object
Details of license. For an overview, see License and deployment in ArcGIS Maps SDK for Java.

An application runs in developer mode (LicenseLevel.DEVELOPER) until it is licensed. All functionality is available, but the GeoView is watermarked. To turn off the watermark, a deployed application must run with LicenseLevel.LITE license level or higher. Some functionality is only available with a specific license level; you must license your app appropriately for the functionality it contains. Any attempt to use licensed functionality that is not available at the current LicenseLevel will throw an ArcGISRuntimeException. See Licensing details by class to see which classes and methods are included in each LicenseLevel.

To get LITE, BASIC, STANDARD, or ADVANCED level functionality, a user app is licensed in one of two ways:

  • With license information retrieved after logging in to a portal (LITE and BASIC levels).
  • With a license string acquired from the ArcGIS for Developers website or Esri Customer Service.

To license with a license string, call ArcGISRuntimeEnvironment.setLicense(String). You can obtain a license string by going to the ArcGIS for Developers website. Go to ArcGIS Maps SDK for Java. Alternatively, you can contact Esri Customer Service.

To validate with information from a portal, you need a LicenseInfo instance. This can be obtained by calling Portal.fetchLicenseInfoAsync(). Pass the LicenseInfo to ArcGISRuntimeEnvironment.setLicense(LicenseInfo).

Both these setLicense methods return a LicenseResult indicating whether or not the license is valid.

Note
A license that is set using LicenseInfo will time out if the application has not connected to the network for 30 days or more. A timed-out license has the following consequences: (1) Calling ArcGISRuntimeEnvironment.setLicense(LicenseInfo) returns a LicenseResult in which the LicenseResult.getLicenseStatus() is LicenseStatus.LOGIN_REQUIRED. (2) The application continues to run at the current license level, which is LicenseLevel.DEVELOPER by default.

To resume using the timed-out license, the user must log in to the portal again.

Since:
100.0.0

  • Method Details

    • getLicenseLevel

      public LicenseLevel getLicenseLevel()
      Gets the current license level set in the application. The current license level will be one of the following values from the LicenseLevel enum: DEVELOPER, LITE, BASIC, STANDARD, or ADVANCED.

      By default, when an app is launched it runs at the LicenseLevel.DEVELOPER license level until a deployment license has been provided. The license level can change while an app runs. For instance, the app may start running licensed with LicenseLevel.LITE and can upgrade to LicenseLevel.BASIC or higher. Also note that we cannot downgrade the license level for an app once the LicenseLevel is set.

      Returns:
      the current license level
      Since:
      100.0.0

    • getExpiry

      public Calendar getExpiry()
      Returns the expiry date and time in UTC of a license set with ArcGISRuntimeEnvironment.setLicense(String), or the portal subscription expiry when using ArcGISRuntimeEnvironment.setLicense(LicenseInfo).
      Returns:
      the expiry date of the current license
      Since:
      100.0.0

    • isPermanent

      public boolean isPermanent()
      Returns true if extension license is permanent; false otherwise. Most extension license strings do not expire. Typically, this returns true for a license string with 'none' in the expiration date field.
      Returns:
      true if the license is permanent
      Since:
      100.0.0

    • getLicenseStatus

      public LicenseStatus getLicenseStatus()
      Returns the license status for the current license applied to the app. Usually this status returns LicenseStatus.VALID because the current License object always contains the most current valid license.
      Returns:
      the current status of the license
      Since:
      100.0.0
      See Also:

    • getLicenseType

      public LicenseType getLicenseType()
      Returns current license type for license applied to the app. In developer mode, this method returns LicenseType.DEVELOPER. Otherwise, it returns LicenseType.NAMED_USER if the app was licensed by logging in to a portal and acquiring LicenseInfo, or LicenseType.LICENSE_KEY if the app was licensed from a license string. The license type can change while an app runs. For instance, the app might initially set the license with a license string (type would be LICENSE_KEY) and later re-set the license with a LicenseInfo object (type would be NAMED_USER).
      Returns:
      the license type
      Since:
      100.0.0
      See Also:

    • getExtensions

      public List<ExtensionLicense> getExtensions()
      Returns a list of extension licenses that were applied to the app.

      For valid extension license strings supplied when calling ArcGISRuntimeEnvironment.setLicense(String, List), this list is populated with information about the extension licenses. Use this function to iterate through extension licenses available for the app.

      All extension licensed functionality is available when the app is running in Developer mode. This list will return empty if this is the case, but you will be able to access all functionality while the view displays a watermark.

      Returns:
      the licenses of the extensions
      Since:
      100.0.0