The contract used by client applications to procure a key to unlock a licensed feature. More...

Inheritance diagram for Apac.Licensing.IKeyManager:

Public Member Functions
AcquisitionResponse	AcquireLicenseLock (AcquisitionRequest request)
	The method used to aquire a key to unlock a licensed feature. More...

ReleaseResponse	ReleaseLicenseLock (string acquisitionId)
	The method used to release a key previously used to unlock a licensed feature using a count of one (1). More...

ReleaseResponse	ReleaseLicenseLock (string contextId, string[] nodeIds, LicensedFeatures feature, int numToRelease)
	The method used to release a key previously used to unlock a licensed feature. More...

ReleaseResponse	ReleaseLicenseLock (string contextId, string[] nodeIds, LicensedFeatures feature, int numToRelease, int nulLeasesHeld)
	The method used to release a key previously used to unlock a licensed feature. More...

bool	RenewLicenseLocks (string acquisitionId)
	The method used to renew feature locks checked out before they expire. More...

bool	RenewLicenseLock (string featureResponseId)
	The method used to renew a feature lock checked out before it expires. More...

Key	Find (KeySearchHandler match)
	A search routine for finding a specific key. More...

Key[]	FindAll (KeySearchHandler match)
	A search routine for finding specific keys. More...

void	ReloadKeys ()
	Management method for forcing a reload of license keys from disk. More...

void	Close ()
	Signals the key manager to stop taking requests and persist its state. More...

int	GetNumLeases (string contextId, string[] nodeIds, LicensedFeatures feature)
	Gets the number of leases available to the caller given the context and node and feature. More...

AuditResult	SyncNonVolatileCount (string contextId, string[] nodeIds, LicensedFeatures feature, int numLeasesHeld)
	Allows a client application to report its nonvolatile lease counts for a given feature and have the license manager sync up with it. More...

Properties
LockRecord[]	Locks `[get]`
	Property used for displaying the current lease records. More...

Key[]	Keys `[get]`
	Property used for displaying the currently loaded license keys, which determine which features are available in which contexts. More...

Detailed Description

The contract used by client applications to procure a key to unlock a licensed feature.

Member Function Documentation

◆ AcquireLicenseLock()

AcquisitionResponse Apac.Licensing.IKeyManager.AcquireLicenseLock ( AcquisitionRequest request )

The method used to aquire a key to unlock a licensed feature.

Parameters

request The object containing the elements describing the request.

Returns: Returns an AquisitionResponse that indicates the result of the aquisition request.

Implemented in Apac.Licensing.KeyManager.

◆ Close()

void Apac.Licensing.IKeyManager.Close ( )

Signals the key manager to stop taking requests and persist its state.

Implemented in Apac.Licensing.KeyManager.

◆ Find()

Key Apac.Licensing.IKeyManager.Find ( KeySearchHandler match )

A search routine for finding a specific key.

Parameters

match The delegate used to perform the matching.

Returns: Returns the first Key that matches.

Implemented in Apac.Licensing.KeyManager.

◆ FindAll()

Key [] Apac.Licensing.IKeyManager.FindAll ( KeySearchHandler match )

A search routine for finding specific keys.

Parameters

match The delegate used to perform the matching.

Returns: Returns an array of Keys that matched.

Implemented in Apac.Licensing.KeyManager.

◆ GetNumLeases()

int Apac.Licensing.IKeyManager.GetNumLeases	(	string	contextId,
		string[]	nodeIds,
		LicensedFeatures	feature
	)

Gets the number of leases available to the caller given the context and node and feature.

Parameters

contextId	The context id.
nodeIds	The node ids.
feature	The feature.

Returns: Returns the number of leases available for the feature.

Implemented in Apac.Licensing.KeyManager.

◆ ReleaseLicenseLock() [1/3]

ReleaseResponse Apac.Licensing.IKeyManager.ReleaseLicenseLock ( string acquisitionId )

The method used to release a key previously used to unlock a licensed feature using a count of one (1).

Parameters

acquisitionId The id of the acquisition response received when the locks were obtained.

Returns: Returns a ReleaseResponse that indicates the result of the release request.

Implemented in Apac.Licensing.KeyManager.

◆ ReleaseLicenseLock() [2/3]

ReleaseResponse Apac.Licensing.IKeyManager.ReleaseLicenseLock	(	string	contextId,
		string[]	nodeIds,
		LicensedFeatures	feature,
		int	numToRelease
	)

The method used to release a key previously used to unlock a licensed feature.

Parameters

contextId	The context id.
nodeIds	The node ids.
feature	The feature.
numToRelease	The number of locks to release.

Returns: Returns a ReleaseResponse that indicates the result of the release request.

Implemented in Apac.Licensing.KeyManager.

◆ ReleaseLicenseLock() [3/3]

ReleaseResponse Apac.Licensing.IKeyManager.ReleaseLicenseLock	(	string	contextId,
		string[]	nodeIds,
		LicensedFeatures	feature,
		int	numToRelease,
		int	nulLeasesHeld
	)

The method used to release a key previously used to unlock a licensed feature.

Parameters

contextId	The context id.
nodeIds	The node ids.
feature	The feature.
numToRelease	The number of locks to release.
nulLeasesHeld	The number of (non-volatile) locks held by the client. This is ignored for volatile locks.

Returns: Returns a ReleaseResponse that indicates the result of the release request.

Implemented in Apac.Licensing.KeyManager.

◆ ReloadKeys()

void Apac.Licensing.IKeyManager.ReloadKeys ( )

Management method for forcing a reload of license keys from disk.

Implemented in Apac.Licensing.KeyManager.

◆ RenewLicenseLock()

bool Apac.Licensing.IKeyManager.RenewLicenseLock ( string featureResponseId )

The method used to renew a feature lock checked out before it expires.

Parameters

acquisitionId The id of the acquisition response received when the locks were obtained.

Returns: Returns true if successful, false if the renewal failed. In the negative case, the application should attempt to re-acquire the locks.

Implemented in Apac.Licensing.KeyManager.

◆ RenewLicenseLocks()

bool Apac.Licensing.IKeyManager.RenewLicenseLocks ( string acquisitionId )

The method used to renew feature locks checked out before they expire.

Parameters

acquisitionId The id of the acquisition response received when the locks were obtained.

Returns: Returns true if successful, false if the renewal failed. In the negative case, the application should attempt to re-acquire the locks.

Implemented in Apac.Licensing.KeyManager.

◆ SyncNonVolatileCount()

AuditResult Apac.Licensing.IKeyManager.SyncNonVolatileCount	(	string	contextId,
		string[]	nodeIds,
		LicensedFeatures	feature,
		int	numLeasesHeld
	)

Allows a client application to report its nonvolatile lease counts for a given feature and have the license manager sync up with it.

Parameters

contextId	The context id.
nodeIds	The node ids.
feature	The feature.
numLeasesHeld	The number of leases held by the client.

Returns: Returns a AuditResult containing details about any alterations made by the sync operation.

Implemented in Apac.Licensing.KeyManager.

Property Documentation

◆ Keys

Key [] Apac.Licensing.IKeyManager.Keys

get

Property used for displaying the currently loaded license keys, which determine which features are available in which contexts.

◆ Locks

LockRecord [] Apac.Licensing.IKeyManager.Locks

get

Property used for displaying the current lease records.

The documentation for this interface was generated from the following file:

/var/lib/jenkins/workspace/apac/APAC/ApacLicensing/Apac.Licensing/IKeyManager.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ AcquireLicenseLock()

◆ Close()

◆ Find()

◆ FindAll()

◆ GetNumLeases()

◆ ReleaseLicenseLock() [1/3]

◆ ReleaseLicenseLock() [2/3]

◆ ReleaseLicenseLock() [3/3]

◆ ReloadKeys()

◆ RenewLicenseLock()

◆ RenewLicenseLocks()

◆ SyncNonVolatileCount()

Property Documentation

◆ Keys

◆ Locks