com.microsoft.windowsazure.mobileservices.table.MobileServiceJsonTable.java Source code

Java tutorial

Introduction

Here is the source code for com.microsoft.windowsazure.mobileservices.table.MobileServiceJsonTable.java

Source

/*
Copyright (c) Microsoft Open Technologies, Inc.
All Rights Reserved
Apache 2.0 License
    
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at
    
 http://www.apache.org/licenses/LICENSE-2.0
    
   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
    
See the Apache Version 2.0 License for specific language governing permissions and limitations under the License.
 */

/**
 * MobileServiceJsonTable.java
 */
package com.microsoft.windowsazure.mobileservices.table;

import android.net.Uri;
import android.util.Pair;

import com.google.common.util.concurrent.FutureCallback;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
import com.google.common.util.concurrent.SettableFuture;
import com.google.gson.JsonArray;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonParser;
import com.microsoft.windowsazure.mobileservices.MobileServiceClient;
import com.microsoft.windowsazure.mobileservices.MobileServiceException;
import com.microsoft.windowsazure.mobileservices.MobileServiceFeatures;
import com.microsoft.windowsazure.mobileservices.http.HttpConstants;
import com.microsoft.windowsazure.mobileservices.http.MobileServiceConnection;
import com.microsoft.windowsazure.mobileservices.http.MobileServiceHttpClient;
import com.microsoft.windowsazure.mobileservices.http.RequestAsyncTask;
import com.microsoft.windowsazure.mobileservices.http.ServiceFilterRequest;
import com.microsoft.windowsazure.mobileservices.http.ServiceFilterRequestImpl;
import com.microsoft.windowsazure.mobileservices.http.ServiceFilterResponse;
import com.microsoft.windowsazure.mobileservices.table.query.ExecutableJsonQuery;
import com.microsoft.windowsazure.mobileservices.table.query.Query;
import com.microsoft.windowsazure.mobileservices.table.query.QueryODataWriter;
import com.microsoft.windowsazure.mobileservices.table.query.QueryOrder;
import com.squareup.okhttp.Headers;

import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.util.ArrayList;
import java.util.EnumSet;
import java.util.List;

/**
 * Represents a Mobile Service Table
 */
public final class MobileServiceJsonTable extends MobileServiceTableBase {

    /**
     * Constructor for MobileServiceJsonTable
     *
     * @param name   The name of the represented table
     * @param client The MobileServiceClient used to invoke table operations
     */
    public MobileServiceJsonTable(String name, MobileServiceClient client) {
        super(name, client);
        mFeatures.add(MobileServiceFeatures.UntypedTable);
    }

    /**
     * Updates the Version System Property in the Json Object with the ETag
     * information
     *
     * @param response The response containing the ETag Header
     * @param json     The JsonObject to modify
     */
    private static void updateVersionFromETag(ServiceFilterResponse response, JsonObject json) {
        if (response != null && response.getHeaders() != null) {
            String etag = response.getHeaders().get("ETag");

            if (etag != null) {
                json.remove(VersionSystemPropertyName);
                json.addProperty(VersionSystemPropertyName, getValueFromEtag(etag));
            }
        }
    }

    /**
     * Executes a query to retrieve all the table rows
     *
     * @throws MobileServiceException
     */
    public ListenableFuture<JsonElement> execute() throws MobileServiceException {
        return this.executeInternal();
    }

    /**
     * Executes a query to retrieve all the table rows
     *
     * @throws MobileServiceException
     */
    protected ListenableFuture<JsonElement> executeInternal() throws MobileServiceException {
        return this.execute(this.where());
    }

    /**
     * Executes the query
     *
     * @param callback Callback to invoke when the operation is completed
     * @throws MobileServiceException
     * @deprecated use {@link execute()} instead
     */
    public void execute(final TableJsonQueryCallback callback) throws MobileServiceException {
        this.where().execute(callback);
    }

    /**
     * Retrieves a set of rows from the table using a query
     *
     * @param query The query used to retrieve the rows
     */
    public ListenableFuture<JsonElement> execute(final Query query) {
        final SettableFuture<JsonElement> future = SettableFuture.create();

        String url = null;
        try {
            String filtersUrl = QueryODataWriter.getRowFilter(query);
            url = mClient.getAppUrl().toString() + TABLES_URL
                    + URLEncoder.encode(mTableName, MobileServiceClient.UTF8_ENCODING);

            if (filtersUrl.length() > 0) {
                url += "?$filter=" + filtersUrl + QueryODataWriter.getRowSetModifiers(query);
            } else {
                String rowSetModifiers = QueryODataWriter.getRowSetModifiers(query);

                if (rowSetModifiers.length() > 0) {
                    url += "?" + QueryODataWriter.getRowSetModifiers(query).substring(1);
                }
            }
        } catch (UnsupportedEncodingException e) {
            future.setException(e);
            return future;
        }

        EnumSet<MobileServiceFeatures> features = mFeatures.clone();
        if (query != null) {
            List<Pair<String, String>> userParameters = query.getUserDefinedParameters();
            if (userParameters != null && userParameters.size() > 0) {
                features.add(MobileServiceFeatures.AdditionalQueryParameters);
            }
        }

        return executeUrlQuery(url, features);
    }

    /**
     * Retrieves a set of rows using the Next Link Url (Continuation Token)
     *
     * @param nextLink The Next Link to make the request
     */
    public ListenableFuture<JsonElement> execute(final String nextLink) {
        final SettableFuture<JsonElement> future = SettableFuture.create();

        return executeUrlQuery(nextLink, mFeatures.clone());
    }

    /**
     * Make the request to the mobile service witht the query URL
     *
     * @param url The query url
     * @param features The features used in the request
     */
    private ListenableFuture<JsonElement> executeUrlQuery(final String url,
            EnumSet<MobileServiceFeatures> features) {
        final SettableFuture<JsonElement> future = SettableFuture.create();

        ListenableFuture<Pair<JsonElement, ServiceFilterResponse>> internalFuture = executeGetRecords(url,
                features);

        Futures.addCallback(internalFuture, new FutureCallback<Pair<JsonElement, ServiceFilterResponse>>() {
            @Override
            public void onFailure(Throwable exc) {
                future.setException(exc);
            }

            @Override
            public void onSuccess(Pair<JsonElement, ServiceFilterResponse> result) {

                String nextLinkHeaderValue = getHeaderValue(result.second.getHeaders(), "Link");

                if (nextLinkHeaderValue != null) {

                    JsonObject jsonResult = new JsonObject();

                    String nextLink = nextLinkHeaderValue.replace("; rel=next", "");

                    jsonResult.addProperty("nextLink", nextLink);
                    jsonResult.add("results", result.first);

                    future.set(jsonResult);

                } else {
                    future.set(result.first);
                }
            }
        });

        return future;
    }

    /**
     * Retrieves a set of rows from the table using a query
     *
     * @param query    The query used to retrieve the rows
     * @param callback Callback to invoke when the operation is completed
     * @deprecated use {@link execute(final Query query)} instead
     */
    public void execute(final Query query, final TableJsonQueryCallback callback) {
        ListenableFuture<JsonElement> executeFuture = execute(query);

        Futures.addCallback(executeFuture, new FutureCallback<JsonElement>() {
            @Override
            public void onFailure(Throwable exception) {
                if (exception instanceof Exception) {
                    callback.onCompleted(null, (Exception) exception,
                            MobileServiceException.getServiceResponse(exception));
                } else {
                    callback.onCompleted(null, new Exception(exception),
                            MobileServiceException.getServiceResponse(exception));
                }
            }

            @Override
            public void onSuccess(JsonElement result) {
                callback.onCompleted(result, null, null);
            }
        });
    }

    /**
     * Starts a filter to query the table
     *
     * @return The ExecutableJsonQuery representing the filter
     */
    public ExecutableJsonQuery where() {
        ExecutableJsonQuery query = new ExecutableJsonQuery();
        query.setTable(this);
        return query;
    }

    /**
     * Starts a filter to query the table with an existing filter
     *
     * @param query The existing filter
     * @return The ExecutableJsonQuery representing the filter
     */
    public ExecutableJsonQuery where(Query query) {
        if (query == null) {
            throw new IllegalArgumentException("Query must not be null");
        }

        ExecutableJsonQuery baseQuery = new ExecutableJsonQuery(query);
        baseQuery.setTable(this);
        return baseQuery;
    }

    /**
     * Adds a new user-defined parameter to the query
     *
     * @param parameter The parameter name
     * @param value     The parameter value
     * @return ExecutableJsonQuery
     */
    public ExecutableJsonQuery parameter(String parameter, String value) {
        return this.where().parameter(parameter, value);
    }

    /**
     * Creates a query with the specified order
     *
     * @param field Field name
     * @param order Sorting order
     * @return ExecutableJsonQuery
     */
    public ExecutableJsonQuery orderBy(String field, QueryOrder order) {
        return this.where().orderBy(field, order);
    }

    /**
     * Sets the number of records to return
     *
     * @param top Number of records to return
     * @return ExecutableQuery
     */
    public ExecutableJsonQuery top(int top) {
        return this.where().top(top);
    }

    /**
     * Sets the number of records to skip over a given number of elements in a
     * sequence and then return the remainder.
     *
     * @param skip
     * @return ExecutableJsonQuery
     */
    public ExecutableJsonQuery skip(int skip) {
        return this.where().skip(skip);
    }

    /**
     * Specifies the fields to retrieve
     *
     * @param fields Names of the fields to retrieve
     * @return ExecutableJsonQuery
     */
    public ExecutableJsonQuery select(String... fields) {
        return this.where().select(fields);
    }

    /**
     * Include a property with the number of records returned.
     *
     * @return ExecutableJsonQuery
     */
    public ExecutableJsonQuery includeInlineCount() {
        return this.where().includeInlineCount();
    }

    /**
     * Include the soft deleted records on the query result.
     *
     * @return ExecutableJsonQuery
     */
    public ExecutableJsonQuery includeDeleted() {
        return this.where().includeDeleted();
    }

    /**
     * Looks up a row in the table and retrieves its JSON value.
     *
     * @param id The id of the row
     */
    public ListenableFuture<JsonObject> lookUp(Object id) {
        return this.lookUp(id, (List<Pair<String, String>>) null);
    }

    /**
     * Looks up a row in the table and retrieves its JSON value.
     *
     * @param id       The id of the row
     * @param callback Callback to invoke after the operation is completed
     * @deprecated use {@link lookUp(Object id)} instead
     */
    public void lookUp(Object id, final TableJsonOperationCallback callback) {
        this.lookUp(id, null, callback);
    }

    /**
     * Looks up a row in the table and retrieves its JSON value.
     *
     * @param id         The id of the row
     * @param parameters A list of user-defined parameters and values to include in the
     *                   request URI query string
     */
    public ListenableFuture<JsonObject> lookUp(Object id, List<Pair<String, String>> parameters) {
        final SettableFuture<JsonObject> future = SettableFuture.create();

        try {
            validateId(id);
        } catch (Exception e) {
            future.setException(e);
            return future;
        }

        String url;

        Uri.Builder uriBuilder = Uri.parse(mClient.getAppUrl().toString()).buildUpon();
        uriBuilder.path(TABLES_URL);
        uriBuilder.appendPath(mTableName);
        uriBuilder.appendPath(id.toString());

        EnumSet<MobileServiceFeatures> features = mFeatures.clone();
        if (parameters != null && parameters.size() > 0) {
            features.add(MobileServiceFeatures.AdditionalQueryParameters);
        }

        if (parameters != null && parameters.size() > 0) {
            for (Pair<String, String> parameter : parameters) {
                uriBuilder.appendQueryParameter(parameter.first, parameter.second);
            }
        }

        url = uriBuilder.build().toString();

        ListenableFuture<Pair<JsonElement, ServiceFilterResponse>> internalFuture = executeGetRecords(url,
                features);

        Futures.addCallback(internalFuture, new FutureCallback<Pair<JsonElement, ServiceFilterResponse>>() {
            @Override
            public void onFailure(Throwable exc) {
                future.setException(exc);
            }

            @Override
            public void onSuccess(Pair<JsonElement, ServiceFilterResponse> results) {
                if (results.first.isJsonArray()) {
                    // empty result
                    future.setException(new MobileServiceException("A record with the specified Id cannot be found",
                            results.second));
                } else {
                    // Lookup result
                    JsonObject patchedJson = results.first.getAsJsonObject();

                    updateVersionFromETag(results.second, patchedJson);

                    future.set(patchedJson);
                }
            }
        });

        return future;
    }

    /**
     * Looks up a row in the table and retrieves its JSON value.
     *
     * @param id         The id of the row
     * @param parameters A list of user-defined parameters and values to include in the
     *                   request URI query string
     * @param callback   Callback to invoke after the operation is completed
     * @deprecated use {@link lookUp(Object id, List<Pair<String, String>>
     * parameters)} instead
     */
    public void lookUp(Object id, List<Pair<String, String>> parameters,
            final TableJsonOperationCallback callback) {
        ListenableFuture<JsonObject> lookUpFuture = lookUp(id, parameters);

        Futures.addCallback(lookUpFuture, new FutureCallback<JsonObject>() {
            @Override
            public void onFailure(Throwable exception) {
                if (exception instanceof Exception) {
                    callback.onCompleted(null, (Exception) exception,
                            MobileServiceException.getServiceResponse(exception));
                } else {
                    callback.onCompleted(null, new Exception(exception),
                            MobileServiceException.getServiceResponse(exception));
                }
            }

            @Override
            public void onSuccess(JsonObject result) {
                callback.onCompleted(result, null, null);
            }
        });
    }

    /**
     * Inserts a JsonObject into a Mobile Service table
     *
     * @param element The JsonObject to insert
     * @throws IllegalArgumentException if the element has an id property set with a numeric value
     *                                  other than default (0), or an invalid string value
     */
    public ListenableFuture<JsonObject> insert(final JsonObject element) {
        return this.insert(element, (List<Pair<String, String>>) null);
    }

    /**
     * Inserts a JsonObject into a Mobile Service table
     *
     * @param element  The JsonObject to insert
     * @param callback Callback to invoke when the operation is completed
     * @throws IllegalArgumentException if the element has an id property set with a numeric value
     *                                  other than default (0), or an invalid string value
     * @deprecated use {@link insert(final JsonObject element)} instead
     */
    public void insert(final JsonObject element, TableJsonOperationCallback callback) {
        this.insert(element, null, callback);
    }

    /**
     * Inserts a JsonObject into a Mobile Service Table
     *
     * @param element    The JsonObject to insert
     * @param parameters A list of user-defined parameters and values to include in the
     *                   request URI query string
     * @throws IllegalArgumentException if the element has an id property set with a numeric value
     *                                  other than default (0), or an invalid string value
     */
    public ListenableFuture<JsonObject> insert(final JsonObject element, List<Pair<String, String>> parameters) {
        final SettableFuture<JsonObject> future = SettableFuture.create();

        try {
            validateIdOnInsert(element);
        } catch (Exception e) {
            future.setException(e);
            return future;
        }

        String content = element.toString();

        EnumSet<MobileServiceFeatures> features = mFeatures.clone();
        if (parameters != null && parameters.size() > 0) {
            features.add(MobileServiceFeatures.AdditionalQueryParameters);
        }

        ListenableFuture<Pair<JsonObject, ServiceFilterResponse>> internalFuture = this.executeTableOperation(
                TABLES_URL + mTableName, content, HttpConstants.PostMethod, null, parameters, features);

        Futures.addCallback(internalFuture, new FutureCallback<Pair<JsonObject, ServiceFilterResponse>>() {
            @Override
            public void onFailure(Throwable exc) {
                future.setException(exc);
            }

            @Override
            public void onSuccess(Pair<JsonObject, ServiceFilterResponse> result) {

                if (result == null) {
                    future.set(null);
                } else {
                    JsonObject patchedJson = patchOriginalEntityWithResponseEntity(element, result.first);

                    updateVersionFromETag(result.second, patchedJson);

                    future.set(patchedJson);
                }
            }
        });

        return future;
    }

    /**
     * Inserts a JsonObject into a Mobile Service Table
     *
     * @param element    The JsonObject to insert
     * @param parameters A list of user-defined parameters and values to include in the
     *                   request URI query string
     * @param callback   Callback to invoke when the operation is completed
     * @throws IllegalArgumentException if the element has an id property set with a numeric value
     *                                  other than default (0), or an invalid string value
     * @deprecated use {@link insert(final JsonObject element, List<Pair<String,
     * String>> parameters)} instead
     */
    public void insert(final JsonObject element, List<Pair<String, String>> parameters,
            final TableJsonOperationCallback callback) {
        ListenableFuture<JsonObject> insertFuture = insert(element, parameters);

        Futures.addCallback(insertFuture, new FutureCallback<JsonObject>() {
            @Override
            public void onFailure(Throwable exception) {
                if (exception instanceof Exception) {
                    callback.onCompleted(null, (Exception) exception,
                            MobileServiceException.getServiceResponse(exception));
                } else {
                    callback.onCompleted(null, new Exception(exception),
                            MobileServiceException.getServiceResponse(exception));
                }
            }

            @Override
            public void onSuccess(JsonObject result) {
                callback.onCompleted(result, null, null);
            }
        });
    }

    /**
     * Updates an element from a Mobile Service Table
     *
     * @param element The JsonObject to update
     */
    public ListenableFuture<JsonObject> update(final JsonObject element) {
        return this.update(element, (List<Pair<String, String>>) null);
    }

    /**
     * Updates an element from a Mobile Service Table
     *
     * @param element  The JsonObject to update
     * @param callback Callback to invoke when the operation is completed
     * @deprecated use {@link update(final JsonObject element)} instead
     */
    public void update(final JsonObject element, final TableJsonOperationCallback callback) {
        this.update(element, null, callback);
    }

    /**
     * Updates an element from a Mobile Service Table
     *
     * @param element    The JsonObject to update
     * @param parameters A list of user-defined parameters and values to include in the
     *                   request URI query string
     */
    public ListenableFuture<JsonObject> update(final JsonObject element, List<Pair<String, String>> parameters) {
        final SettableFuture<JsonObject> future = SettableFuture.create();

        Object id = null;
        String version = null;
        String content = null;

        try {
            id = validateId(element);
        } catch (Exception e) {
            future.setException(e);
            return future;
        }

        if (!isNumericType(id)) {
            version = getVersionSystemProperty(element);
            content = removeSystemProperties(element).toString();
        } else {
            content = element.toString();
        }

        EnumSet<MobileServiceFeatures> features = mFeatures.clone();
        if (parameters != null && parameters.size() > 0) {
            features.add(MobileServiceFeatures.AdditionalQueryParameters);
        }

        List<Pair<String, String>> requestHeaders = null;
        if (version != null) {
            requestHeaders = new ArrayList<Pair<String, String>>();
            requestHeaders.add(new Pair<String, String>("If-Match", getEtagFromValue(version)));
            features.add(MobileServiceFeatures.OpportunisticConcurrency);
        }

        ListenableFuture<Pair<JsonObject, ServiceFilterResponse>> internalFuture = this.executeTableOperation(
                TABLES_URL + mTableName + "/" + id.toString(), content, HttpConstants.PatchMethod, requestHeaders,
                parameters, features);

        Futures.addCallback(internalFuture, new FutureCallback<Pair<JsonObject, ServiceFilterResponse>>() {
            @Override
            public void onFailure(Throwable exc) {
                future.setException(exc);
            }

            @Override
            public void onSuccess(Pair<JsonObject, ServiceFilterResponse> result) {
                JsonObject patchedJson = patchOriginalEntityWithResponseEntity(element, result.first);

                updateVersionFromETag(result.second, patchedJson);

                future.set(patchedJson);
            }
        });

        return future;
    }

    /**
     * Updates an element from a Mobile Service Table
     *
     * @param element    The JsonObject to update
     * @param parameters A list of user-defined parameters and values to include in the
     *                   request URI query string
     * @param callback   Callback to invoke when the operation is completed
     * @deprecated use {@link update(final com.google.gson.JsonObject element, java.util.List< android.util.Pair<String,
     * String>> parameters)} instead
     */
    public void update(final JsonObject element, List<Pair<String, String>> parameters,
            final TableJsonOperationCallback callback) {
        ListenableFuture<JsonObject> updateFuture = update(element, parameters);

        Futures.addCallback(updateFuture, new FutureCallback<JsonObject>() {
            @Override
            public void onFailure(Throwable exception) {
                if (exception instanceof Exception) {
                    callback.onCompleted(null, (Exception) exception,
                            MobileServiceException.getServiceResponse(exception));
                } else {
                    callback.onCompleted(null, new Exception(exception),
                            MobileServiceException.getServiceResponse(exception));
                }
            }

            @Override
            public void onSuccess(JsonObject result) {
                callback.onCompleted(result, null, null);
            }
        });
    }

    /**
     * Delete an element from a Mobile Service Table
     *
     * @param element The JsonObject to delete
     */
    public ListenableFuture<Void> delete(JsonObject element) {
        return this.delete(element, (List<Pair<String, String>>) null);
    }

    /**
     * Delete an element from a Mobile Service Table
     *
     * @param element  The JsonObject to delete
     * @param callback Callback to invoke when the operation is completed
     * @deprecated use {@link update(final JsonObject element)} instead
     */
    public void delete(JsonObject element, TableDeleteCallback callback) {
        this.delete(element, null, callback);
    }

    /**
     * Delete an element from a Mobile Service Table
     *
     * @param element    The JsonObject to undelete
     * @param parameters A list of user-defined parameters and values to include in the
     *                   request URI query string
     */
    public ListenableFuture<Void> delete(JsonObject element, List<Pair<String, String>> parameters) {

        validateId(element);

        final SettableFuture<Void> future = SettableFuture.create();

        Object id = null;
        String version = null;

        try {
            id = validateId(element);
        } catch (Exception e) {
            future.setException(e);
            return future;
        }

        if (!isNumericType(id)) {
            version = getVersionSystemProperty(element);
        }

        EnumSet<MobileServiceFeatures> features = mFeatures.clone();
        if (parameters != null && parameters.size() > 0) {
            features.add(MobileServiceFeatures.AdditionalQueryParameters);
        }

        List<Pair<String, String>> requestHeaders = null;
        if (version != null) {
            requestHeaders = new ArrayList<Pair<String, String>>();
            requestHeaders.add(new Pair<String, String>("If-Match", getEtagFromValue(version)));
            features.add(MobileServiceFeatures.OpportunisticConcurrency);
        }

        ListenableFuture<Pair<JsonObject, ServiceFilterResponse>> internalFuture = this.executeTableOperation(
                TABLES_URL + mTableName + "/" + id.toString(), null, HttpConstants.DeleteMethod, requestHeaders,
                parameters, features);

        Futures.addCallback(internalFuture, new FutureCallback<Pair<JsonObject, ServiceFilterResponse>>() {
            @Override
            public void onFailure(Throwable exc) {
                future.setException(exc);
            }

            @Override
            public void onSuccess(Pair<JsonObject, ServiceFilterResponse> result) {
                future.set(null);
            }
        });

        return future;
    }

    /**
     * Delete an element from a Mobile Service Table
     *
     * @param element    The JsonObject to undelete
     * @param parameters A list of user-defined parameters and values to include in the
     *                   request URI query string
     * @param callback   Callback to invoke when the operation is completed
     * @deprecated use {@link update(final com.google.gson.JsonObject element, java.util.List< android.util.Pair<String,
     * String>> parameters)} instead
     */
    public void delete(final JsonObject element, List<Pair<String, String>> parameters,
            final TableDeleteCallback callback) {
        ListenableFuture<Void> deleteFuture = delete(element, parameters);

        Futures.addCallback(deleteFuture, new FutureCallback<Void>() {
            @Override
            public void onFailure(Throwable exception) {
                if (exception instanceof Exception) {
                    callback.onCompleted((Exception) exception,
                            MobileServiceException.getServiceResponse(exception));
                } else {
                    callback.onCompleted(new Exception(exception),
                            MobileServiceException.getServiceResponse(exception));
                }
            }

            @Override
            public void onSuccess(Void v) {
                callback.onCompleted(null, null);
            }
        });
    }

    /**
     * Undelete an element from a Mobile Service Table
     *
     * @param element The JsonObject to update
     */
    public ListenableFuture<JsonObject> undelete(final JsonObject element) {
        return this.undelete(element, (List<Pair<String, String>>) null);
    }

    /**
     * Undelete an element from a Mobile Service Table
     *
     * @param element  The JsonObject to update
     * @param callback Callback to invoke when the operation is completed
     * @deprecated use {@link update(final com.google.gson.JsonObject element)} instead
     */
    public void undelete(final JsonObject element, final TableJsonOperationCallback callback) {
        this.undelete(element, null, callback);
    }

    /**
     * Undelete an element from a Mobile Service Table
     *
     * @param element    The JsonObject to undelete
     * @param parameters A list of user-defined parameters and values to include in the
     *                   request URI query string
     */
    public ListenableFuture<JsonObject> undelete(final JsonObject element, List<Pair<String, String>> parameters) {
        final SettableFuture<JsonObject> future = SettableFuture.create();

        Object id = null;
        String version = null;

        try {
            id = validateId(element);
        } catch (Exception e) {
            future.setException(e);
            return future;
        }

        if (!isNumericType(id)) {
            version = getVersionSystemProperty(element);
        }

        EnumSet<MobileServiceFeatures> features = mFeatures.clone();
        if (parameters != null && parameters.size() > 0) {
            features.add(MobileServiceFeatures.AdditionalQueryParameters);
        }

        List<Pair<String, String>> requestHeaders = null;
        if (version != null) {
            requestHeaders = new ArrayList<Pair<String, String>>();
            requestHeaders.add(new Pair<String, String>("If-Match", getEtagFromValue(version)));
            features.add(MobileServiceFeatures.OpportunisticConcurrency);
        }

        ListenableFuture<Pair<JsonObject, ServiceFilterResponse>> internalFuture = this.executeTableOperation(
                TABLES_URL + mTableName + "/" + id.toString(), null, HttpConstants.PostMethod, requestHeaders,
                parameters, features);

        Futures.addCallback(internalFuture, new FutureCallback<Pair<JsonObject, ServiceFilterResponse>>() {
            @Override
            public void onFailure(Throwable exc) {
                future.setException(exc);
            }

            @Override
            public void onSuccess(Pair<JsonObject, ServiceFilterResponse> result) {
                JsonObject patchedJson = patchOriginalEntityWithResponseEntity(element, result.first);

                updateVersionFromETag(result.second, patchedJson);

                future.set(patchedJson);
            }
        });

        return future;
    }

    /**
     * Undeete an element from a Mobile Service Table
     *
     * @param element    The JsonObject to undelete
     * @param parameters A list of user-defined parameters and values to include in the
     *                   request URI query string
     * @param callback   Callback to invoke when the operation is completed
     * @deprecated use {@link update(final com.google.gson.JsonObject element, java.util.List< android.util.Pair<String,
     * String>> parameters)} instead
     */
    public void undelete(final JsonObject element, List<Pair<String, String>> parameters,
            final TableJsonOperationCallback callback) {
        ListenableFuture<JsonObject> undeleteFuture = undelete(element, parameters);

        Futures.addCallback(undeleteFuture, new FutureCallback<JsonObject>() {
            @Override
            public void onFailure(Throwable exception) {
                if (exception instanceof Exception) {
                    callback.onCompleted(null, (Exception) exception,
                            MobileServiceException.getServiceResponse(exception));
                } else {
                    callback.onCompleted(null, new Exception(exception),
                            MobileServiceException.getServiceResponse(exception));
                }
            }

            @Override
            public void onSuccess(JsonObject result) {
                callback.onCompleted(result, null, null);
            }
        });
    }

    /**
     * Executes the query against the table
     *
     * @param request        Request to execute
     * @param content        The content of the request body
     * @param httpMethod     The method of the HTTP request
     * @param requestHeaders Additional request headers used in the HTTP request
     * @param parameters     A list of user-defined parameters and values to include in the
     *                       request URI query string
     * @param features       The features used in the request
     */
    private ListenableFuture<Pair<JsonObject, ServiceFilterResponse>> executeTableOperation(String path,
            String content, String httpMethod, List<Pair<String, String>> requestHeaders,
            List<Pair<String, String>> parameters, EnumSet<MobileServiceFeatures> features) {
        final SettableFuture<Pair<JsonObject, ServiceFilterResponse>> future = SettableFuture.create();

        MobileServiceHttpClient httpClient = new MobileServiceHttpClient(mClient);
        if (requestHeaders == null) {
            requestHeaders = new ArrayList<Pair<String, String>>();
        }

        if (content != null) {
            requestHeaders.add(
                    new Pair<String, String>(HttpConstants.ContentType, MobileServiceConnection.JSON_CONTENTTYPE));
        }

        ListenableFuture<ServiceFilterResponse> internalFuture = httpClient.request(path, content, httpMethod,
                requestHeaders, parameters, features);

        Futures.addCallback(internalFuture, new FutureCallback<ServiceFilterResponse>() {
            @Override
            public void onFailure(Throwable exc) {
                future.setException(transformHttpException(exc));
            }

            @Override
            public void onSuccess(ServiceFilterResponse result) {
                String content = null;
                content = result.getContent();

                if (content == null) {
                    future.set(null);
                } else {

                    if (content != null && !content.isEmpty()) {
                        JsonObject newEntityJson = new JsonParser().parse(content).getAsJsonObject();
                        future.set(Pair.create(newEntityJson, result));
                    } else {
                        future.set(null);
                    }

                }
            }
        });

        return future;
    }

    /**
     * Retrieves a set of rows from using the specified URL
     *
     * @param query    The URL used to retrieve the rows
     * @param features The features used in this request
     */
    private ListenableFuture<Pair<JsonElement, ServiceFilterResponse>> executeGetRecords(final String url,
            EnumSet<MobileServiceFeatures> features) {
        final SettableFuture<Pair<JsonElement, ServiceFilterResponse>> future = SettableFuture.create();

        ServiceFilterRequest request = ServiceFilterRequestImpl.get(mClient.getOkHttpClientFactory(), url);

        String featuresHeader = MobileServiceFeatures.featuresToString(features);
        if (featuresHeader != null) {
            request.addHeader(MobileServiceHttpClient.X_ZUMO_FEATURES, featuresHeader);
        }

        MobileServiceConnection conn = mClient.createConnection();
        // Create AsyncTask to execute the request and parse the results
        new RequestAsyncTask(request, conn) {
            @Override
            protected void onPostExecute(ServiceFilterResponse response) {
                if (mTaskException == null && response != null) {
                    JsonElement results = null;

                    try {
                        // Parse the results using the given Entity class
                        String content = response.getContent();
                        JsonElement json = new JsonParser().parse(content);

                        results = json;

                        future.set(Pair.create(results, response));
                    } catch (Exception e) {
                        future.setException(new MobileServiceException("Error while retrieving data from response.",
                                e, response));
                    }
                } else {
                    future.setException(mTaskException);
                }
            }
        }.executeTask();

        return future;
    }

    private String getHeaderValue(Headers headers, String headerName) {

        if (headers == null) {
            return null;
        }

        return headers.get(headerName);
    }

    /**
     * Validates the Id property from a JsonObject on an Insert Action
     *
     * @param json The JsonObject to modify
     */
    private Object validateIdOnInsert(final JsonObject json) {
        // Remove id property if exists
        String[] idPropertyNames = new String[] { "id", "Id", "iD", "ID" };

        for (int i = 0; i < 4; i++) {
            String idProperty = idPropertyNames[i];

            if (json.has(idProperty)) {
                JsonElement idElement = json.get(idProperty);

                if (isStringType(idElement)) {
                    String id = getStringValue(idElement);

                    if (!isValidStringId(id)) {
                        throw new IllegalArgumentException(
                                "The entity to insert has an invalid string value on " + idProperty + " property.");
                    }

                    return id;
                } else if (isNumericType(idElement)) {
                    long id = getNumericValue(idElement);

                    if (!isDefaultNumericId(id)) {
                        throw new IllegalArgumentException("The entity to insert should not have a numeric "
                                + idProperty + " property defined.");
                    }

                    json.remove(idProperty);

                    return id;

                } else if (idElement.isJsonNull()) {
                    json.remove(idProperty);

                    return null;

                } else {
                    throw new IllegalArgumentException("The entity to insert should not have an " + idProperty
                            + " defined with an invalid value");
                }
            }
        }

        return null;
    }

}