OTVPRMNonSilentCallback Interface Reference

Detailed Description

An interface defining the methods integrators must implement to facilitate PRM decryption licensing.

There is already a default implementation - nagra.otv.sdk.prm.OTVSSPPRMNonSilentCallback - that integrators can use.

Inheritance diagram for OTVPRMNonSilentCallback:

Public Member Functions
void	setInitializationClientProtectedPrivateData (String xInitializationClientProtectedPrivateData)
	Sets the data needed to generate an initialization request payload. More...
String	getInitializationClientProtectedPrivateData ()
	Gets the data needed to generate an initialization payload. More...
Pair< String, List< Map< String, String > > >	executeInitializeRequest (String deviceID, String initializationPayloadForServer) throws Exception
	Executes a PRM initialization request. More...
void	setLicenseRequestClientProtectedPrivateData (String xLicenseRequestClientProtectedPrivateData)
	Sets the data needed to generate a license request payload. More...
String	getLicenseRequestClientProtectedPrivateData ()
	Gets the data needed to generate a license request payload. More...
Pair< String, String >	executeKeyRequest (String deviceID, String contentID, String entitlementPayloadForServer) throws IOException, JSONException
	Executes a PRM key (license) request. More...
default List< Map< String, String > >	executePredeliveryKeyRequest (String deviceID, String contentID, String predeliveryPayloadForServer) throws IOException, JSONException
	Executes a predelivery PRM key (license) request. More...

Member Function Documentation

Pair<String, List<Map<String,String> > > executeInitializeRequest	(	String	deviceID,
		String	initializationPayloadForServer
	)		throws Exception

Executes a PRM initialization request.

Parameters

deviceID	The ID of the device running the PRM client
initializationPayloadForServer	The data to send to the PRM server for initialization

Returns

The pair values of the initialization payload returned by the server and the license list for predelivery if the predelivery license presents.

Exceptions

Exception

If an error occurred executing the request.

Implemented in OTVSSPPRMNonSilentCallback.

Pair<String, String> executeKeyRequest	(	String	deviceID,
		String	contentID,
		String	entitlementPayloadForServer
	)		throws IOException, JSONException

Executes a PRM key (license) request.

Parameters

deviceID	The ID of the device running the PRM client
contentID	The ID of the stream requiring a key
entitlementPayloadForServer	The data to send to the PRM server to perform a key (license) request

Returns

The pair of keys (licenses) requested in the format <DMM, DCM>

Exceptions

Exception

if an error occurred executing the request.

Implemented in OTVSSPPRMNonSilentCallback.

default List<Map<String, String> > executePredeliveryKeyRequest	(	String	deviceID,
		String	contentID,
		String	predeliveryPayloadForServer
	)		throws IOException, JSONException

Executes a predelivery PRM key (license) request.

Parameters

deviceID	The ID of the device running the PRM client
contentID	The ID of the stream requiring a key
predeliveryPayloadForServer	The data to send to the PRM server to perform a predelivery key (license) request

Returns

The licenses list for predelivery.

Exceptions

Exception

if an error occurred executing the request.

Implemented in OTVSSPPRMNonSilentCallback.

String getInitializationClientProtectedPrivateData

(

)

Gets the data needed to generate an initialization payload.

Returns

the data needed to generate an initialization payload

Implemented in OTVSSPPRMNonSilentCallback.

String getLicenseRequestClientProtectedPrivateData

(

)

Gets the data needed to generate a license request payload.

Returns

the data needed to generate a license request payload

Implemented in OTVSSPPRMNonSilentCallback.

void setInitializationClientProtectedPrivateData

(

String

xInitializationClientProtectedPrivateData

)

Sets the data needed to generate an initialization request payload.

Parameters

xInitializationClientProtectedPrivateData

Private data inserted in the generated payload returned by this method. It should be a string base64 encoded in order to be JSON and XML compatible. Must be used to transmit sensible information like the session token.

Implemented in OTVSSPPRMNonSilentCallback.

void setLicenseRequestClientProtectedPrivateData

(

String

xLicenseRequestClientProtectedPrivateData

)

Sets the data needed to generate a license request payload.

Parameters

xLicenseRequestClientProtectedPrivateData

Private data inserted in the generated payload returned by this method. It should be a string base64 encoded in order to be JSON and XML compatible. Must be used to transmit sensible information like the session token.

Implemented in OTVSSPPRMNonSilentCallback.