public final class License extends ObjectProvides methods to manage the license of the ArcGIS Runtime. For an overview, see License and deployment in either ArcGIS Runtime API for Android or ArcGIS Runtime API for Java.
An application runs in developer mode (
LicenseLevel.DEVELOPER) until it is licensed. All functionality is available, but the
GeoViewis watermarked. To turn off the watermark, a deployed application must run with
LicenseLevel.LITElicense 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
LicenseLevelwill throw an
ArcGISRuntimeException. See Licensing details by class to see which classes and methods are included in each
Your app can be licensed in one of two ways:
- With a license string acquired from the ArcGIS for Developers website or Esri Customer Service.
- With license information retrieved after logging in to a portal.
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 either ArcGIS Runtime API for Android or ArcGIS Runtime API for Java Alternatively, you can contact Esri Customer Service.
To validate with information from a portal, you need a
LicenseInfoinstance. This can be obtained by calling
Portal.fetchLicenseInfoAsync(). Pass the LicenseInfo to
setLicensemethods return a
LicenseResultindicating whether or not the license is valid.
A license that is set using
LicenseInfowill 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
LicenseResultin which the
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.
All Methods Instance Methods Concrete Methods Modifier and Type Method Description
getExtensions()Returns a list of extension licenses that were applied to the app.
getLicenseLevel()Gets the current license level set in the application.
getLicenseStatus()Returns the license status for the current license applied to the app.
getLicenseType()Returns current license type for license applied to the app.
isPermanent()Returns true if extension license is permanent; false otherwise.
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
ADVANCED. By default, when an app is launched it runs at the
LicenseLevel.DEVELOPERlicense 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.LITEand can upgrade to
LicenseLevel.BASICor higher. Also note that we cannot downgrade the license level for an app once the
- the current license level
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
- the expiry date of the current license
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.
- true if the license is permanent
public LicenseStatus getLicenseStatus()Returns the license status for the current license applied to the app. Usually this status returns
LicenseStatus.VALIDbecause the current
Licenseobject always contains the most current valid license.
- the current status of the license
- See Also:
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_USERif the app was licensed by logging in to a portal and acquiring
LicenseType.LICENSE_KEYif 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
LicenseInfoobject (type would be
- the license type
- See Also:
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 license. Use this function to iterate through extension licenses that are available in the app environment. 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.
- the licenses of the extensions