Virtru.SDK.ClientConfig Class Reference

Inheritance diagram for Virtru.SDK.ClientConfig:

Public Member Functions
void	Dispose ()
void	setKasUrl (string kasUrl)
string	getKasUrl ()
void	setOIDCUrl (string oidcUrl)
string	getOIDCUrl ()
void	setEasUrl (string easUrl)
string	getEasUrl ()
void	setAcmUrl (string acmUrl)
string	getAcmUrl ()
void	setRcaUrl (string rcaUrl)
string	getRcaUrl ()
void	setEncryptedStorageUrl (string encryptedStorageUrl)
string	getEncryptedStorageUrl ()
void	setSecureReaderUrl (string srUrl)
string	getSecureReaderUrl ()
void	setPlatform (string platform)
string	getPlatform ()
string	getVirtruClient ()
string	getBuildVersion ()

Static Public Member Functions
static ClientConfig	getInstance ()

Protected Member Functions
virtual void	Dispose (bool disposing)

Protected Attributes
bool	swigCMemOwn

Package Functions
	ClientConfig (global::System.IntPtr cPtr, bool cMemoryOwn)

Static Package Functions
static global::System.Runtime.InteropServices.HandleRef	getCPtr (ClientConfig obj)
static global::System.Runtime.InteropServices.HandleRef	swigRelease (ClientConfig obj)

Private Member Functions
	~ClientConfig ()

Private Attributes
global::System.Runtime.InteropServices.HandleRef	swigCPtr

Detailed Description

A virtru client configuration information class(singleton) hold all the endpoint addresses and other information like platform it's being used.

Constructor & Destructor Documentation

Virtru.SDK.ClientConfig.ClientConfig ( global::System.IntPtr  cPtr, bool  cMemoryOwn  )

inlinepackage

Virtru.SDK.ClientConfig.~ClientConfig ( )

inlineprivate

Member Function Documentation

void Virtru.SDK.ClientConfig.Dispose ( )

inline

virtual void Virtru.SDK.ClientConfig.Dispose ( bool  disposing )

inlineprotectedvirtual

string Virtru.SDK.ClientConfig.getAcmUrl ( )

inline

Return the base URL for ACM server communication

Returns

- The current ACM url value

string Virtru.SDK.ClientConfig.getBuildVersion ( )

inline

Return virtru client build version

Returns

The virtru client build version

static global.System.Runtime.InteropServices.HandleRef Virtru.SDK.ClientConfig.getCPtr ( ClientConfig  obj )

inlinestaticpackage

string Virtru.SDK.ClientConfig.getEasUrl ( )

inline

DEPRECATED - EAS is not used in OIDC flows Return the base URL for EAS server communication

Returns

- The current EAS url value

string Virtru.SDK.ClientConfig.getEncryptedStorageUrl ( )

inline

Return the base URL for encrypted storage server communication

Returns

- The current encrypted storage url value

static ClientConfig Virtru.SDK.ClientConfig.getInstance ( )

inlinestatic

Returns the singleton instance of ClientConfig, if the instance is not yet created it will create one.

Returns

- Returns single instance of the ClientConfig.

string Virtru.SDK.ClientConfig.getKasUrl ( )

inline

Return the base URL for KAS communication

Returns

- The current base KAS url value

string Virtru.SDK.ClientConfig.getOIDCUrl ( )

inline

Return the base URL that client will authenticate against

Returns

oidcUrl - The base URL for the OIDC IdP

string Virtru.SDK.ClientConfig.getPlatform ( )

inline

Return the current platform of this SDK.

Returns

platform - The current platform of the SDK

string Virtru.SDK.ClientConfig.getRcaUrl ( )

inline

Return the base URL for RCA server communication

Returns

- The current RCA url value

string Virtru.SDK.ClientConfig.getSecureReaderUrl ( )

inline

Return the secure reader url which will be used in html format TDF

Returns

- The secure reader url value

string Virtru.SDK.ClientConfig.getVirtruClient ( )

inline

Return virtru client value which is passed as HTTP header value while communicating with Virtru servers

Returns

The virtru client value

void Virtru.SDK.ClientConfig.setAcmUrl ( string  acmUrl )

inline

Sets the base URL for ACM server communication

Parameters

acmUrl

- The base URL for ACM

void Virtru.SDK.ClientConfig.setEasUrl ( string  easUrl )

inline

DEPRECATED - EAS is not used in OIDC flows Sets the base URL for EAS server communication

Parameters

easUrl

- The base URL for EAS

void Virtru.SDK.ClientConfig.setEncryptedStorageUrl ( string  encryptedStorageUrl )

inline

Sets the base URL for encrypted storage server communication

Parameters

encryptedStorageUrl

- The base URL for encrypted storage

void Virtru.SDK.ClientConfig.setKasUrl ( string  kasUrl )

inline

Sets the base URL for KAS communication

Parameters

kasUrl

- The base URL for KAS

void Virtru.SDK.ClientConfig.setOIDCUrl ( string  oidcUrl )

inline

Sets the base URL that client will authenticate against

Parameters

oidcUrl

- The base URL for the OIDC IdP

void Virtru.SDK.ClientConfig.setPlatform ( string  platform )

inline

Set the current platform the SDK is being used (ex: cpp, python,...)

Parameters

platform

- The current platform of the SDK

void Virtru.SDK.ClientConfig.setRcaUrl ( string  rcaUrl )

inline

Sets the base URL for RCA server communication

Parameters

rcaUrl

- The base URL for RCA

void Virtru.SDK.ClientConfig.setSecureReaderUrl ( string  srUrl )

inline

Set the secure reader url which will be used in html format TDF. This is the URL that will be used on opening the .html TDF.

Parameters

srUrl

- The secure reader url

static global.System.Runtime.InteropServices.HandleRef Virtru.SDK.ClientConfig.swigRelease ( ClientConfig  obj )

inlinestaticpackage

Member Data Documentation

bool Virtru.SDK.ClientConfig.swigCMemOwn

protected

global.System.Runtime.InteropServices.HandleRef Virtru.SDK.ClientConfig.swigCPtr

private

---

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

• ClientConfig.cs