Settings used to create a ProtectionHandler to consume existing content. More...

#include <protection_handler.h>

Inheritance diagram for ProtectionHandler::ConsumptionSettings:

Public Member Functions
	ConsumptionSettings (const std::vector< uint8_t > &serializedPublishingLicense)
	ProtectionHandler::ConsumptionSettings constructor for creating a new handler.

	ConsumptionSettings (const std::vector< uint8_t > &serializedPreLicense, const std::vector< uint8_t > &serializedPublishingLicense)
	ProtectionHandler::ConsumptionSettings constructor for creating a new handler.

	ConsumptionSettings (const std::shared_ptr< PublishingLicenseInfo > &licenseInfo)
	ProtectionHandler::ConsumptionSettings constructor for creating a new handler.

std::shared_ptr< PublishingLicenseInfo >	GetPublishingLicenseInfo () const
	Get the publishing license associated with the protected content.

void	SetDelegatedUserEmail (const std::string &delegatedUserEmail)
	Sets the delegated user.

const std::string &	GetDelegatedUserEmail () const
	Gets the delegated user.

void	SetContentName (const std::string &contentName)
	Defines the content name to register with document tracking.

const std::string &	GetContentName () const
	Gets the content name to register with document tracking.

MIP_API void	AddRmsCapability (const std::string &capability)
	Add a capability which will be passed along to RMS when fetching usage rights.

MIP_API bool	RemoveRmsCapability (const std::string &capability)
	Remove one of the added usage rights capabilities which get passed to RMS.

const std::shared_ptr< std::vector< std::string > >	GetRmsCapabilities () const
	The the full set of client capabilities supported when fetching usage rights from RMS.

Public Member Functions inherited from ProtectionCommonSettings
	ProtectionCommonSettings (std::string applicationScenarioId=std::string())

std::string	GetApplicationScenarioId () const
	Gets the scenario Id provided by the application which is used to correlation 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.

Detailed Description

Settings used to create a ProtectionHandler to consume existing content.

Constructor & Destructor Documentation

◆ ConsumptionSettings() [1/3]

ProtectionHandler::ConsumptionSettings::ConsumptionSettings ( const std::vector< uint8_t > & serializedPublishingLicense )

inline

ProtectionHandler::ConsumptionSettings constructor for creating a new handler.

Parameters

serializedPublishingLicense Serialized publishing license from protected content

◆ ConsumptionSettings() [2/3]

ProtectionHandler::ConsumptionSettings::ConsumptionSettings	(	const std::vector< uint8_t > &	serializedPreLicense,
		const std::vector< uint8_t > &	serializedPublishingLicense )

inline

ProtectionHandler::ConsumptionSettings constructor for creating a new handler.

Parameters

serializedPreLicense	Serialized pre license from attached to the content.
serializedPublishingLicense	Serialized publishing license from protected content

◆ ConsumptionSettings() [3/3]

ProtectionHandler::ConsumptionSettings::ConsumptionSettings ( const std::shared_ptr< PublishingLicenseInfo > & licenseInfo )

inline

ProtectionHandler::ConsumptionSettings constructor for creating a new handler.

Parameters

licenseInfo Publishing license info from protected content

Note: Providing a PublishingLicenseInfo (as opposed to just a raw serialized publishing license) will remove the need for MIP SDK to parse the publishing license.

Member Function Documentation

◆ AddRmsCapability()

MIP_API void ProtectionHandler::ConsumptionSettings::AddRmsCapability ( const std::string & capability )

Add a capability which will be passed along to RMS when fetching usage rights.

Remarks: Capabilities configured for this protection handler take precedence over any RMS capabilities configured on the protection engine.

Parameters

capability An identifier that describes a capability that RMS supports

◆ GetContentName()

const std::string & ProtectionHandler::ConsumptionSettings::GetContentName ( ) const

inline

Gets the content name to register with document tracking.

Returns: The content name

◆ GetDelegatedUserEmail()

const std::string & ProtectionHandler::ConsumptionSettings::GetDelegatedUserEmail ( ) const

inline

Gets the delegated user.

Returns: Delegated user

Note: A delegated user is specified when the authenticating user/application is acting on behalf of another user

◆ GetPublishingLicenseInfo()

std::shared_ptr< PublishingLicenseInfo > ProtectionHandler::ConsumptionSettings::GetPublishingLicenseInfo ( ) const

inline

Get the publishing license associated with the protected content.

Returns: Publishing license information

◆ GetRmsCapabilities()

const std::shared_ptr< std::vector< std::string > > ProtectionHandler::ConsumptionSettings::GetRmsCapabilities ( ) const

inline

The the full set of client capabilities supported when fetching usage rights from RMS.

Returns: a pointer to a list of capabilities.

◆ RemoveRmsCapability()

MIP_API bool ProtectionHandler::ConsumptionSettings::RemoveRmsCapability ( const std::string & capability )

Remove one of the added usage rights capabilities which get passed to RMS.

Remarks: Capabilities configured for this protection handler take precedence over any RMS capabilities configured on the protection engine.

Parameters

capability The capability which should be removed.

◆ SetContentName()

void ProtectionHandler::ConsumptionSettings::SetContentName ( const std::string & contentName )

inline

Defines the content name to register with document tracking.

Parameters

contentName The identifier to register content under.

Note: : If the content has already been registered, its name will not be changed.

◆ SetDelegatedUserEmail()

void ProtectionHandler::ConsumptionSettings::SetDelegatedUserEmail ( const std::string & delegatedUserEmail )

inline

Sets the delegated user.

Parameters

delegatedUserEmail the delegation email.

Note: A delegated user is specified when the authenticating user/application is acting on behalf of another user

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

/home/mbaldwin/docs/mip-sdk-for-cpp/src/api/mip/protection/protection_handler.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ConsumptionSettings() [1/3]

◆ ConsumptionSettings() [2/3]

◆ ConsumptionSettings() [3/3]

Member Function Documentation

◆ AddRmsCapability()

◆ GetContentName()

◆ GetDelegatedUserEmail()

◆ GetPublishingLicenseInfo()

◆ GetRmsCapabilities()

◆ RemoveRmsCapability()

◆ SetContentName()

◆ SetDelegatedUserEmail()