Class ReveneraLicenseProvider

ReveneraLicenseProvider

Inheritance

System.Object

ReveneraLicenseProvider

Implements

ILicenseProvider

System.IDisposable

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Sartorius.SAF.Licensing.Revenera

Assembly: Sartorius.SAF.Licensing.Revenera.dll

Syntax

public class ReveneraLicenseProvider : ILicenseProvider, IDisposable

Constructors

ReveneraLicenseProvider()

Default ReveneraLicenseProvider ctor

Declaration

public ReveneraLicenseProvider()

ReveneraLicenseProvider(String)

Default ReveneraLicenseProvider ctor

Declaration

public ReveneraLicenseProvider(string workingStoragePath)

Parameters

Type	Name	Description
System.String	workingStoragePath

Properties

AvailableVersions

Gets a list of available implementation versions.

Declaration

public static string[] AvailableVersions { get; }

Property Value

Type	Description
System.String[]

CustomerHostId

Get customer host id

Declaration

public string CustomerHostId { get; set; }

Property Value

Type	Description
System.String

HardwareId

Unique hardware id

Declaration

public virtual string HardwareId { get; }

Property Value

Type	Description
System.String

VersionToBeUse

Indicates witch implementation version schould be used.

Declaration

public static string VersionToBeUse { get; set; }

Property Value

Type	Description
System.String

WorkingStoragePath

Path to store the licenses.

Declaration

public string WorkingStoragePath { get; }

Property Value

Type	Description
System.String

Methods

ActivateLicenseId(String, String)

Defines methods for license checks.

Declaration

public ActivationInfo ActivateLicenseId(string licenseServerUrl, string activationId)

Parameters

Type	Name	Description
System.String	licenseServerUrl	A back office Url.
System.String	activationId	A license activation key.

Returns

Type	Description
ActivationInfo

Exceptions

Type	Condition
ActivationKeyException	The license could not be activate.

See Also

System.IDisposable

CheckInFeature(String, String)

Defines methods for license checks.

Declaration

public int CheckInFeature(string featureName, string version)

Parameters

Type	Name	Description
System.String	featureName	The identifier of the feature to check in.
System.String	version	The version of the feature to check in.

Returns

Type	Description
System.Int32	A count of returned licenses.

Exceptions

Type	Condition
FeatureNotFoundException	The feature with the specified id does not exist.

See Also

System.IDisposable

CheckInFeature(String, String, Int32)

Defines methods for license checks.

Declaration

public int CheckInFeature(string featureName, string version, int count)

Parameters

Type	Name	Description
System.String	featureName	The identifier of the feature to check in.
System.String	version	The version of the feature to check in.
System.Int32	count	The count of licenses to check out for the specified feature.

Returns

Type	Description
System.Int32	A count of returned licenses.

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	count is not greater as 0.
FeatureNotFoundException	The feature with the specified id does not exist.

See Also

System.IDisposable

CheckOutFeature(String, String)

Defines methods for license checks.

Declaration

public CheckoutInfo CheckOutFeature(string featureName, string version)

Parameters

Type	Name	Description
System.String	featureName	The identifier of the feature to check in.
System.String	version	The version of the feature to check in.

Returns

Type	Description
CheckoutInfo	A info of check out operation.

Exceptions

Type	Condition
System.ArgumentNullException	featureName is null.
FeatureNotFoundException	The feature with the specified id does not exist.

See Also

System.IDisposable

CheckOutFeature(String, String, Int32)

Defines methods for license checks.

Declaration

public CheckoutInfo CheckOutFeature(string featureName, string version, int count)

Parameters

Type	Name	Description
System.String	featureName	The identifier of the feature to check in.
System.String	version	The version of the feature to check in.
System.Int32	count	The count of licenses to check in for the specified feature.

Returns

Type	Description
CheckoutInfo	A info of check out operation.

Exceptions

Type	Condition
System.ArgumentNullException	featureName is null.
System.ArgumentOutOfRangeException	count is not greater as 0.
FeatureNotFoundException	The feature with the specified id does not exist.

See Also

System.IDisposable

DeactivateLicenseId(String, String)

Defines methods for license checks.

Declaration

public void DeactivateLicenseId(string licenseServerUrl, string activationId)

Parameters

Type	Name	Description
System.String	licenseServerUrl
System.String	activationId

Exceptions

Type	Condition
ActivationKeyException	The license could not be activate.

See Also

System.IDisposable

Dispose()

Declaration

public void Dispose()

Dispose(Boolean)

The bulk of the clean-up code is implemented in Dispose(bool)

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	Indicated disposing.

ExportOfflineActivationFile(String, String)

Defines methods for license checks.

Declaration

public string ExportOfflineActivationFile(string activationId, string outputPath)

Parameters

Type	Name	Description
System.String	activationId	A license activation key.
System.String	outputPath

Returns

Type	Description
System.String	A file name.

Exceptions

Type	Condition
OfflineActivationException	The license file could not be accessed.

See Also

System.IDisposable

ExportOfflineActivationFile(String, String, Int32)

Defines methods for license checks.

Declaration

public string ExportOfflineActivationFile(string activationId, string outputPath, int count)

Parameters

Type	Name	Description
System.String	activationId	A license activation key.
System.String	outputPath
System.Int32	count	The count of licenses to check in for the specified feature.

Returns

Type	Description
System.String	A file name.

Exceptions

Type	Condition
OfflineActivationException	The license file could not be accessed.

See Also

System.IDisposable

GetDefaultWorkingStoragePath()

Gets a directory path to working storage.

Declaration

public static string GetDefaultWorkingStoragePath()

Returns

Type	Description
System.String	A directory path to working storage.

GetFeatureInfo(String, String)

Defines methods for license checks.

Declaration

public FeatureInfo GetFeatureInfo(string featureName, string version)

Parameters

Type	Name	Description
System.String	featureName	A feature name.
System.String	version	A feature version. Can be null

Returns

Type	Description
FeatureInfo	A instance of FeatureInfofeature info

Exceptions

Type	Condition
System.ArgumentNullException	Throw if parameter featureName is null or empty.

See Also

System.IDisposable

GetFeaturesInfo(Boolean)

Defines methods for license checks.

Declaration

public IEnumerable<FeatureInfo> GetFeaturesInfo(bool diagnostic = false)

Parameters

Type	Name	Description
System.Boolean	diagnostic	If true, get all license info, even if the license has expired

Returns

Type	Description
System.Collections.Generic.IEnumerable<FeatureInfo>	A list of FeatureInfo

Exceptions

Type	Condition
FeatureException	The feature info does not exist.

See Also

System.IDisposable

ImportOfflineActivationResponseFile(String)

Defines methods for license checks.

Declaration

public ActivationInfo ImportOfflineActivationResponseFile(string responseFile)

Parameters

Type	Name	Description
System.String	responseFile	A absolute file name to license file.

Returns

Type	Description
ActivationInfo

Exceptions

Type	Condition
OfflineActivationException	The license file could not be accessed.

See Also

System.IDisposable

Implements

ILicenseProvider

System.IDisposable

Extension Methods

CollectionExtensions.AddRange<T, TCollection>(TCollection, IEnumerable<T>)

SerializableObjectCloneExtension.Clone<T>(T)