Settings used by FileProfile during its creation and throughout its lifetime. More...

#include <file_profile.h>

Public Member Functions
	Settings (const std::shared_ptr< MipContext > &mipContext, CacheStorageType cacheStorageType, std::shared_ptr< ConsentDelegate > consentDelegate, std::shared_ptr< Observer > observer)
	FileProfile::Settings constructor.

CacheStorageType	GetCacheStorageType () const
	Get whether caches are stored in memory or on disk.

std::shared_ptr< ConsentDelegate >	GetConsentDelegate () const
	Gets the consent delegate used to request user consent connecting to services.

std::shared_ptr< Observer >	GetObserver () const
	Gets the observer that receives notifications of events related to FileProfile.

std::shared_ptr< MipContext >	GetMipContext () const
	Get MIP context which represents shared state across all profiles.

std::shared_ptr< HttpDelegate >	GetHttpDelegate () const
	Get the HTTP delegate (if any) provided by the application.

void	SetHttpDelegate (const std::shared_ptr< HttpDelegate > &httpDelegate)
	Override default HTTP stack with client's own.

std::shared_ptr< TaskDispatcherDelegate >	GetTaskDispatcherDelegate () const
	Get the TaskDispatcher delegate (if any) provided by the application.

void	SetTaskDispatcherDelegate (const std::shared_ptr< TaskDispatcherDelegate > &taskDispatcherDelegate)
	Override default asynchonous task dispatching handling with client's own.

void	SetSessionId (const std::string &sessionId)
	Sets the session ID.

const std::string &	GetSessionId () const
	Gets the session ID.

void	SetCanCacheLicenses (bool canCacheLicenses)
	Configures whether or not end user licenses (EULs) will be cached locally.

bool	CanCacheLicenses () const
	Gets whether or not end user licenses (EULs) are cached locally.

const std::shared_ptr< void > &	GetLoggerContext () const
	Get logger context that will be opaquely passed to the logger delegate for logs associated with the created profile.

void	SetLoggerContext (const std::shared_ptr< void > &loggerContext)
	Sets the logger context that will be opaquely passed to the logger delegate for logs associated with the created profile.

DnsRedirection	GetDnsRedirection () const
	Gets the dns redirect mode.

void	SetDnsRedirection (DnsRedirection dnsRedirection)
	Sets the dns redirection mode that controls how redirection is handled during online operations.

Private Attributes
std::shared_ptr< MipContext >	mMipContext

std::string	mPath

CacheStorageType	mCacheStorageType

std::shared_ptr< ConsentDelegate >	mConsentDelegate

std::shared_ptr< Observer >	mObserver

std::string	mSessionId

std::shared_ptr< HttpDelegate >	mHttpDelegate

std::shared_ptr< TaskDispatcherDelegate >	mTaskDispatcherDelegate

bool	mCanCacheLicenses

std::shared_ptr< void >	mLoggerContext

DnsRedirection	mDnsRedirection

Detailed Description

Settings used by FileProfile during its creation and throughout its lifetime.

Constructor & Destructor Documentation

◆ Settings()

FileProfile::Settings::Settings	(	const std::shared_ptr< MipContext > &	mipContext,
		CacheStorageType	cacheStorageType,
		std::shared_ptr< ConsentDelegate >	consentDelegate,
		std::shared_ptr< Observer >	observer )

inline

FileProfile::Settings constructor.

Parameters

mipContext	Global context settings
cacheStorageType	Store any cached state in memory or on disk
consentDelegate	Delegate used to obtain user permission to access external resources
observer	Observer instance that will receive notifications of events related to FileProfile

Member Function Documentation

◆ CanCacheLicenses()

bool FileProfile::Settings::CanCacheLicenses ( ) const

inline

Gets whether or not end user licenses (EULs) are cached locally.

Returns: License caching configuration

◆ GetCacheStorageType()

CacheStorageType FileProfile::Settings::GetCacheStorageType ( ) const

inline

Get whether caches are stored in memory or on disk.

Returns: storage type used

◆ GetConsentDelegate()

std::shared_ptr< ConsentDelegate > FileProfile::Settings::GetConsentDelegate ( ) const

inline

Gets the consent delegate used to request user consent connecting to services.

Returns: Consent delegate used for requesting user consent

◆ GetDnsRedirection()

DnsRedirection FileProfile::Settings::GetDnsRedirection ( ) const

inline

Gets the dns redirect mode.

Returns: The redirect mode used

◆ GetHttpDelegate()

std::shared_ptr< HttpDelegate > FileProfile::Settings::GetHttpDelegate ( ) const

inline

Get the HTTP delegate (if any) provided by the application.

Returns: HTTP delegate to be used for HTTP operations

◆ GetLoggerContext()

const std::shared_ptr< void > & FileProfile::Settings::GetLoggerContext ( ) const

inline

Get logger context that will be opaquely passed to the logger delegate for logs associated with the created profile.

Returns: The logger context

◆ GetMipContext()

std::shared_ptr< MipContext > FileProfile::Settings::GetMipContext ( ) const

inline

Get MIP context which represents shared state across all profiles.

Returns: MIP context

◆ GetObserver()

std::shared_ptr< Observer > FileProfile::Settings::GetObserver ( ) const

inline

Gets the observer that receives notifications of events related to FileProfile.

Returns: Observer that receives notifications of events related to FileProfile

◆ GetSessionId()

const std::string & FileProfile::Settings::GetSessionId ( ) const

inline

Gets the session ID.

Returns: Session ID that will be used to correlate logs/telemetry

◆ GetTaskDispatcherDelegate()

std::shared_ptr< TaskDispatcherDelegate > FileProfile::Settings::GetTaskDispatcherDelegate ( ) const

inline

Get the TaskDispatcher delegate (if any) provided by the application.

Returns: TaskDispatcher delegate to be used for executing asynchronous tasks

◆ SetCanCacheLicenses()

void FileProfile::Settings::SetCanCacheLicenses ( bool canCacheLicenses )

inline

Configures whether or not end user licenses (EULs) will be cached locally.

Parameters

canCacheLicenses Whether or not engine should cache a license when opening protected content

Note: If true, opening protected content will cache the associated license locally. If false, opening protected content will always perform HTTP operation to acquire the license from the RMS service.

◆ SetDnsRedirection()

void FileProfile::Settings::SetDnsRedirection ( DnsRedirection dnsRedirection )

inline

Sets the dns redirection mode that controls how redirection is handled during online operations.

Parameters

dnsRedirection The redirection mode to use

◆ SetHttpDelegate()

void FileProfile::Settings::SetHttpDelegate ( const std::shared_ptr< HttpDelegate > & httpDelegate )

inline

Override default HTTP stack with client's own.

Parameters

httpDelegate HTTP callback interface implemented by client application

◆ SetLoggerContext()

void FileProfile::Settings::SetLoggerContext ( const std::shared_ptr< void > & loggerContext )

inline

Sets the logger context that will be opaquely passed to the logger delegate for logs associated with the created profile.

Parameters

loggerContext The logger context

◆ SetSessionId()

void FileProfile::Settings::SetSessionId ( const std::string & sessionId )

inline

Sets the session ID.

Parameters

sessionId Session ID that will be used to correlate logs/telemetry

◆ SetTaskDispatcherDelegate()

void FileProfile::Settings::SetTaskDispatcherDelegate ( const std::shared_ptr< TaskDispatcherDelegate > & taskDispatcherDelegate )

inline

Override default asynchonous task dispatching handling with client's own.

Parameters

taskDispatcherDelegate Task dispatching callback interface implemented by client application

Note: tasks can reference profile objects preventing its destruction as a result taskdispatcher queues should not be shared.

Member Data Documentation

◆ mCacheStorageType

CacheStorageType FileProfile::Settings::mCacheStorageType

private

◆ mCanCacheLicenses

bool FileProfile::Settings::mCanCacheLicenses

private

◆ mConsentDelegate

std::shared_ptr<ConsentDelegate> FileProfile::Settings::mConsentDelegate

private

◆ mDnsRedirection

DnsRedirection FileProfile::Settings::mDnsRedirection

private

◆ mHttpDelegate

std::shared_ptr<HttpDelegate> FileProfile::Settings::mHttpDelegate

private

◆ mLoggerContext

std::shared_ptr<void> FileProfile::Settings::mLoggerContext

private

◆ mMipContext

std::shared_ptr<MipContext> FileProfile::Settings::mMipContext

private

◆ mObserver

std::shared_ptr<Observer> FileProfile::Settings::mObserver

private

◆ mPath

std::string FileProfile::Settings::mPath

private

◆ mSessionId

std::string FileProfile::Settings::mSessionId

private

◆ mTaskDispatcherDelegate

std::shared_ptr<TaskDispatcherDelegate> FileProfile::Settings::mTaskDispatcherDelegate

private

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

/home/mbaldwin/docs/mip-sdk-for-cpp/src/api/mip/file/file_profile.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Settings()

Member Function Documentation

◆ CanCacheLicenses()

◆ GetCacheStorageType()

◆ GetConsentDelegate()

◆ GetDnsRedirection()

◆ GetHttpDelegate()

◆ GetLoggerContext()

◆ GetMipContext()

◆ GetObserver()

◆ GetSessionId()

◆ GetTaskDispatcherDelegate()

◆ SetCanCacheLicenses()

◆ SetDnsRedirection()

◆ SetHttpDelegate()

◆ SetLoggerContext()

◆ SetSessionId()

◆ SetTaskDispatcherDelegate()

Member Data Documentation

◆ mCacheStorageType

◆ mCanCacheLicenses

◆ mConsentDelegate

◆ mDnsRedirection

◆ mHttpDelegate

◆ mLoggerContext

◆ mMipContext

◆ mObserver

◆ mPath

◆ mSessionId

◆ mTaskDispatcherDelegate