|
ILicensing
|
A Carbon licensing provider must implement this interface. How much they implement depends upon the needs
of environment and applications using the provider. The authentication methods are almost certainly going
to be needed, but other licence management methods are optional.
Namespace: RCS.Carbon.Licensing.Shared
Assembly: RCS.Carbon.Licensing.Shared (in RCS.Carbon.Licensing.Shared.dll) Version: 9.1.22
SyntaxC#
public interface ILicensingProvider
The ILicensingProvider type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ConfigSummary | Gets a summary of the configuration values used by the provider implementation. The value is only intended for information display or to assist debugging. |
| Description | Gets a longer description of the licensing provider implementation. |
| Name | Gets a short display name of the provider implementation. |
| SupportsRealms | Returns a flag indicating if this licensing provider supports the concept of Realms. Clients can use this flag to adjust their UIs accordingly if necessary. |
Methods| Name | Description | |
|---|---|---|
 | AuthenticateId | Authenticates a licensing account user Id and password. |
| AuthenticateName | Authenticates a licensing account user name and password. |
| ConnectRealmChildCustomers | Connects a Realm to Customers to create relationships. |
| DeleteRealm | Deletes a Realm and any relationships it has with other licensing entities (a 'deep' delete). |
| DisconnectRealmChildCustomer | Disconnects the relationship between a Realm and a Customer. |
| GetDatabaseReport | Gets a set of summary items representing problems or inconsistencies in the licensing database entities. |
| GetFreeLicence | Authenticates using the 'free' account which is also known as a 'guest' account. This account can be used for evaluation or demonstrations without the need to register a custom account. The account only has access to demonstration customers and jobs and its performance is throttled. |
| GetNavigationData | Gets abbreviated arrays of all Realms, Users, Customers and Jobs in the licensing database. Clients can 'join' the arrays to create custom navigation views such as a tree showing the relationships between the entities and allowing simple selection. |
| ListRealms | Returns a set of all full Realm entities in the licensing database. The Realms are not 'deep' loaded and the relationship properties will be null. |
| ListTSAPIVisibleJobs | Returns a list of jobs (surveys) that can be exported in TSAPI format. |
| ReadRealm | Reads a Realm entity by primary key Id. The Realm is 'deep' loaded so that relationship properties are filled with the related entities. |
| ReadRealmsByName | Returns a set of Realm entities matching a Name. The Realms are 'deep' loaded so that relationship properties are filled with the related entities. |
| ReplaceRealmChildCustomers | Replaces all of a Realm's connections (relationships) to customers. |
| UpdateRealm | Updates or inserts a Realm. |
| ValidateRealm | Validates a Realm. |
Events| Name | Description | |
|---|---|---|
 | ProviderLog | Hosting applications can listen to this handler for logging string events from the licensing provider. It is up to the provider author to optionally implement meaningful logging. It is recommended that the event strings be in the simple efficient format X Message where X is D=Debug I=information W=Warning and E=Error. |
See Also