com.esri.arcgis.system
Class AoAuthorizeLicense

java.lang.Object
  com.esri.arcgis.system.AoAuthorizeLicense

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IAuthorizeLicense, Serializable

public class AoAuthorizeLicense
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IAuthorizeLicense

Class performs license authorization.

Description

The AoAuthorizeLicense object can be used by developers to silently 'authorize' the ArcGIS Engine Runtime components on client systems.

If the end user of the standalone custom ArcGIS Engine application has no direct contact with ESRI, the application can either call the SoftwareAuthorization.exe or use the AoAuthorizeLicense object to unlock the functionality of ArcGIS Engine. The advantage of this method is that the software will be authorized silently and does not require the end user to enter registration information.

The developer would follows the steps below to deploy the ArcGIS Engine Runtime to the end user:

1. Review and confirm the licensing requirments of the application.
2. Purchase the necessary redistributable ArcGIS Engine Runtime product and any options (3DAnalyst, GeoDatabase Editing, SpatialAnalyst etc).
3. Register the ArcGIS Engine product, and any options with ESRI.
4. Receive a redistributable authoriztion file (.ecp)

The client would install the custom built ArcGIS Engine application. The installation would:

1. Install the ArcGIS Engine Runtime software.
2. Call the SoftwareAuthorization.exe or use the AoAuthorizeLicense object to unlock the functionality of ArcGIS Engine.
3. At application start time the AoInitialize object is used to initialize the application with a license.

See the topics on licensing and deployment for more information on deploying the ArcGIS Engine Runtime.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

AoAuthorizeLicense()
Constructs a AoAuthorizeLicense using ArcGIS Engine.

AoAuthorizeLicense(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AoAuthorizeLicense theAoAuthorizeLicense = (AoAuthorizeLicense) obj;

Method Summary

void	addLicense(String featureName, int versionNumber, String timeoutDate, String registrationNumber, String authorizationCode) Add a new feature to the authorization file.
void	addLicenseFromFile(String fileName) Add new feature authorizations from file.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
String	getFeaturesAdded() Retrieves the details of the new features added to the authorization file.
String	getLastError() Retrieves the last error message from an attempt to add new features to the authorization file.
int	hashCode() the hashcode for this object

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

AoAuthorizeLicense

public AoAuthorizeLicense()
                   throws IOException,
                          UnknownHostException

Constructs a AoAuthorizeLicense using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

AoAuthorizeLicense

public AoAuthorizeLicense(Object obj)
                   throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AoAuthorizeLicense theAoAuthorizeLicense = (AoAuthorizeLicense) obj;

Construct a AoAuthorizeLicense using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to AoAuthorizeLicense.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getLastError

public String getLastError()
                    throws IOException,
                           AutomationException

Retrieves the last error message from an attempt to add new features to the authorization file.

Description

The LastError property returns information about why the AddLicense method failed to add the specified license to the keycodes file. Use the LastError property after the AddLicense method to retrieve information on the nature of any error.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLastError in interface IAuthorizeLicense

Returns:

The lastError

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeaturesAdded

public String getFeaturesAdded()
                        throws IOException,
                               AutomationException

Retrieves the details of the new features added to the authorization file.

Description

Use the FeaturesAdded property after the AddLicenseFromFile and AddLicense methods to return a list of the license features that were successfully added to the keycodes file.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFeaturesAdded in interface IAuthorizeLicense

Returns:

The featuresAdded

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addLicense

public void addLicense(String featureName,
                       int versionNumber,
                       String timeoutDate,
                       String registrationNumber,
                       String authorizationCode)
                throws IOException,
                       AutomationException

Add a new feature to the authorization file.

Description

The AddLicense method takes the specified license information and adds it to the keycodes file.

Use the LastError property to returns information about why the AddLicense method failed to add the specified license to the keycodes file.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

addLicense in interface IAuthorizeLicense

Parameters:

featureName - The featureName (in)

versionNumber - The versionNumber (in)

timeoutDate - The timeoutDate (in)

registrationNumber - The registrationNumber (in)

authorizationCode - The authorizationCode (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addLicenseFromFile

public void addLicenseFromFile(String fileName)
                        throws IOException,
                               AutomationException

Add new feature authorizations from file.

Description

The AddLicenseFromFile method reads the authorization information in the supplied esri copy protected license file (*.ecp) and adds it to the keycodes file.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

addLicenseFromFile in interface IAuthorizeLicense

Parameters:

fileName - The fileName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.