com.mcac0006.siftscience

Class SiftScienceHelper

java.lang.Object

com.mcac0006.siftscience.SiftScienceHelper

public class SiftScienceHelper
extends Object

This helper will take care of marshalling the content you wish to send to Sift Science and also POST send it to Sift Science. This class is synchronous.

Author:

Matthew Cachia

Method Summary

Modifier and Type	Method and Description
static SiftScienceResponse	deserializeResponse(String $response) Deserializes a response after sending an Event or a Label.
static SiftScienceScore	deserializeScore(String $scoreResponse) Deserializes the score returned by Sift Science.
static SiftScienceScore	getScore(String api_key, String userId) Retrieve a risk assessment of a particular user.
static SiftScienceResponse	send(Event event) Sends an event ($transaction, $create_account, etc ...) to Sift Science.
static SiftScienceResponse	send(String userId, Label label) Sends a Label ($label) to Sift Science.
static String	serialize(Event event) Serializes an event as a JSON envelope, ready to be sent to Sift Science.
static String	serialize(Label label)

Methods inherited from class java.lang.Object

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

Method Detail

send

public static SiftScienceResponse send(Event event)

Sends an event ($transaction, $create_account, etc ...) to Sift Science.

Parameters:

event - - the content regarding the user (or session) in question.

Returns:

the Sift Science response which denotes whether the request has been processed successfully or not.

send

public static SiftScienceResponse send(String userId,
                                       Label label)

Sends a Label ($label) to Sift Science.

Parameters:

userId - - the user in question

label - - the content regarding the user in question.

Returns:

the Sift Science response which denotes whether the request has been processed successfully or not.

getScore

public static SiftScienceScore getScore(String api_key,
                                        String userId)

Retrieve a risk assessment of a particular user. This is particularly useful to consult with Sift Science before you proceed with any (user-invoked or system-invoked) operations (such as a purchase) on that user.

Parameters:

api_key - - the api key to denote which Sift Science account to use.

userId - - the user would you like to run a risk assessment on.

Returns:

a Sift Science score wrapped in a SiftScienceScore instance containing information such as the fraud score and the reason. Refer to the class' JavaDocs for more information.

serialize

public static String serialize(Event event)
                        throws IOException

Serializes an event as a JSON envelope, ready to be sent to Sift Science.

Useful if you have your own way of sending the envelope. Should you require a way of sending the envelope via Http, you can make use of send(Event).

Parameters:

event - the filled event POJO, ready to be serialized

Returns:

the event in JSON form.

Throws:

IOException - thrown whenever an error (unexpected or user-inflicted) has been found during serialization of the event.

serialize

public static String serialize(Label label)
                        throws IOException

Throws:

IOException

deserializeResponse

public static SiftScienceResponse deserializeResponse(String $response)
                                               throws IOException

Deserializes a response after sending an Event or a Label.

Parameters:

$response - the JSON envelope withholding Sift Science's response.

Returns:

the response in POJO.

Throws:

IOException - thrown whenever an error (unexpected or user-inflicted) has been found during deserialization of the event or label.

deserializeScore

public static SiftScienceScore deserializeScore(String $scoreResponse)
                                         throws IOException

Deserializes the score returned by Sift Science.

Useful if you have your own way of sending and receiving requests. Should you require a way of receiving the score Http, you can make use of getScore(String, String).

Parameters:

$scoreResponse - the JSON envelope withholding Sift Science's response.

Returns:

the response in POJO.

Throws:

IOException - thrown whenever an error (unexpected or user-inflicted) has been found during deserialization of the score.