ProtectionCommonSettings Class Reference

Settings to use for protection operations. More...

#include <mip/protection/protection_common_settings.h>

Inheritance diagram for ProtectionCommonSettings:

Public Member Functions
	ProtectionCommonSettings (std::string applicationScenarioId=std::string())
std::string	GetApplicationScenarioId () const
	Gets the scenario Id provided by the application which is used to correlate with the server.
void	SetApplicationScenarioId (std::string applicationScenarioId)
	Sets the scenario Id provided by the application.
bool	GetIsOfflineOnly () const
	Gets whether or not ProtectionEngine operation allows for online HTTP operations.
virtual void	SetIsOfflineOnly (bool isOfflineOnly)
	Sets whether or not ProtectionEngine operation allows for online HTTP operations.
void	SetCustomSettings (const std::vector< std::pair< std::string, std::string > > &customSettings)
	Set the custom settings, used for feature gating and testing.
const std::vector< std::pair< std::string, std::string > > &	GetCustomSettings () const
	Get the custom settings, used for feature gating and testing.
virtual	~ProtectionCommonSettings ()
ProtectionCommonSettings &	operator= (const ProtectionCommonSettings &other)

Private Attributes
std::string	mApplicationScenarioId
bool	mIsOfflineOnly
std::vector< std::pair< std::string, std::string > >	mCustomSettings

Detailed Description

Settings to use for protection operations.

Constructor & Destructor Documentation

ProtectionCommonSettings()

ProtectionCommonSettings::ProtectionCommonSettings ( std::string applicationScenarioId = std::string() )

inline

~ProtectionCommonSettings()

virtual ProtectionCommonSettings::~ProtectionCommonSettings ( )

inlinevirtual

Member Function Documentation

GetApplicationScenarioId()

std::string ProtectionCommonSettings::GetApplicationScenarioId ( ) const

inline

Gets the scenario Id provided by the application which is used to correlate with the server.

Returns

Application scenario Id

GetCustomSettings()

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

inline

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

Returns

List of name/value pairs.

GetIsOfflineOnly()

bool ProtectionCommonSettings::GetIsOfflineOnly ( ) const

inline

Gets whether or not ProtectionEngine operation allows for online HTTP operations.

Returns

True if HTTP operations are disallowed, else false

Note

If this returns true, operation will only succeed if necessary content has already been cached. A mip::NetworkError will be thrown if needed info is not found. Consumption - content has already been previously decrypted and its unexpired license is cached. Protection - unexpired templates have been cached and user cert is loaded Others - undefined

operator=()

ProtectionCommonSettings & ProtectionCommonSettings::operator= ( const ProtectionCommonSettings & other )

inline

SetApplicationScenarioId()

void ProtectionCommonSettings::SetApplicationScenarioId ( std::string applicationScenarioId )

inline

Sets the scenario Id provided by the application.

Parameters

applicationScenarioId

application scenario Id which is used to correlate with the server.

SetCustomSettings()

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

SetIsOfflineOnly()

virtual void ProtectionCommonSettings::SetIsOfflineOnly ( bool isOfflineOnly )

inlinevirtual

Sets whether or not ProtectionEngine operation allows for online HTTP operations.

Parameters

isOfflineOnly

True if HTTP operations are disallowed, else false

Note

If this is set to true, operation will only succeed if necessary content has already been cached. A mip::NetworkError will be thrown if needed info is not found. Consumption - content has already been previously decrypted and its unexpired license is cached. Protection - unexpired templates have been cached and user cert is loaded Others - undefined

Member Data Documentation

mApplicationScenarioId

std::string ProtectionCommonSettings::mApplicationScenarioId

private

mCustomSettings

std::vector<std::pair<std::string, std::string> > ProtectionCommonSettings::mCustomSettings

private

mIsOfflineOnly

bool ProtectionCommonSettings::mIsOfflineOnly

private

---

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

• src/api/mip/protection/protection_common_settings.h