com.parse4cn1

Class Parse

java.lang.Object

com.parse4cn1.Parse

public class Parse
extends java.lang.Object

The Parse class contains static functions, classes and interfaces that handle global configuration for the Parse library.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Parse.DefaultParseObjectFactory A factory for instantiating reserved Parse Object classes such as users, roles, installations and sessions.
static class	Parse.EPlatform
static interface	Parse.IParseObjectFactory A factory for instantiating ParseObjects of various concrete types
static interface	Parse.IPersistable An interface for a persistable entity.

Constructor Summary

Constructors

Constructor and Description
Parse()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	encodeDate(java.util.Date date) Encodes the provided date in the format required by Parse.
static java.lang.String	getApiEndpoint() Retrieves the Parse API endpoint without a trailing '/'.
static java.lang.String	getApplicationId()
static java.lang.String	getClientKey()
static java.lang.String	getParseAPIUrl(java.lang.String endPoint) Creates a valid Parse REST API URL using the predefined apiEndpoint provided in initialize(java.lang.String, java.lang.String, java.lang.String).
static Parse.EPlatform	getPlatform() Retrieves the current platform
static int	getSerializationVersion() Retrieves the default ID to be used for serialization of objects.
static void	initialize(java.lang.String apiEndpoint, java.lang.String applicationId, java.lang.String clientKey) Authenticates this client as belonging to your application.
static boolean	isEmpty(java.lang.String str)
static boolean	isInitialized() Checks if the library has been initialized.
static boolean	isReservedEndPoint(java.lang.String endPoint) Checks if the provided endPoint is the name of an in-built Parse end point, for examples (users and /classes/_User).
static boolean	isReservedKey(java.lang.String key) Checks if the provided key is a key with a special meaning in Parse, for example objectId.
static boolean	isValidType(java.lang.Object value) Checks if the provided type is a valid type for a Parse Object or any one of its fields.
static java.lang.String	join(java.util.Collection<java.lang.String> items, java.lang.String delimiter) Utility to concatenate the strings in items using the provided delimieter.
static java.util.Date	parseDate(java.lang.String dateString) Converts a Parse date string value into a Date object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Parse

public Parse()

Method Detail

getPlatform

public static Parse.EPlatform getPlatform()

Retrieves the current platform

Returns:

A literal matching the current platform or Parse.EPlatform.UNKNOWN

initialize

public static void initialize(java.lang.String apiEndpoint,
                              java.lang.String applicationId,
                              java.lang.String clientKey)

Authenticates this client as belonging to your application.

It also initializes internal state required for the library to function properly, e.g., enabling persistence to CN1 storage.

This method must be called before your application can use the Parse library. The recommended way is to put a call to Parse.initialize in your CN1 Application's state machine as follows:

 
 public class StateMachine extends StateMachineBase {
   protected void initVars(Resources res) {
     Parse.initialize(API_ENDPOINT, APP_ID, APP_REST_API_ID);
   }
 }
 
 

Parameters:

apiEndpoint - The path to the Parse backend, e.g. "your_parse_backend_website_url"/parse.

applicationId - The application id of your parse backend.

clientKey - The client key of your parse backend if applicable. If not, pass null and it will be ignored.

Note: Developers are advised to use the CLIENT KEY instead of using the REST API in production code (cf. https://parse.com/docs/rest#general-callfromclient). Hence, the latter is not exposed via this library. The same security consideration explains why the MASTER KEY is not exposed either.

getApiEndpoint

public static java.lang.String getApiEndpoint()

Retrieves the Parse API endpoint without a trailing '/'.

Returns:

The Parse backend API endpoint if one has been set or null.

See Also:

initialize(java.lang.String, java.lang.String, java.lang.String)

getApplicationId

public static java.lang.String getApplicationId()

Returns:

The application ID if one has been set or null.

See Also:

initialize(java.lang.String, java.lang.String, java.lang.String)

getClientKey

public static java.lang.String getClientKey()

Returns:

The client key if one has been set or null.

See Also:

initialize(java.lang.String, java.lang.String, java.lang.String)

isInitialized

public static boolean isInitialized()

Checks if the library has been initialized.

Note: The optional client key (cf. getClientKey()) is no longer taken into account.

Returns:

true if the library has been initialized; otherwise, returns false.

See Also:

initialize(java.lang.String, java.lang.String, java.lang.String)

getParseAPIUrl

public static java.lang.String getParseAPIUrl(java.lang.String endPoint)

Creates a valid Parse REST API URL using the predefined apiEndpoint provided in initialize(java.lang.String, java.lang.String, java.lang.String).

Parameters:

endPoint - The target endpoint/class name.

Returns:

The created URL.

encodeDate

public static java.lang.String encodeDate(java.util.Date date)

Encodes the provided date in the format required by Parse.

Parameters:

date - The date to be encoded.

Returns:

date expressed in the format required by Parse.

See Also:

Parse date type.

parseDate

public static java.util.Date parseDate(java.lang.String dateString)

Converts a Parse date string value into a Date object.

Parameters:

dateString - A string matching the Parse date type.

Returns:

The date object corresponding to dateString.

See Also:

Parse date type.

isReservedKey

public static boolean isReservedKey(java.lang.String key)

Checks if the provided key is a key with a special meaning in Parse, for example objectId.

Parameters:

key - The key to be checked.

Returns:

true if and only if key is a reserved key.

isReservedEndPoint

public static boolean isReservedEndPoint(java.lang.String endPoint)

Checks if the provided endPoint is the name of an in-built Parse end point, for examples (users and /classes/_User).

Parameters:

endPoint - The endpoint to be checked.

Returns:

true if endPoint is a reserved class end point.

isValidType

public static boolean isValidType(java.lang.Object value)

Checks if the provided type is a valid type for a Parse Object or any one of its fields.

Parameters:

value - The object to be checked

Returns:

true if value is valid as per the data types supported by ParseObjects and their child fields.

join

public static java.lang.String join(java.util.Collection<java.lang.String> items,
                                    java.lang.String delimiter)

Utility to concatenate the strings in items using the provided delimieter.

Parameters:

items - The strings to be concatenated.

delimiter - The delimiter.

Returns:

The concatenated string.

isEmpty

public static boolean isEmpty(java.lang.String str)

getSerializationVersion

public static int getSerializationVersion()

Retrieves the default ID to be used for serialization of objects.

Returns:

A default serialization id (=1).

See Also:

Externalizable.getVersion()