com.google.api.client.http.protobuf

Class ProtoHttpContent

java.lang.Object

com.google.api.client.http.AbstractHttpContent

com.google.api.client.http.protobuf.ProtoHttpContent

All Implemented Interfaces:

HttpContent, StreamingContent

@Beta
public class ProtoHttpContent
extends AbstractHttpContent

Beta
Serializes of a protocol buffer message to HTTP content.

Sample usage:

  static HttpRequest buildPostRequest(
      HttpRequestFactory requestFactory, GenericUrl url, MessageLite message) throws IOException {
    return requestFactory.buildPostRequest(url, new ProtoHttpContent(message));
  }
 

Implementation is not thread-safe.

Since:

1.5

Author:

Yaniv Inbar

Constructor Summary

Constructors

Constructor and Description
ProtoHttpContent(com.google.protobuf.MessageLite message)

Method Summary

Modifier and Type	Method and Description
long	getLength() Default implementation calls AbstractHttpContent.computeLength() once and caches it for future invocations, but subclasses may override.
com.google.protobuf.MessageLite	getMessage() Returns the message to serialize.
ProtoHttpContent	setMediaType(HttpMediaType mediaType) Sets the media type to use for the Content-Type header, or null if unspecified.
void	writeTo(OutputStream out) Writes the byte content to the given output stream.

Methods inherited from class com.google.api.client.http.AbstractHttpContent

computeLength, computeLength, getCharset, getMediaType, getType, retrySupported

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtoHttpContent

public ProtoHttpContent(com.google.protobuf.MessageLite message)

Parameters:

message - message to serialize

Method Detail

getLength

public long getLength()
               throws IOException

Description copied from class: AbstractHttpContent

Default implementation calls AbstractHttpContent.computeLength() once and caches it for future invocations, but subclasses may override.

Specified by:

getLength in interface HttpContent

Overrides:

getLength in class AbstractHttpContent

Throws:

IOException

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 the output stream has not been closed, and will fail to work if it has been closed.

Parameters:

out - output stream

Throws:

IOException

getMessage

public final com.google.protobuf.MessageLite getMessage()

Returns the message to serialize.

setMediaType

public ProtoHttpContent 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