com.SecurePlay.SPTStrobe
Class SPTStrobeAPIClass

java.lang.Object
  com.SecurePlay.SPAbstractTransactionAPIClass
      com.SecurePlay.SPTStrobe.SPTStrobeAPIClass

All Implemented Interfaces:

SPAbstractTransactionAPIInterface

public class SPTStrobeAPIClass

extends SPAbstractTransactionAPIClass

The Strobe Class is used to provide securely synchronized game play. This is essentially a combination of the Multipart transaction and the Simultaneous transaction. Each participant sends a simultaneous message to the others. Once all sent, then a “tick” or event has occurred. Then another message can be sent and the first message read.

Author:

IT GlobalSecure

See Also:

SecurePlay License Information

Field Summary

Fields inherited from class com.SecurePlay.SPAbstractTransactionAPIClass

transactioninstance

Constructor Summary

SPTStrobeAPIClass(SPTStrobeClass 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 STROBE step 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	APIverifyStrobeStep() This method verifies whether the just completed STROBE step is valid.
boolean	rulesStrobesendHiddenSecret(java.lang.String pid, java.lang.String sender, java.lang.String[] body, SPTStrobeClass 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

SPTStrobeAPIClass

public SPTStrobeAPIClass(SPTStrobeClass simultinstance)

Overloaded Constructor

Parameters:

simultinstance - - SPStrobeClass - the abstract version of the class with which this API will be associated with

Method Detail

APIgetSecret

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

This method returns the actual secret for the specified player that this STROBE step 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

APIverifyStrobeStep

public boolean APIverifyStrobeStep()

This method verifies whether the just completed STROBE step is valid.

Returns:

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

rulesStrobesendHiddenSecret

public boolean rulesStrobesendHiddenSecret(java.lang.String pid,
                                           java.lang.String sender,
                                           java.lang.String[] body,
                                           SPTStrobeClass 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.