com.google.api.client.http.UrlEncodedContent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-client Show documentation

Google API Client Library for Java. Supports Java 5 (or higher) desktop (SE) and web (EE), Android, and Google App Engine.

There is a newer version: 1.4.1-beta

Show newest version

/*
 * Copyright (c) 2010 Google Inc.
 * 
 * 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.
 */

package com.google.api.client.http;

import com.google.api.client.escape.CharEscapers;
import com.google.api.client.util.DataUtil;

import java.io.IOException;
import java.io.OutputStream;
import java.io.UnsupportedEncodingException;
import java.util.Collection;
import java.util.Map;

/**
 * Implements support for HTTP form content encoding serialization of type
 * {@code application/x-www-form-urlencoded} as specified in the HTML 4.0
 * Specification.
 * 
 * Sample usage:
 * 
 * 
 * 
 * static void setContent(HttpRequest request, Object item) {
 *   UrlEncodedContent content = new UrlEncodedContent();
 *   content.setData(item);
 *   request.content = content;
 * }
 * 
 * 
 * 
 * @since 1.0
 * @author Yaniv Inbar
 */
public final class UrlEncodedContent implements HttpContent {

  /** Content type. Default value is {@link UrlEncodedParser#CONTENT_TYPE}. */
  public String contentType = UrlEncodedParser.CONTENT_TYPE;

  /** Key/value data or {@code null} for none. */
  public Object data;

  private byte[] content;

  /**
   * Sets the content input from the given key/value data.
   * 
   * @param data key/value data (may be {@code null})
   * @deprecated (scheduled to be removed in version 1.1) Use {@link #data}
   */
  @Deprecated
  public void setData(Object data) {
    this.data = data;
  }

  public String getEncoding() {
    return null;
  }

  public long getLength() throws UnsupportedEncodingException {
    return computeContent().length;
  }

  public String getType() {
    return this.contentType;
  }

  public void writeTo(OutputStream out) throws IOException {
    out.write(computeContent());
  }

  private byte[] computeContent() throws UnsupportedEncodingException {
    if (this.content == null) {
      StringBuilder buf = new StringBuilder();
      boolean first = true;
      for (Map.Entry nameValueEntry : DataUtil.mapOf(this.data)
          .entrySet()) {
        Object value = nameValueEntry.getValue();
        if (value != null) {
          String name = CharEscapers.escapeUri(nameValueEntry.getKey());
          if (value instanceof Collection) {
            Collection collectionValue = (Collection) value;
            for (Object repeatedValue : collectionValue) {
              first = appendParam(first, buf, name, repeatedValue);
            }
          } else {
            first = appendParam(first, buf, name, value);
          }
        }
      }
      this.content = buf.toString().getBytes("UTF-8");
    }
    return this.content;
  }

  private static boolean appendParam(boolean first, StringBuilder buf,
      String name, Object value) {
    if (first) {
      first = false;
    } else {
      buf.append('&');
    }
    buf.append(name);
    String stringValue = CharEscapers.escapeUri(value.toString());
    if (stringValue.length() != 0) {
      buf.append('=').append(stringValue);
    }
    return first;
  }
}