com.dotdashpay.api.internal

Class DDPUtils

java.lang.Object

com.dotdashpay.api.internal.DDPUtils

public final class DDPUtils
extends java.lang.Object

Utility functions for the DotDashPay API: mostly for manipulating protobufs and translating them to/from other data objects. Created by colorado on 11/4/15.

Method Summary

Modifier and Type	Method and Description
static Message	buildProtobuf(java.lang.String msgName, byte[] encodedMsg) Build a protobuf with the given message name
static Message	buildProtobuf(java.lang.String msgName, JsonObject msgJson) Build a protobuf with the given message name from the input json object
static Response	convertProtoMessageToResponse(Message protomsg) Convert a response protomsg into a DDP Response object
static JsonObject	convertProtoToJsonObject(Message protomsg) Converts a proto message into a JsonObject
static java.lang.String	getAMQPConnectionURL() Get the DDP AMQP connection URL Use Shared.set("dev_ddp_cloud_id", "id") and Shared.set("dev_ddp_cloud_key", "key") to set the AMQP credentials
static java.lang.String	getMessageName(Message protomsg) Get the message name from a proto message
static java.lang.Class<?>	getProtobufClass(java.lang.String msgName) Get the protobuf class with the given message name
static RequestMeta.Builder	getRequestMeta() Generate a random id for a request meta protobuf message
static java.lang.Object	getValueFromMessage(Message msg, java.lang.String accessString) Get a field value from protobuf message for example if you have a protomsg with format { meta { "id": "a5" "owner": { "name": "rado", "position": "OG" } } "color": "blue" } calling getValueFromMessage(msg, "color") will return "blue" and calling getValueFromMessage(msg, "meta.owner.name") will return "rado"
static boolean	isResponseUpdate(Message responseMsg) Checks if the response message is an update message
static CloudPaymentInitiated	parseCloudPaymentJsonToProto(JsonObject paymentData, java.lang.String paymentDataId) Parse data from a cloud payment to an appropriate protobuf message
static java.lang.String	readFile(java.lang.String file) Read in a file and return a string of the text in that file

Methods inherited from class java.lang.Object

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

Method Detail

getRequestMeta

public static RequestMeta.Builder getRequestMeta()

Generate a random id for a request meta protobuf message

Returns:

RequestMeta builder with the id field set with a random UUID

readFile

public static java.lang.String readFile(java.lang.String file)
                                 throws java.io.IOException,
                                        java.io.FileNotFoundException

Read in a file and return a string of the text in that file

Parameters:

file - The file path of the file to read

Returns:

A string of the text in the provided file

Throws:

java.io.IOException - thrown if an error occurs while readinging in the file

java.io.FileNotFoundException - thrown if the file is not found

convertProtoToJsonObject

public static JsonObject convertProtoToJsonObject(Message protomsg)

Converts a proto message into a JsonObject

Parameters:

protomsg - The proto message to convert to a json object

Returns:

The JsonObject representation of the proto message

convertProtoMessageToResponse

public static Response convertProtoMessageToResponse(Message protomsg)

Convert a response protomsg into a DDP Response object

Parameters:

protomsg - the response protomsg

Returns:

The DDP Response object

getMessageName

public static java.lang.String getMessageName(Message protomsg)

Get the message name from a proto message

Parameters:

protomsg - the proto message

Returns:

the message name

getProtobufClass

public static java.lang.Class<?> getProtobufClass(java.lang.String msgName)
                                           throws java.lang.ClassNotFoundException

Get the protobuf class with the given message name

Parameters:

msgName - the message name

Returns:

the Class of the protobuf with the given message name

Throws:

java.lang.ClassNotFoundException

buildProtobuf

public static Message buildProtobuf(java.lang.String msgName,
                                    byte[] encodedMsg)

Build a protobuf with the given message name

Parameters:

msgName - the message name corresponding to the the message associated with the given encoded message bytes

encodedMsg - the raw message byte array

Returns:

protobuf generated from the input message name and encoded byte array

buildProtobuf

public static Message buildProtobuf(java.lang.String msgName,
                                    JsonObject msgJson)

Build a protobuf with the given message name from the input json object

Parameters:

msgName - the message name corresponding to the the message associated with the given encoded message bytes

msgJson - a JsonObject describing the given protobuf

Returns:

protobuf generated from the input message name and encoded byte array

isResponseUpdate

public static boolean isResponseUpdate(Message responseMsg)

Checks if the response message is an update message

Parameters:

responseMsg - protobuf message to be checked

Returns:

True if response message is an update

getValueFromMessage

public static java.lang.Object getValueFromMessage(Message msg,
                                                   java.lang.String accessString)

Get a field value from protobuf message for example if you have a protomsg with format { meta { "id": "a5" "owner": { "name": "rado", "position": "OG" } } "color": "blue" } calling getValueFromMessage(msg, "color") will return "blue" and calling getValueFromMessage(msg, "meta.owner.name") will return "rado"

Parameters:

msg - the proto

accessString - a string that defines how to access the protomsg: use periods to separate embedded fields (see above example)

Returns:

The value of field as accessed through the accessString parameter. You must cast the Object to the appropriate return type. Returns null if the field does not exist.

parseCloudPaymentJsonToProto

public static CloudPaymentInitiated parseCloudPaymentJsonToProto(JsonObject paymentData,
                                                                 java.lang.String paymentDataId)

Parse data from a cloud payment to an appropriate protobuf message

Parameters:

paymentData -

paymentDataId -

Returns:

getAMQPConnectionURL

public static java.lang.String getAMQPConnectionURL()

Get the DDP AMQP connection URL Use Shared.set("dev_ddp_cloud_id", "id") and Shared.set("dev_ddp_cloud_key", "key") to set the AMQP credentials

Returns:

the DDP AMQP connection URL