This page details the functionality of the AGTEK Access Internet Key system. The syntax of these operations is pseudo object oriented, with a some English prose to indicate parameter and return types. This should not be taken as a real programmer's documentation, but rather as a specification indicating how the API should be implemented.

A NOTE about binding: C++ classes will return their values as the final parameter (passed by reference) and the actual return value is an AccessError code. Java classes will return the appropriate return value, with errors being indicated by standard (in this case AGTEK Access) exception structures.

The following objects and listed methods encompass the functionality for the License Server API. The language specific bindings for these methods will be folded into the appropriate language binding document during development (C++/Java).

The Access server API provides basic user functionality for the use and consumption of license keys.

methods

• AnnouncementList getAnnouncements( int id, String product ) - Returns a list of announcements with id values greater than “id” and specified for the product with the specific product code. To see all announcements regardless, use id == -1 and product == “”.
• LicenseKeyList getLicenses( String product ) - Returns a list of licenses for a specified product. (probably need to make this a product list)
• void checkoutLicense( LicenseKey l ) - Causes the specified license to be checked out.
• void checkinLicense( LicenseKey l ) - Causes the specified license to be returned to the server pool.
• void renewLicense( LicenseKey l ) - Causes the specified license to be renewed for the standard checkout time. Renew may happen at any time the client has the license checked out.
• void submitLicenseComment( String comment ) - Submits a string to the license event log for informational purposes. Will not affect any billable and resource reporting license operations.

The AdminAPI provides the capability to administer basic license features (as well as a couple of other feature);

• Users associated with a key; add, remove, change
• Create/Delete/Change new users for the customer

methods

• 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.
• 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 updateLicenseMaxCheckout( LicenseKey l, long newDuration ) – Modifies the license duration.

The SupportAPI supports the capability to administer revenue based features in the Access system. This API is to be used only at AGTEK.

• Create/Delete keys per customer
• Associate feature codes per key
• Activate License or Access server functionality per customer
• Run reporting functions

methods

• LicenseKey createLicense( licenseType, customerId, maxUsers, maxCheckoutPeriod, expireTime, products, timedProducts, timedExpire() ) - Create a new key for the user.
• void deleteLicense( 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 unlockLicense( LicenseKey l ) - Removes the checkout of the License Key.
• void updateUser( StorageUser u ) - Modified to handle Role.
• void updateCustomer( StorageCustomer c ) - Updated to handle maxUsers, hasAccess and hasLicense flags.

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

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

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.