com.microsoft.graph.http

Class BaseStreamRequest<T>

java.lang.Object

com.microsoft.graph.http.BaseStreamRequest<T>

Type Parameters:

T - the class of the response type

All Implemented Interfaces:

IHttpRequest, IHttpStreamRequest

Direct Known Subclasses:

DriveItemStreamRequest, DriveItemVersionStreamRequest, OnenotePageStreamRequest, OnenoteResourceStreamRequest, ProfilePhotoStreamRequest, ReportStreamRequest, ThumbnailStreamRequest

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, IBaseClient client, java.util.List<? extends Option> options, java.lang.Class<T> responseClass) Creates the stream request.

Method Summary

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
boolean	getUseCaches() Gets useCaches parameter
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
void	setUseCaches(boolean useCaches) Sets useCaches parameter to cache the response

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,
                         IBaseClient client,
                         java.util.List<? extends 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

setUseCaches

public void setUseCaches(boolean useCaches)

Sets useCaches parameter to cache the response

Specified by:

setUseCaches in interface IHttpRequest

Parameters:

useCaches - the value of useCaches

getUseCaches

public boolean getUseCaches()

Gets useCaches parameter

Specified by:

getUseCaches in interface IHttpRequest

Returns:

the value of useCaches

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