com.SecurePlay.SPTSimultaneous
Class SPTSimultaneousAPIClass

java.lang.Object
  com.SecurePlay.SPAbstractTransactionAPIClass
      com.SecurePlay.SPTSimultaneous.SPTSimultaneousAPIClass

All Implemented Interfaces:

SPAbstractTransactionAPIInterface

public class SPTSimultaneousAPIClass

extends SPAbstractTransactionAPIClass

API version of SPSimultaneusClass

Author:

IT GlobalSecure

See Also:

SecurePlay License Information

Field Summary

Fields inherited from class com.SecurePlay.SPAbstractTransactionAPIClass

transactioninstance

Constructor Summary

SPTSimultaneousAPIClass(SPTSimultaneousClass simultinstance)
Overloaded Constructor

Method Summary

java.lang.String	APIgetSecret(java.lang.String sender) This method returns the actual secret for the specified player that this transaction is protecting, if available.
boolean	APIrequestsendHiddenSecret(java.lang.String pid, java.lang.String sender, java.lang.String newsecret) This method allows any party to request the specified transaction participant send a Secret to support the simultaneous transaction.
boolean	APIsendHiddenSecret(java.lang.String sender, java.lang.String newsecret) This method allows the specified transaction participant to send the transform of a secret to the other participants in the Simultaneous transaction.
boolean	APIverifySimultaneous() This method verifies whether a Simultaneous transaction was carried out successfully and responds with a simple Boolean.
boolean	rulesSimultaneoussendHiddenSecret(java.lang.String pid, java.lang.String sender, java.lang.String body, SPTSimultaneousClass transobj) This shell method handles requests to create sendHiddenSecret messages for simultaneous transactions.

Methods inherited from class com.SecurePlay.SPAbstractTransactionAPIClass

APIAddListener, APIbeginTransaction, APIClearListeners, APIcompleteTransaction, APIconfigureTransaction, APIGetListenerCount, APIGetListeners, APIRemoveListener, APIrequestbeginTransaction, APIrequestCompleteTransaction, APIrequestconfigureTransaction, APISPawn, getTransactioninstance, rulesbeginTransaction, rulescompleteTransaction, rulesconfigureTransaction

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SPTSimultaneousAPIClass

public SPTSimultaneousAPIClass(SPTSimultaneousClass simultinstance)

Overloaded Constructor

Parameters:

simultinstance - SPSimultaneousClass - the transaction from which the API will build from

Method Detail

APIgetSecret

public java.lang.String APIgetSecret(java.lang.String sender)

This method returns the actual secret for the specified player that this transaction is protecting, if available.

Parameters:

sender - String - sender of the secret

Returns:

secret - String - the secret

APIrequestsendHiddenSecret

public boolean APIrequestsendHiddenSecret(java.lang.String pid,
                                          java.lang.String sender,
                                          java.lang.String newsecret)

This method allows any party to request the specified transaction participant send a Secret to support the simultaneous transaction. It is mainly used for remote debugging purposes.

Parameters:

pid - String - player id, or the master of the transaction

sender - String - sender, or the requestor, can not be master

newsecret - String - the secret

Returns:

result - Boolean: TRUE, if request successfully sent, FALSE, if not

APIsendHiddenSecret

public boolean APIsendHiddenSecret(java.lang.String sender,
                                   java.lang.String newsecret)

This method allows the specified transaction participant to send the transform of a secret to the other participants in the Simultaneous transaction.

Parameters:

sender - String - sender of the secret

newsecret - String - the secret

Returns:

result - Boolean: TRUE, if successful, FALSE, if not

APIverifySimultaneous

public boolean APIverifySimultaneous()

This method verifies whether a Simultaneous transaction was carried out successfully and responds with a simple Boolean.

Returns:

result - Boolean: TRUE, if transaction verified, FALSE, if not.

rulesSimultaneoussendHiddenSecret

public boolean rulesSimultaneoussendHiddenSecret(java.lang.String pid,
                                                 java.lang.String sender,
                                                 java.lang.String body,
                                                 SPTSimultaneousClass transobj)

This shell method handles requests to create sendHiddenSecret messages for simultaneous transactions. It is mainly used for remote debugging purposes.

Parameters:

pid - String - player id of the master of the transaction

sender - String - player id of the sender

body - String - body of the transaction

transobj - SPSimultaneousClass - the transaction object

Returns:

result boolean - true, if successful, false, if not.