com.onedrive.sdk.http

Class BaseStreamRequest<T>

java.lang.Object

com.onedrive.sdk.http.BaseStreamRequest<T>

Type Parameters:

T - The class of the response type.

All Implemented Interfaces:

IHttpRequest, IHttpStreamRequest

Direct Known Subclasses:

BaseItemStreamRequest, BaseThumbnailStreamRequest

public abstract class BaseStreamRequest<T>
extends java.lang.Object
implements IHttpStreamRequest

A request for a binary stream.

Constructor Summary

Constructors

Constructor and Description
BaseStreamRequest(java.lang.String requestUrl, IOneDriveClient client, java.util.List<Option> options, java.lang.Class<T> responseClass) Creates the stream request.

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeader(java.lang.String header, java.lang.String value) Adds a header to this request.
java.util.List<HeaderOption>	getHeaders() Gets the headers.
HttpMethod	getHttpMethod() Gets the http method.
java.util.List<Option>	getOptions() Gets the query options for this request.
java.net.URL	getRequestUrl() Gets the request url.
protected java.io.InputStream	send() Sends this request.
protected T	send(byte[] fileContents) Sends this request.
protected void	send(byte[] fileContents, ICallback<T> callback) Sends this request.
protected void	send(ICallback<java.io.InputStream> callback) Sends this request.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseStreamRequest

public BaseStreamRequest(java.lang.String requestUrl,
                 IOneDriveClient client,
                 java.util.List<Option> options,
                 java.lang.Class<T> responseClass)

Creates the stream request.

Parameters:

requestUrl - The url to make the request against.

client - The client which can issue the request.

options - The options for this request.

responseClass - The class for the response.

Method Detail

send

protected void send(ICallback<java.io.InputStream> callback)

Sends this request.

Parameters:

callback - The callback when this request complements. The caller needs to close the stream.

send

protected java.io.InputStream send()
                            throws ClientException

Sends this request.

Returns:

The stream that the caller needs to close.

Throws:

ClientException - An exception occurs if there was an error while the request was sent.

send

protected void send(byte[] fileContents,
        ICallback<T> callback)

Sends this request.

Parameters:

fileContents - The file to upload.

callback - The callback when this request complements. The caller needs to close the stream.

send

protected T send(byte[] fileContents)

Sends this request.

Parameters:

fileContents - The file to upload.

Returns:

The stream that the caller needs to close.

getRequestUrl

public java.net.URL getRequestUrl()

Gets the request url.

Specified by:

getRequestUrl in interface IHttpRequest

Returns:

The request url.

getHttpMethod

public HttpMethod getHttpMethod()

Gets the http method.

Specified by:

getHttpMethod in interface IHttpRequest

Returns:

The http method.

addHeader

public void addHeader(java.lang.String header,
             java.lang.String value)

Adds a header to this request.

Specified by:

addHeader in interface IHttpRequest

Parameters:

header - The name of the header.

value - The value of the header.

getHeaders

public java.util.List<HeaderOption> getHeaders()

Gets the headers.

Specified by:

getHeaders in interface IHttpRequest

Returns:

The headers.

getOptions

public java.util.List<Option> getOptions()

Gets the query options for this request.

Specified by:

getOptions in interface IHttpRequest

Returns:

The query options for this request.