LicenseInitializer.cs
// Copyright 2010 ESRI // // All rights reserved under the copyright laws of the United States // and applicable international laws, treaties, and conventions. // // You may freely redistribute and use this sample code, with or // without modification, provided you include the original copyright // notice and use restrictions. // // See the use restrictions. // using System; using System.Collections.Generic; using ESRI.ArcGIS.esriSystem; //FILE AUTOMATICALLY GENERATED BY ESRI LICENSE INITIALIZATION ADDIN //YOU SHOULD NOT NORMALLY EDIT OR REMOVE THIS FILE FROM THE PROJECT namespace VRP_CSharp { internal sealed class LicenseInitializer { private IAoInitialize m_AoInit = new AoInitializeClass(); #region Private members private const string MessageNoLicensesRequested = "Product: No licenses were requested"; private const string MessageProductAvailable = "Product: {0}: Available"; private const string MessageProductNotLicensed = "Product: {0}: Not Licensed"; private const string MessageExtensionAvailable = " Extension: {0}: Available"; private const string MessageExtensionNotLicensed = " Extension: {0}: Not Licensed"; private const string MessageExtensionFailed = " Extension: {0}: Failed"; private const string MessageExtensionUnavailable = " Extension: {0}: Unavailable"; private bool m_hasShutDown = false; private bool m_hasInitializeProduct = false; private List<int> m_requestedProducts; private List<esriLicenseExtensionCode> m_requestedExtensions; private Dictionary<esriLicenseProductCode, esriLicenseStatus> m_productStatus = new Dictionary<esriLicenseProductCode, esriLicenseStatus>(); private Dictionary<esriLicenseExtensionCode, esriLicenseStatus> m_extensionStatus = new Dictionary<esriLicenseExtensionCode, esriLicenseStatus>(); private bool m_productCheckOrdering = true; //default from low to high #endregion public bool InitializeApplication(esriLicenseProductCode[] productCodes, esriLicenseExtensionCode[] extensionLics) { //Cache product codes by enum int so can be sorted without custom sorter m_requestedProducts = new List<int>(); foreach (esriLicenseProductCode code in productCodes) { int requestCodeNum = Convert.ToInt32(code); if (!m_requestedProducts.Contains(requestCodeNum)) { m_requestedProducts.Add(requestCodeNum); } } AddExtensions(extensionLics); return Initialize(); } /// <summary> /// A summary of the status of product and extensions initialization. /// </summary> public string LicenseMessage() { string prodStatus = string.Empty; if (m_productStatus == null || m_productStatus.Count == 0) { prodStatus = MessageNoLicensesRequested + Environment.NewLine; } else if (m_productStatus.ContainsValue(esriLicenseStatus.esriLicenseAlreadyInitialized) || m_productStatus.ContainsValue(esriLicenseStatus.esriLicenseCheckedOut)) { prodStatus = ReportInformation(m_AoInit as ILicenseInformation, m_AoInit.InitializedProduct(), esriLicenseStatus.esriLicenseCheckedOut) + Environment.NewLine; } else { //Failed... foreach (KeyValuePair<esriLicenseProductCode, esriLicenseStatus> item in m_productStatus) { prodStatus += ReportInformation(m_AoInit as ILicenseInformation, item.Key, item.Value) + Environment.NewLine; } } string extStatus = string.Empty; foreach (KeyValuePair<esriLicenseExtensionCode, esriLicenseStatus> item in m_extensionStatus) { string info = ReportInformation(m_AoInit as ILicenseInformation, item.Key, item.Value); if (!string.IsNullOrEmpty(info)) extStatus += info + Environment.NewLine; } string status = prodStatus + extStatus; return status.Trim(); } /// <summary> /// Shuts down AoInitialize object and check back in extensions to ensure /// any ESRI libraries that have been used are unloaded in the correct order. /// </summary> /// <remarks>Once Shutdown has been called, you cannot re-initialize the product license /// and should not make any ArcObjects call.</remarks> public void ShutdownApplication() { if (m_hasShutDown) return; //Check back in extensions foreach (KeyValuePair<esriLicenseExtensionCode, esriLicenseStatus> item in m_extensionStatus) { if (item.Value == esriLicenseStatus.esriLicenseCheckedOut) m_AoInit.CheckInExtension(item.Key); } m_requestedProducts.Clear(); m_requestedExtensions.Clear(); m_extensionStatus.Clear(); m_productStatus.Clear(); m_AoInit.Shutdown(); m_hasShutDown = true; //m_hasInitializeProduct = false; } /// <summary> /// Indicates if the extension is currently checked out. /// </summary> public bool IsExtensionCheckedOut(esriLicenseExtensionCode code) { return m_AoInit.IsExtensionCheckedOut(code); } /// <summary> /// Set the extension(s) to be checked out for your ArcObjects code. /// </summary> public bool AddExtensions(params esriLicenseExtensionCode[] requestCodes) { if (m_requestedExtensions == null) m_requestedExtensions = new List<esriLicenseExtensionCode>(); foreach (esriLicenseExtensionCode code in requestCodes) { if (!m_requestedExtensions.Contains(code)) m_requestedExtensions.Add(code); } if (m_hasInitializeProduct) return CheckOutLicenses(this.InitializedProduct); return false; } /// <summary> /// Check in extension(s) when it is no longer needed. /// </summary> public void RemoveExtensions(params esriLicenseExtensionCode[] requestCodes) { if (m_extensionStatus == null || m_extensionStatus.Count == 0) return; foreach (esriLicenseExtensionCode code in requestCodes) { if (m_extensionStatus.ContainsKey(code)) { if (m_AoInit.CheckInExtension(code) == esriLicenseStatus.esriLicenseCheckedIn) { m_extensionStatus[code] = esriLicenseStatus.esriLicenseCheckedIn; } } } } /// <summary> /// Get/Set the ordering of product code checking. If true, check from lowest to /// highest license. True by default. /// </summary> public bool InitializeLowerProductFirst { get { return m_productCheckOrdering; } set { m_productCheckOrdering = value; } } /// <summary> /// Retrieves the product code initialized in the ArcObjects application /// </summary> public esriLicenseProductCode InitializedProduct { get { try { return m_AoInit.InitializedProduct(); } catch { return 0; } } } #region Helper methods private bool Initialize() { if (m_requestedProducts == null || m_requestedProducts.Count == 0) return false; esriLicenseProductCode currentProduct = new esriLicenseProductCode(); bool productInitialized = false; //Try to initialize a product ILicenseInformation licInfo = (ILicenseInformation)m_AoInit; m_requestedProducts.Sort(); if (!InitializeLowerProductFirst) //Request license from highest to lowest m_requestedProducts.Reverse(); foreach (int prodNumber in m_requestedProducts) { esriLicenseProductCode prod = (esriLicenseProductCode)Enum.ToObject(typeof(esriLicenseProductCode), prodNumber); esriLicenseStatus status = m_AoInit.IsProductCodeAvailable(prod); if (status == esriLicenseStatus.esriLicenseAvailable) { status = m_AoInit.Initialize(prod); if (status == esriLicenseStatus.esriLicenseAlreadyInitialized || status == esriLicenseStatus.esriLicenseCheckedOut) { productInitialized = true; currentProduct = m_AoInit.InitializedProduct(); } } m_productStatus.Add(prod, status); if (productInitialized) break; } m_hasInitializeProduct = productInitialized; m_requestedProducts.Clear(); //No product is initialized after trying all requested licenses, quit if (!productInitialized) { return false; } //Check out extension licenses return CheckOutLicenses(currentProduct); } private bool CheckOutLicenses(esriLicenseProductCode currentProduct) { bool allSuccessful = true; //Request extensions if (m_requestedExtensions != null && currentProduct != 0) { foreach (esriLicenseExtensionCode ext in m_requestedExtensions) { esriLicenseStatus licenseStatus = m_AoInit.IsExtensionCodeAvailable(currentProduct, ext); if (licenseStatus == esriLicenseStatus.esriLicenseAvailable)//skip unavailable extensions { licenseStatus = m_AoInit.CheckOutExtension(ext); } allSuccessful = (allSuccessful && licenseStatus == esriLicenseStatus.esriLicenseCheckedOut); if (m_extensionStatus.ContainsKey(ext)) m_extensionStatus[ext] = licenseStatus; else m_extensionStatus.Add(ext, licenseStatus); } m_requestedExtensions.Clear(); } return allSuccessful; } private string ReportInformation(ILicenseInformation licInfo, esriLicenseProductCode code, esriLicenseStatus status) { string prodName = string.Empty; try { prodName = licInfo.GetLicenseProductName(code); } catch { prodName = code.ToString(); } string statusInfo = string.Empty; switch (status) { case esriLicenseStatus.esriLicenseAlreadyInitialized: case esriLicenseStatus.esriLicenseCheckedOut: statusInfo = string.Format(MessageProductAvailable, prodName); break; default: statusInfo = string.Format(MessageProductNotLicensed, prodName); break; } return statusInfo; } private string ReportInformation(ILicenseInformation licInfo, esriLicenseExtensionCode code, esriLicenseStatus status) { string extensionName = string.Empty; try { extensionName = licInfo.GetLicenseExtensionName(code); } catch { extensionName = code.ToString(); } string statusInfo = string.Empty; switch (status) { case esriLicenseStatus.esriLicenseAlreadyInitialized: case esriLicenseStatus.esriLicenseCheckedOut: statusInfo = string.Format(MessageExtensionAvailable, extensionName); break; case esriLicenseStatus.esriLicenseCheckedIn: break; case esriLicenseStatus.esriLicenseUnavailable: statusInfo = string.Format(MessageExtensionUnavailable, extensionName); break; case esriLicenseStatus.esriLicenseFailure: statusInfo = string.Format(MessageExtensionFailed, extensionName); break; default: statusInfo = string.Format(MessageExtensionNotLicensed, extensionName); break; } return statusInfo; } #endregion } }