Apac.Licensing.LicensingClient Class Reference

Provides an embeddable proxy object to use in applications that want to leverage licensing. More...

Inheritance diagram for Apac.Licensing.LicensingClient:

Public Member Functions
	LicensingClient (string managerUrl)
AcquisitionResponse	RequestLock (string contextId, LicensedFeatures feature)
	Requests a lock for the specified feature by self-determining the node identifier (encapsulating node identification). More...
AcquisitionResponse	RequestLock (string contextId, string[] nodeIds, LicensedFeatures feature)
	A convenience method for requesting one lock for one feature. More...
AcquisitionResponse	RequestLocks (AcquisitionRequest request)
	Requests locks for the features specified in request . More...
void	ReleaseAllVolatileLocks ()
	Releases all volatile locks. More...
ReleaseResponse	ReleaseLock (string acquisitionId)
	Releases the lock. More...
void	ReleaseNonvolatileLocks (string contextId, string[] nodeIds, LicensedFeatures feature, int count)
	Releases the nonvolatile locks. More...
void	ReleaseNonvolatileLock (string contextId, string[] nodeIds, LicensedFeatures feature, int numLeasesHeld)
	Releases a single nonvolatile lock while auditing against the number of leases held. More...
int	RequestLockCount (string contextId, string[] nodeIds, LicensedFeatures feature)
	Requests the lock count for a given feature. More...
void	Dispose ()

Static Public Member Functions
static LicensingClient	CreateLicensingClient ()

Static Public Attributes
static readonly string	KeyManagerUrlSetting = "apac.licensing.url"

Protected Member Functions
void	Dispose (bool disposing)

Properties
IKeyManager	KeyManager [get]
	Gets the key manager. More...

Detailed Description

Provides an embeddable proxy object to use in applications that want to leverage licensing.

Member Function Documentation

ReleaseAllVolatileLocks()

void Apac.Licensing.LicensingClient.ReleaseAllVolatileLocks ( )

inline

Releases all volatile locks.

ReleaseLock()

ReleaseResponse Apac.Licensing.LicensingClient.ReleaseLock ( string  acquisitionId )

inline

Releases the lock.

Parameters

acquisitionId

The acquisition id used to obtain the lock.

Returns

Returns a ReleaseResponse indicating the status of the operation.

ReleaseNonvolatileLock()

void Apac.Licensing.LicensingClient.ReleaseNonvolatileLock ( string  contextId, string[]  nodeIds, LicensedFeatures  feature, int  numLeasesHeld  )

inline

Releases a single nonvolatile lock while auditing against the number of leases held.

Parameters

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

ReleaseNonvolatileLocks()

void Apac.Licensing.LicensingClient.ReleaseNonvolatileLocks ( string  contextId, string[]  nodeIds, LicensedFeatures  feature, int  count  )

inline

Releases the nonvolatile locks.

Parameters

contextId	The context id.
nodeId	The node id.
feature	The feature.
count	The count.

RequestLock() [1/2]

AcquisitionResponse Apac.Licensing.LicensingClient.RequestLock ( string  contextId, LicensedFeatures  feature  )

inline

Requests a lock for the specified feature by self-determining the node identifier (encapsulating node identification).

Parameters

contextId	The context identifier to use in the request.
feature	The feature to use in the request.

Returns

Returns the AcquisitionResponse that indicates the results of the request.

RequestLock() [2/2]

AcquisitionResponse Apac.Licensing.LicensingClient.RequestLock ( string  contextId, string[]  nodeIds, LicensedFeatures  feature  )

inline

A convenience method for requesting one lock for one feature.

Parameters

contextId	The context for the lock.
nodeIds	The node ids for the lock.
feature	The feature to be unlocked.

Returns

Returns the AcquistionResponse with the results so the caller can enable/disable features accordingly.

RequestLockCount()

int Apac.Licensing.LicensingClient.RequestLockCount ( string  contextId, string[]  nodeIds, LicensedFeatures  feature  )

inline

Requests the lock count for a given feature.

Parameters

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

Returns

Returns the number of locks available for the feature from all applicable keys.

RequestLocks()

AcquisitionResponse Apac.Licensing.LicensingClient.RequestLocks ( AcquisitionRequest  request )

inline

Requests locks for the features specified in request .

Parameters

request

The request.

Returns

Returns the AcquistionResponse with the results so the caller can enable/disable features accordingly.

Property Documentation

KeyManager

IKeyManager Apac.Licensing.LicensingClient.KeyManager

get

Gets the key manager.

The key manager.

---

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

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