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

#include <src/api/mip/protection/protection_profile.h>

Public Member Functions
void	AddRedirectionUri (const std::string &originalUri, const std::string &redirectUri)
	Adds a redirect uri.

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

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

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

const std::vector< std::pair< std::string, std::string > > &	GetCustomSettings () const
	Get the custom settings, used for feature gating and testing.

DnsRedirection	GetDnsRedirection () const
	Gets the dns redirect mode.

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

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.

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

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

const std::map< std::string, std::string > &	GetRedirectionUris () const
	Gets the redirection uris.

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

std::shared_ptr< StorageDelegate >	GetStorageDelegate () const
	Get the StorageDelegate (if any) provided by the application.

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

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

void	SetCustomSettings (const std::vector< std::pair< std::string, std::string > > &customSettings)
	Set the custom settings, used for feature gating and testing.

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

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

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.

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

void	SetStorageDelegate (const std::shared_ptr< StorageDelegate > &storageDelegate)
	Override default storage cache with client's own implementation.

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

	Settings (const std::shared_ptr< MipContext > &mipContext, CacheStorageType cacheStorageType, const std::shared_ptr< ConsentDelegate > &consentDelegate)
	ProtectionProfile::Settings constructor, used for synchronous operations.

	Settings (const std::shared_ptr< MipContext > &mipContext, CacheStorageType cacheStorageType, const std::shared_ptr< ConsentDelegate > &consentDelegate, const std::shared_ptr< ProtectionProfile::Observer > &observer)
	ProtectionProfile::Settings constructor that specifies an observer to be used for async operations.

Detailed Description

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

Definition at line 167 of file protection_profile.h.

Constructor & Destructor Documentation

◆ Settings() [1/2]

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

inline

ProtectionProfile::Settings constructor that specifies an observer to be used for async operations.

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 ProtectionProfile
applicationInfo	Info about application that is consuming the protection SDK

Definition at line 178 of file protection_profile.h.

        : mMipContext(mipContext),
          mCacheStorageType(cacheStorageType),
          mConsentDelegate(consentDelegate),
          mObserver(observer),
          mCanCacheLicenses(true),
#if defined(MIP_OFFLINE_PUBLISHING_ENABLED) || defined(SWIG) || defined(SWIG_DIRECTORS)
          mOfflinePublishing(false),
#endif // MIP_OFFLINE_PUBLISHING_ENABLED
          mDnsRedirection(DnsRedirection::MDEDiscovery) {
    }

◆ Settings() [2/2]

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

inline

ProtectionProfile::Settings constructor, used for synchronous operations.

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
applicationInfo	Info about application which is consuming the protection SDK

Definition at line 202 of file protection_profile.h.

206 : Settings(mipContext, cacheStorageType, consentDelegate, nullptr /*observer*/) {

207 }

ProtectionProfile::Settings::Settings

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

ProtectionProfile::Settings constructor that specifies an observer to be used for async operations.

Definition protection_profile.h:178

Member Function Documentation

◆ AddRedirectionUri()

void ProtectionProfile::Settings::AddRedirectionUri	(	const std::string &	originalUri,
		const std::string &	redirectUri )

inline

Adds a redirect uri.

Parameters

originalUri	The uri that should be redirected from
redirectUri	The uri that will replace the originalUri

Note: Use this function to provide a domain that should be redirected to another Uri The originalUri will be normalized before comparison with the domain for the current request. If the domain of the current request matches that of the originalUri then the redirectUri will be used instead This redirection will occur before DNS lookup redirection

Definition at line 371 of file protection_profile.h.

                                                                                       {
      mRedirectionUris[originalUri] = redirectUri;
    }

◆ CanCacheLicenses()

bool ProtectionProfile::Settings::CanCacheLicenses ( ) const

inline

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

Returns: License caching configuration

Definition at line 319 of file protection_profile.h.

                                  {
      return mCanCacheLicenses;
    }

◆ GetCacheStorageType()

CacheStorageType ProtectionProfile::Settings::GetCacheStorageType ( ) const

inline

Get whether caches are stored in memory or on disk.

Returns: storage type used

Definition at line 218 of file protection_profile.h.

218{ return mCacheStorageType; }

◆ GetConsentDelegate()

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

inline

Gets the consent delegate used for connecting to services.

Returns: Consent delegate used for connecting to services

Definition at line 225 of file protection_profile.h.

225{ return mConsentDelegate; }

◆ GetCustomSettings()

const std::vector< std::pair< std::string, std::string > > & ProtectionProfile::Settings::GetCustomSettings ( ) const

inline

Get the custom settings, used for feature gating and testing.

Returns: List of name/value pairs.

Definition at line 337 of file protection_profile.h.

                                                                              {
      return mCustomSettings;
    }

◆ GetDnsRedirection()

DnsRedirection ProtectionProfile::Settings::GetDnsRedirection ( ) const

inline

Gets the dns redirect mode.

Returns: The redirect mode used

Definition at line 409 of file protection_profile.h.

                                             {
      return mDnsRedirection;
    }

◆ GetHttpDelegate()

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

inline

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

Returns: HTTP delegate to be used for HTTP operations

Definition at line 246 of file protection_profile.h.

246{ return mHttpDelegate; }

◆ GetLoggerContext()

const std::shared_ptr< void > & ProtectionProfile::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

Definition at line 347 of file protection_profile.h.

347{ return mLoggerContext; }

◆ GetMipContext()

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

inline

Get MIP context which represents shared state across all profiles.

Returns: MIP context

Definition at line 239 of file protection_profile.h.

239{ return mMipContext; }

◆ GetObserver()

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

inline

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

Returns: Observer that receives notifications of events related to ProtectionProfile

Definition at line 232 of file protection_profile.h.

232{ return mObserver; }

◆ GetRedirectionUris()

const std::map< std::string, std::string > & ProtectionProfile::Settings::GetRedirectionUris ( ) const

inline

Gets the redirection uris.

Returns: Map of redirection uris

Definition at line 380 of file protection_profile.h.

                                                                   {
      return mRedirectionUris;
    }

◆ GetSessionId()

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

inline

Gets the session ID.

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

Definition at line 300 of file protection_profile.h.

300{ return mSessionId; }

◆ GetStorageDelegate()

std::shared_ptr< StorageDelegate > ProtectionProfile::Settings::GetStorageDelegate ( ) const

inline

Get the StorageDelegate (if any) provided by the application.

Returns: StorageDelegate to be used for caching

Definition at line 260 of file protection_profile.h.

260{ return mStorageDelegate; }

◆ GetTaskDispatcherDelegate()

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

inline

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

Returns: TaskDispatcher delegate to be used for executing asynchronous tasks

Definition at line 274 of file protection_profile.h.

274{ return mTaskDispatcherDelegate; }

◆ SetCanCacheLicenses()

void ProtectionProfile::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.

Definition at line 310 of file protection_profile.h.

                                                    {
      mCanCacheLicenses = canCacheLicenses;
    }

◆ SetCustomSettings()

void ProtectionProfile::Settings::SetCustomSettings ( const std::vector< std::pair< std::string, std::string > > & customSettings )

inline

Set the custom settings, used for feature gating and testing.

Parameters

customSettings List of name/value pairs.

Definition at line 328 of file protection_profile.h.

                                                                                           {
      mCustomSettings = customSettings;
    }

◆ SetDnsRedirection()

void ProtectionProfile::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

Definition at line 418 of file protection_profile.h.

                                                          {
      mDnsRedirection = dnsRedirection;
    }

◆ SetHttpDelegate()

void ProtectionProfile::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

Definition at line 253 of file protection_profile.h.

253{ mHttpDelegate = httpDelegate; }

◆ SetLoggerContext()

void ProtectionProfile::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

Definition at line 356 of file protection_profile.h.

                                                                    {
      mLoggerContext = loggerContext;
    }

◆ SetSessionId()

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

inline

Sets the session ID.

Parameters

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

Definition at line 293 of file protection_profile.h.

293{ mSessionId = sessionId; }

◆ SetStorageDelegate()

void ProtectionProfile::Settings::SetStorageDelegate ( const std::shared_ptr< StorageDelegate > & storageDelegate )

inline

Override default storage cache with client's own implementation.

Parameters

storageDelegate StorageDelegate interface implemented by client application

Definition at line 267 of file protection_profile.h.

267{ mStorageDelegate = storageDelegate; }

◆ SetTaskDispatcherDelegate()

void ProtectionProfile::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.

Definition at line 284 of file protection_profile.h.

                                                                                                        {
      mTaskDispatcherDelegate = taskDispatcherDelegate;
    }

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

src/api/mip/protection/protection_profile.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Settings() [1/2]

◆ Settings() [2/2]

Member Function Documentation

◆ AddRedirectionUri()

◆ CanCacheLicenses()

◆ GetCacheStorageType()

◆ GetConsentDelegate()

◆ GetCustomSettings()

◆ GetDnsRedirection()

◆ GetHttpDelegate()

◆ GetLoggerContext()

◆ GetMipContext()

◆ GetObserver()

◆ GetRedirectionUris()

◆ GetSessionId()

◆ GetStorageDelegate()

◆ GetTaskDispatcherDelegate()

◆ SetCanCacheLicenses()

◆ SetCustomSettings()

◆ SetDnsRedirection()

◆ SetHttpDelegate()

◆ SetLoggerContext()

◆ SetSessionId()

◆ SetStorageDelegate()

◆ SetTaskDispatcherDelegate()