Class UrlEncodedContent

java.lang.Object
com.google.api.client.http.AbstractHttpContent
com.google.api.client.http.UrlEncodedContent
All Implemented Interfaces:
HttpContent, StreamingContent
public class UrlEncodedContent extends AbstractHttpContent
Implements support for HTTP form content encoding serialization of type application/x-www-form-urlencoded as specified in the HTML 4.0 Specification.

Sample usage: 

static void setContent(HttpRequest request, Object item) {
request.setContent(new UrlEncodedContent(item));
}

Implementation is not thread-safe.

Since:
1.0

  • Field Details

    • data

      private Object data
      Key name/value data.

    • uriPathEncodingFlag

      private boolean uriPathEncodingFlag
      Use URI Path encoder flag. False by default (use legacy and deprecated escapeUri)

  • Constructor Details

    • UrlEncodedContent

      public UrlEncodedContent(Object data)
      Initialize the UrlEncodedContent with the legacy and deprecated escapeUri encoder
      Parameters:
      data - key name/value data

    • UrlEncodedContent

      public UrlEncodedContent(Object data, boolean useUriPathEncoding)
      Initialize the UrlEncodedContent with or without the legacy and deprecated escapeUri encoder
      Parameters:
      data - key name/value data
      useUriPathEncoding - escapes the string value so it can be safely included in URI path segments. For details on escaping URIs, see RFC 3986 - section 2.4

  • Method Details

    • writeTo

      public void writeTo(OutputStream out) throws IOException
      Description copied from interface: StreamingContent
      Writes the byte content to the given output stream.

      Implementations must not close the output stream, and instead should flush the output stream. Some callers may assume that the output stream has not been closed, and will fail to work if it has been closed.

      Parameters:
      out - output stream
      Throws:
      IOException

    • setMediaType

      public UrlEncodedContent setMediaType(HttpMediaType mediaType)
      Description copied from class: AbstractHttpContent
      Sets the media type to use for the Content-Type header, or null if unspecified.

      This will also overwrite any previously set parameter of the media type (for example "charset"), and therefore might change other properties as well.

      Overrides:
      setMediaType in class AbstractHttpContent

    • getData

      public final Object getData()
      Returns the key name/value data or null for none.
      Since:
      1.5

    • setData

      public UrlEncodedContent setData(Object data)
      Sets the key name/value data.

      Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

      Since:
      1.5

    • getContent

      public static UrlEncodedContent getContent(HttpRequest request)
      Returns the URL-encoded content of the given HTTP request, or if none return and set as content a new instance of UrlEncodedContent (whose getData() is an implementation of Map).
      Parameters:
      request - HTTP request
      Returns:
      URL-encoded content
      Throws:
      ClassCastException - if the HTTP request has a content defined that is not UrlEncodedContent
      Since:
      1.7

    • appendParam

      private static boolean appendParam(boolean first, Writer writer, String name, Object value, boolean uriPathEncodingFlag) throws IOException
      Throws:
      IOException