User Tools

Site Tools


access:internet_key_api_development

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
access:internet_key_api_development [2011/02/01 22:19]
mjallison
access:internet_key_api_development [2012/10/10 16:20] (current)
Line 27: Line 27:
 __**methods**__ __**methods**__
   * **UserList listUsers( LicenseKey l )** - Lists users currently assigned to the key   * **UserList listUsers( LicenseKey l )** - Lists users currently assigned to the key
 +  * **StorageUser addUser(String id, int customer, int type, boolean isAdmin, boolean isSupport, String password)** - Moved method from CustomerAdmin API.
   * **StorageUser addUser( String id, int type, boolean isAdmin, String password )** - Restricted form to support only customer admins, AGTEK Support to use the method in Agtek SupportAPI.   * **StorageUser addUser( String id, int type, boolean isAdmin, String password )** - Restricted form to support only customer admins, AGTEK Support to use the method in Agtek SupportAPI.
   * **void addUser( LicenseKey l, StorageUser u )** - Adds a user to the specific key.   * **void addUser( LicenseKey l, StorageUser u )** - Adds a user to the specific key.
   * **void removeUser( LicenseKey l, StorageUser u )** -- Removes a user from the specified key.    * **void removeUser( LicenseKey l, StorageUser u )** -- Removes a user from the specified key. 
 +  * **void updateLicenseMaxCheckout( LicenseKey l, long newDuration )** -- Modifies the license duration.
  
 ===== SupportAPI (AGTEK Employees only) ===== ===== SupportAPI (AGTEK Employees only) =====
Line 39: Line 41:
  
 __**methods**__ __**methods**__
-  * **StorageUser addUser(String idint customerint typeboolean isAdminboolean isSupportString password)** - Moved method from CustomerAdmin API. +  * **LicenseKey createLicenselicenseTypecustomerIdmaxUsersmaxCheckoutPeriodexpireTimeproducts, timedProducts,​ timedExpire()** - Create a new key for the user. 
-  * **LicenseKey createKeyCustomer c, LicenseType t )** - Create a new key for the user. +  * **void ​deleteLicense( LicenseKey l )** - Delete a key, and all of it's user assignments. 
-  * **void ​deleteKey( LicenseKey l )** - Delete a key, and all of it's user assignments. +  * **void ​updateLicense( LicenseKey l )** - Updates the contents of the key in the database (same id) with changes
-  * **void ​updateKey( LicenseKey l )** - Updates the contents of the key in the database (same id) with changes.+  * **void unlockLicense( LicenseKey l )** - Removes the checkout of the License Key.
   * **void updateUser( StorageUser u )** - Modified to handle Role.    * **void updateUser( StorageUser u )** - Modified to handle Role. 
-  * **void ​updateCusteomer( StorageCustomer c )** - Updated to handle //​hasAccess//​ and //​hasLicense//​ flags.+  * **void ​updateCustomer( StorageCustomer c )** - Updated to handle ​//​maxUsers//, ​//​hasAccess//​ and //​hasLicense//​ flags. 
 + 
 +===== Storage User ===== 
 +The StorageUser object represents a userinstance in the AGTEK Access authentication system. Users are used to scope operations (role based authorization) and to associate with software license keys. StorageUser objects are documented (JavaDoc style) here: http://​dev.agtek.com/​AccessJavaDocs/​index.html 
 + 
 +===== License Key ===== 
 +The LicenseKey object represents an instance of a license key in the AGTEK Access System. LicenseKey objects contain the key identifier, the key parameters, and associated users. While the LicenseKey may represent all this information as being aggregated, it may not be implemented that way in the Access database.  
 + 
 +int(32) LicenseKey.getId() 
 +int(16) LicenseKey.getCustomerId() 
 +int
  
 ====== Mapping from Solo ====== ====== Mapping from Solo ======
-This table provides the equivalent calls between the Solo system and the new system. Calls are based at the ASP level of functionality. It is envisioned that a new C++ wrapper would be written for the AGTEK desktop apps to plug into the security model.+This table provides the equivalent calls between the Solo system and the new system. Calls are based at the ASP level of functionality. It is envisioned that a new C++ wrapper would be written for the AGTEK desktop apps to plug into the security model. It is expected that a new class (equivalent to SoftwareKey/​Network key would need to be written to be able to plug into the existing frameworks.
  
 |  **ASP Function** ​        ​|**New Function** ​       |**Description**| |  **ASP Function** ​        ​|**New Function** ​       |**Description**|
Line 63: Line 75:
 |GetUpdatesAG.asp ​          |? not used in CNetworkKey|Called in SoftwareKey::​FindPage | |GetUpdatesAG.asp ​          |? not used in CNetworkKey|Called in SoftwareKey::​FindPage |
 |ModFloatingUser.asp ​       |admin.updateUser(u) ​     |Modify/​update user record| |ModFloatingUser.asp ​       |admin.updateUser(u) ​     |Modify/​update user record|
-|ModNetKeyDaysAway.asp ​     |admin.updateLicesenDuration(l, long)|Set the duration on a license.+|ModNetKeyDaysAway.asp ​     |admin.updateLicenseDuration(l, long)|Set the duration on a license.
 |NoNetworkKeys.asp ​         |access.submitLicenseComment(str)|Add comment to license audit log.| |NoNetworkKeys.asp ​         |access.submitLicenseComment(str)|Add comment to license audit log.|
 |ReleaseLicense.asp ​        ​|access.checkinLicense(l)|Release/​Checkin the lock on the license| |ReleaseLicense.asp ​        ​|access.checkinLicense(l)|Release/​Checkin the lock on the license|
 |SetFloatingUser.asp ​       |admin.addUser(l,​u) ​     |Adds user to a license key.| |SetFloatingUser.asp ​       |admin.addUser(l,​u) ​     |Adds user to a license key.|
access/internet_key_api_development.1296598763.txt.gz · Last modified: 2012/10/10 16:20 (external edit)