Settings used to create a ProtectionHandler to protect new content. More...

#include <protection_handler.h>

Inheritance diagram for ProtectionHandler::PublishingSettings:

Public Member Functions
	PublishingSettings (const std::shared_ptr< ProtectionDescriptor > &protectionDescriptor)
	PublishingSettings constructor for enforcing protection on content.

	PublishingSettings (const std::shared_ptr< ProtectionDescriptor > &protectionDescriptor, const std::vector< uint8_t > &serializedPublishingLicense)
	PublishingSettings constructor for online republishing.

	PublishingSettings (const std::shared_ptr< ProtectionDescriptor > &protectionDescriptor, const std::shared_ptr< ProtectionHandler > &protectionHandler)
	PublishingSettings constructor for offline republishing.

std::shared_ptr< ProtectionDescriptor >	GetProtectionDescriptor () const

std::shared_ptr< ProtectionHandler >	GetProtectionHandlerForRepublish () const
	Gets protection handler for republishing scenario.

bool	GetIsAuditedExtractionAllowed () const
	Gets whether or not non-MIP-aware applications are allowed to open protected content.

void	SetIsAuditedExtractionAllowed (bool isAuditedExtractionAllowed)
	Sets whether or not non-MIP-aware applications are allowed to open protected content.

bool	GetIsDeprecatedAlgorithmPreferred () const
	Gets whether or not deprecated crypto algorithm (ECB) is preferred for backwards compatibility.

void	SetIsDeprecatedAlgorithmPreferred (bool isDeprecatedAlgorithmPreferred)
	Sets whether or not deprecated crypto algorithm (ECB) is preferred for backwards compatibility.

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

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

bool	IsPublishingFormatJson () const
	Gets whether or not the returned pl is in json format (xml format is more widely accepted and is the default).

void	SetPublishingFormatJson (bool isPublishingFormatJson)
	Sets whether or not the returned pl is in json format (xml format is more widely accepted and is the default).

bool	GetRegenerateContentKey () const
	Gets whether or not the content key and ID should be regenerated during republishing.

void	SetRegenerateContentKey (bool regenerateContentKey)
	Sets whether or not the content key and ID should be regenerated during republishing.

void	SetPreLicenseUserEmail (const std::string &preLicenseUserEmail)
	Sets pre-license user.

const std::string &	GetPreLicenseUserEmail () const
	Gets the pre-license user.

const std::vector< uint8_t > &	GetPublishingLicenseForRepublish () const
	Gets the serialized republishing license.

void	SetRequestPreLicense (std::shared_ptr< PublishingUseLicenseRequest > publishingUseLicenseRequest)
	Setting this will cause the publishing request to include a pre-license.

std::shared_ptr< PublishingUseLicenseRequest >	GetPreLicenseRequest () const
	Gets the pre-license request.

bool	GetRepairLabelIdAllowed () const
	Gets whether or not label id can be added to publishing license on republish.

void	SetRepairLabelIdAllowed (bool repairAllowed)
	Sets whether or not label id can be added to publishing license on republish.

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 protect new content.

Constructor & Destructor Documentation

◆ PublishingSettings() [1/3]

ProtectionHandler::PublishingSettings::PublishingSettings ( const std::shared_ptr< ProtectionDescriptor > & protectionDescriptor )

inline

PublishingSettings constructor for enforcing protection on content.

Parameters

protectionDescriptor Protection details

◆ PublishingSettings() [2/3]

ProtectionHandler::PublishingSettings::PublishingSettings	(	const std::shared_ptr< ProtectionDescriptor > &	protectionDescriptor,
		const std::vector< uint8_t > &	serializedPublishingLicense )

inline

PublishingSettings constructor for online republishing.

Parameters

protectionDescriptor	New protection details
serializedPublishingLicense	Original protection license

◆ PublishingSettings() [3/3]

ProtectionHandler::PublishingSettings::PublishingSettings	(	const std::shared_ptr< ProtectionDescriptor > &	protectionDescriptor,
		const std::shared_ptr< ProtectionHandler > &	protectionHandler )

inline

PublishingSettings constructor for offline republishing.

Parameters

protectionDescriptor	New protection details
protectionHandler	Original protection handler

Member Function Documentation

◆ GetDelegatedUserEmail()

const std::string & ProtectionHandler::PublishingSettings::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

◆ GetIsAuditedExtractionAllowed()

bool ProtectionHandler::PublishingSettings::GetIsAuditedExtractionAllowed ( ) const

inline

Gets whether or not non-MIP-aware applications are allowed to open protected content.

Returns: If non-MIP-aware applications are allowed to open protected content

◆ GetIsDeprecatedAlgorithmPreferred()

bool ProtectionHandler::PublishingSettings::GetIsDeprecatedAlgorithmPreferred ( ) const

inline

Gets whether or not deprecated crypto algorithm (ECB) is preferred for backwards compatibility.

Returns: If deprecated crypto algorithm is preferred

◆ GetPreLicenseRequest()

std::shared_ptr< PublishingUseLicenseRequest > ProtectionHandler::PublishingSettings::GetPreLicenseRequest ( ) const

inline

Gets the pre-license request.

Returns: Pre-license request

◆ GetPreLicenseUserEmail()

const std::string & ProtectionHandler::PublishingSettings::GetPreLicenseUserEmail ( ) const

inline

Gets the pre-license user.

Returns: Pre-license user

◆ GetProtectionDescriptor()

std::shared_ptr< ProtectionDescriptor > ProtectionHandler::PublishingSettings::GetProtectionDescriptor ( ) const

inline

◆ GetProtectionHandlerForRepublish()

std::shared_ptr< ProtectionHandler > ProtectionHandler::PublishingSettings::GetProtectionHandlerForRepublish ( ) const

inline

Gets protection handler for republishing scenario.

◆ GetPublishingLicenseForRepublish()

const std::vector< uint8_t > & ProtectionHandler::PublishingSettings::GetPublishingLicenseForRepublish ( ) const

inline

Gets the serialized republishing license.

Returns: The serialized republishing license

◆ GetRegenerateContentKey()

bool ProtectionHandler::PublishingSettings::GetRegenerateContentKey ( ) const

inline

Gets whether or not the content key and ID should be regenerated during republishing.

Returns: True if the content key and ID should be regenerated. False otherwise.

◆ GetRepairLabelIdAllowed()

bool ProtectionHandler::PublishingSettings::GetRepairLabelIdAllowed ( ) const

inline

Gets whether or not label id can be added to publishing license on republish.

Returns: True if label info data in protection descriptor can be added to publishing license

Note: This will only take effect if offline protection is used for republishing.

◆ IsPublishingFormatJson()

bool ProtectionHandler::PublishingSettings::IsPublishingFormatJson ( ) const

inline

Gets whether or not the returned pl is in json format (xml format is more widely accepted and is the default).

Returns: true if is set to json format output.

◆ SetDelegatedUserEmail()

void ProtectionHandler::PublishingSettings::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

◆ SetIsAuditedExtractionAllowed()

void ProtectionHandler::PublishingSettings::SetIsAuditedExtractionAllowed ( bool isAuditedExtractionAllowed )

inline

Sets whether or not non-MIP-aware applications are allowed to open protected content.

Parameters

isAuditedExtractionAllowed If non-MIP-aware applications are allowed to open protected content

◆ SetIsDeprecatedAlgorithmPreferred()

void ProtectionHandler::PublishingSettings::SetIsDeprecatedAlgorithmPreferred ( bool isDeprecatedAlgorithmPreferred )

inline

Sets whether or not deprecated crypto algorithm (ECB) is preferred for backwards compatibility.

Parameters

isDeprecatedAlgorithmPreferred if deprectated crypto algorithm is preferred

◆ SetPreLicenseUserEmail()

void ProtectionHandler::PublishingSettings::SetPreLicenseUserEmail ( const std::string & preLicenseUserEmail )

inline

Sets pre-license user.

Parameters

preLicenseUserEmail Pre-license user

Note: If no pre-license user is specified, a pre-license will not be obtained

◆ SetPublishingFormatJson()

void ProtectionHandler::PublishingSettings::SetPublishingFormatJson ( bool isPublishingFormatJson )

inline

Sets whether or not the returned pl is in json format (xml format is more widely accepted and is the default).

Parameters

isPublishingFormatJson if json format is enabled.

◆ SetRegenerateContentKey()

void ProtectionHandler::PublishingSettings::SetRegenerateContentKey ( bool regenerateContentKey )

inline

Sets whether or not the content key and ID should be regenerated during republishing.

Parameters

regenerateContentKey If the content key and ID should be regenerated.

◆ SetRepairLabelIdAllowed()

void ProtectionHandler::PublishingSettings::SetRepairLabelIdAllowed ( bool repairAllowed )

inline

Sets whether or not label id can be added to publishing license on republish.

Parameters

repairAllowed if label info data in protection descriptor can be added to publishing license

Note: This will only take effect if offline protection is used for republishing. Should only be used to add a label to adhoc protection that is missing it.

◆ SetRequestPreLicense()

void ProtectionHandler::PublishingSettings::SetRequestPreLicense ( std::shared_ptr< PublishingUseLicenseRequest > publishingUseLicenseRequest )

inline

Setting this will cause the publishing request to include a pre-license.

Parameters

publishingUseLicenseRequest The pre-license request

Note: If no pre-license request is specified, a pre-license will not be obtained

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

◆ PublishingSettings() [1/3]

◆ PublishingSettings() [2/3]

◆ PublishingSettings() [3/3]

Member Function Documentation

◆ GetDelegatedUserEmail()

◆ GetIsAuditedExtractionAllowed()

◆ GetIsDeprecatedAlgorithmPreferred()

◆ GetPreLicenseRequest()

◆ GetPreLicenseUserEmail()

◆ GetProtectionDescriptor()

◆ GetProtectionHandlerForRepublish()

◆ GetPublishingLicenseForRepublish()

◆ GetRegenerateContentKey()

◆ GetRepairLabelIdAllowed()

◆ IsPublishingFormatJson()

◆ SetDelegatedUserEmail()

◆ SetIsAuditedExtractionAllowed()

◆ SetIsDeprecatedAlgorithmPreferred()

◆ SetPreLicenseUserEmail()

◆ SetPublishingFormatJson()

◆ SetRegenerateContentKey()

◆ SetRepairLabelIdAllowed()

◆ SetRequestPreLicense()