com.intertrust.wasabi.drm

Interface TransactionListener

public interface TransactionListener

Interface that the user of this API has to implement and add to the Engine in order to get notified when transaction events occur.

Note that having a listener that properly detects any transaction failure is essential for the error handling in the client application code. The following pseudo code illustrates a listener function and the client code that capture any personalization transaction failure:

public static class SimpleEngineEventListener implements TransactionListener {
      // transaction end result code is available post transaction
      public int resultCode;

      public void onLicenseDataReceived(byte[] data) {
      }
      public void onTransactionBegin(TransactionType transactionType) {
      }
      public void onTransactionEnd(TransactionType transactionType,
                                   int resultCode, String resultString, String serviceFault) {
          // capture transaction end result code
          this.resultCode = resultCode;
      }
      public void onTransactionProgress(TransactionType transactionType,
                                        int currentStep, int totalSteps) {
      }
  }

  void MyPersonalization() {
      Runtime.initialize();
      Engine engine = new Engine();
      try {
          SimpleEngineEventListener listener = new SimpleEngineEventListener();
          engine.addTransactionListener(listener);
          engine.personalize(null);
          engine.updatePersonality(null);
          // check transaction end result code
          ErrorCodeException.checkResult(listener.resultCode);
      }  catch (Exception x) {
          x.printStackTrace();
      } finally {
          engine.destroy();
          Runtime.shutdown();
      }
  }

Method Summary

Methods

Modifier and Type	Method and Description
void	onLicenseDataReceived(byte[] data) called when some license data has been received by the engine
void	onTransactionBegin(TransactionType transactionType) called when a transaction begins
void	onTransactionEnd(TransactionType transactionType, int resultCode, java.lang.String resultString, java.lang.String serviceFault) called when a transaction ends.
void	onTransactionProgress(TransactionType transactionType, int currentStep, int totalSteps) called when a transaction makes progress

Method Detail

onLicenseDataReceived

void onLicenseDataReceived(byte[] data)

called when some license data has been received by the engine

Parameters:

data - the license data

onTransactionBegin

void onTransactionBegin(TransactionType transactionType)

called when a transaction begins

Parameters:

transactionType - type of the transaction

onTransactionProgress

void onTransactionProgress(TransactionType transactionType,
                         int currentStep,
                         int totalSteps)

called when a transaction makes progress

Parameters:

transactionType - type of the transaction

currentStep - current step of the transaction

totalSteps - total steps of the transaction

onTransactionEnd

void onTransactionEnd(TransactionType transactionType,
                    int resultCode,
                    java.lang.String resultString,
                    java.lang.String serviceFault)

called when a transaction ends.

Parameters:

transactionType - type of the transaction

resultCode - result code of the transaction, 0 is success.

resultString - message String explaining the result of the transaction

serviceFault - if a transaction has failed because of a service fault, the serviceFault contains the XML String of the SOAP fault.