com.braze.support

Class ValidationUtils

java.lang.Object

com.braze.support.ValidationUtils

Direct Known Subclasses:

ValidationUtils

public class ValidationUtils
extends java.lang.Object

Useful validation methods for checking user input.

Field Summary

Fields

Modifier and Type	Field and Description
static int	APPBOY_STRING_MAX_LENGTH

Constructor Summary

Constructors

Constructor and Description
ValidationUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	ensureBrazeFieldLength(java.lang.String field)
static boolean	isValidEmailAddress(java.lang.String emailAddress) Validates an email address.
static boolean	isValidLocation(double latitude, double longitude)
static boolean	isValidLogCustomEventInput(java.lang.String eventName, ServerConfigStorageProvider serverConfigStorageProvider) Validates the event name for the custom event.
static boolean	isValidLogPurchaseInput(java.lang.String productId, java.lang.String currencyCode, java.math.BigDecimal price, int quantity, ServerConfigStorageProvider serverConfigStorageProvider) Validates the log purchase event parameters.
static boolean	isValidPhoneNumber(java.lang.String phoneNumber) Performs basic validation on input string.
static boolean	isValidPushStoryClickInput(java.lang.String campaignId, java.lang.String pageId) Validates the campaign id and page id for the push story click.

Methods inherited from class java.lang.Object

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

Field Detail

APPBOY_STRING_MAX_LENGTH

public static final int APPBOY_STRING_MAX_LENGTH

See Also:

Constant Field Values

Constructor Detail

ValidationUtils

public ValidationUtils()

Method Detail

isValidEmailAddress

public static boolean isValidEmailAddress(java.lang.String emailAddress)

Validates an email address. Note that passing this stage of validation allows an email address to be sent to Braze server, which may perform additional validation.

Parameters:

emailAddress - string representing email address

Returns:

Whether or not the email address passes the validation check

See Also:

EMAIL_ADDRESS_REGEX, EMAIL_ADDRESS_MAX_LENGTH

isValidPhoneNumber

public static boolean isValidPhoneNumber(java.lang.String phoneNumber)

Performs basic validation on input string. A phone number is considered valid if it contains only numbers, whitespace, and the following special characters +.-()

Returns:

a boolean representing whether or not the phone number passes validation

ensureBrazeFieldLength

public static java.lang.String ensureBrazeFieldLength(java.lang.String field)

Parameters:

field -

Returns:

If the field is longer than the maximum allowed length, return a truncated field. Else return the field.

isValidLogPurchaseInput

public static boolean isValidLogPurchaseInput(java.lang.String productId,
                                              java.lang.String currencyCode,
                                              java.math.BigDecimal price,
                                              int quantity,
                                              ServerConfigStorageProvider serverConfigStorageProvider)

Validates the log purchase event parameters.

Parameters:

productId - The product Id. Must be non-empty and not in the blocklist.

currencyCode - The currency code. Must be non-empty and in the list of VALID_CURRENCY_CODES.

price - The price. Must not be null.

quantity - The quantity of purchases. Must be 1 or greater.

serverConfigStorageProvider - The server configuration. Used to check against blocklisted purchases.

Returns:

true if all log purchase event parameters are valid.

isValidLogCustomEventInput

public static boolean isValidLogCustomEventInput(java.lang.String eventName,
                                                 ServerConfigStorageProvider serverConfigStorageProvider)

Validates the event name for the custom event. Invalid event names are null or in the blocklist.

Parameters:

eventName - The event name.

serverConfigStorageProvider - The server configuration. Used to check against blocklisted events.

Returns:

true if the event name is valid. Checks against blocklisted events.

isValidPushStoryClickInput

public static boolean isValidPushStoryClickInput(java.lang.String campaignId,
                                                 java.lang.String pageId)

Validates the campaign id and page id for the push story click. Neither can be null or blank.

Parameters:

campaignId - The campaign id.

pageId - The page id.

Returns:

true if both the campaign id and page id are valid.

isValidLocation

public static boolean isValidLocation(double latitude,
                                      double longitude)

Returns:

True if latitude in range (-90, 90) and longitude in range (-180, 180)