Android Open Source - force_analytics_example Rest Response

• Back to Development/api  ↑

From Project

Back to project page force_analytics_example.

License

The source code is released under:

Copyright (c) 2011, salesforce.com, inc. All rights reserved. ======================================== Redistribution and use of this software in source and binary forms, with or without modificatio...

Java Source Code

/*
 * Copyright (c) 2012, salesforce.com, inc.
 * All rights reserved.//from  ww  w . jav a 2s  .  c  om
 * Redistribution and use of this software in source and binary forms, with or
 * without modification, are permitted provided that the following conditions
 * are met:
 * - Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * - Neither the name of salesforce.com, inc. nor the names of its contributors
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission of salesforce.com, inc.
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package com.salesforce.androidsdk.rest;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

import org.apache.http.Header;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.HttpStatus;
import org.apache.http.ParseException;
import org.apache.http.protocol.HTTP;
import org.apache.http.util.EntityUtils;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;

import android.util.Log;

import com.android.volley.NetworkResponse;


/**
 * RestResponse: Class to represent any REST response.
 * 
 */
public class RestResponse {
  
  private final int statusCode;
  private final HttpResponse response;

  // Populated when "consume" is called
  private byte[] responseAsBytes;
  private String responseCharSet;

  // Lazily computed
  private String responseAsString;
  private JSONObject responseAsJSONObject;
  private JSONArray responseAsJSONArray;
  private Map<String, String> headers;

  /**
   * Constructor (used by the sendSync() call).
   *
   * @param response HttpResponse object.
   */
  public RestResponse(HttpResponse response) {
    this.response = response;
    this.statusCode = response.getStatusLine().getStatusCode();
    final Header[] responseHeaders = response.getAllHeaders();
    this.headers = new HashMap<String, String>();
    if (responseHeaders != null) {
      for (int i = 0; i < responseHeaders.length; i++) {
        if (responseHeaders[i] != null) {
          this.headers.put(responseHeaders[i].getName(),
              responseHeaders[i].getValue());
        }
      }
    }
  }

  /**
   * Constructor (used by the sendAsync() call).
   *
   * @param response NetworkResponse object.
   */
  public RestResponse(NetworkResponse response) {
    this.response = null;
    this.statusCode = response.statusCode;
    this.responseAsBytes = response.data;
    this.headers = response.headers;
  }

  /**
   * Returns all headers associated with this response.
   *
   * @return Map containing all headers.
   */
  public Map<String, String> getAllHeaders() {
    return headers;
  }

  /**
   * @return HTTP status code of the response
   */
  public int getStatusCode() {
    return statusCode; 
  }

  /**
   * @return true for response with 2xx status codes
   */
  public boolean isSuccess() {
    // 2xx success
    return (statusCode >= HttpStatus.SC_OK && statusCode < HttpStatus.SC_MULTIPLE_CHOICES);
  }

  /**
   * Fully consume response entity content and closes content stream
   * Must be called before returning control to the UI thread
   * @throws IOException 
   */
  public void consume() throws IOException {
    if (responseAsBytes != null) {
      // already consumed
      return;      
    }
    HttpEntity entity = null;
    if (response != null) {
      entity = response.getEntity();
    }
    if (entity != null) {
      responseCharSet = EntityUtils.getContentCharSet(entity);    
      responseAsBytes = EntityUtils.toByteArray(entity);
    } else {
      responseAsBytes = new byte[0];
    }
  }

  /**
   * @return byte[] for entire response
   * @throws IOException
   */
  public byte[] asBytes() throws IOException {
    if (responseAsBytes == null) {
      consume();
    }
    return responseAsBytes;
  }

  /**
   * String is built the first time the method is called.
   *
   * @return string for entire response
   * @throws ParseException
   * @throws IOException
   */
  public String asString() throws ParseException, IOException {
    if (responseAsString == null) {
      responseAsString = new String(asBytes(), (responseCharSet == null ? HTTP.UTF_8 : responseCharSet));
    }
    return responseAsString;
  }

  /**
   * JSONObject is built the first time the method is called.
   *
   * @return JSONObject for response
   * @throws ParseException
   * @throws JSONException
   * @throws IOException
   */
  public JSONObject asJSONObject() throws ParseException, JSONException, IOException {
    if (responseAsJSONObject == null) {
      responseAsJSONObject = new JSONObject(asString());
    }
    return responseAsJSONObject;
  }

  /**
   * JSONArray is built the first time the method is called.
   *
   * @return JSONObject for response
   * @throws ParseException
   * @throws JSONException
   * @throws IOException
   */
  public JSONArray asJSONArray() throws ParseException, JSONException, IOException {
    if (responseAsJSONArray == null) {
      responseAsJSONArray = new JSONArray(asString());
    }
    return responseAsJSONArray;
  }

  @Override
  public String toString() {
    try {
      return asString();
    } catch (Exception e) {
      Log.e("RestResponse: toString()", "Exception caught while calling asString()", e);
      return ((response == null) ? "" : response.toString());
    }
  }
}

Java Source Code List

• Back to Development/api  ↑