com.onedrive.sdk.http

Class BaseCollectionRequest<T1,T2>

java.lang.Object

com.onedrive.sdk.http.BaseCollectionRequest<T1,T2>

Type Parameters:

T1 - The raw response class returned by the service.

T2 - The class of the collection page.

All Implemented Interfaces:

IHttpRequest

Direct Known Subclasses:

BaseDeltaRequest, BaseDriveCollectionRequest, BaseItemCollectionRequest, BasePermissionCollectionRequest, BaseRecentRequest, BaseSearchRequest, BaseShareCollectionRequest, BaseStringCollectionRequest, BaseThumbnailSetCollectionRequest

public abstract class BaseCollectionRequest<T1,T2>
extends java.lang.Object
implements IHttpRequest

A request against a collection.

Constructor Summary

Constructors

Constructor and Description
BaseCollectionRequest(java.lang.String requestUrl, IOneDriveClient client, java.util.List<Option> options, java.lang.Class<T1> responseClass, java.lang.Class<T2> collectionPageClass) Create the collection 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.
void	addQueryOption(QueryOption option) Adds a query option.
protected BaseRequest	getBaseRequest() Gets the base request for this collection request.
java.lang.Class<T2>	getCollectionPageClass() Gets the class for the collection page.
java.util.List<HeaderOption>	getHeaders() Gets the headers.
HttpMethod	getHttpMethod() Gets the http method.
java.util.List<Option>	getOptions() Gets the full list of options for this request.
java.net.URL	getRequestUrl() Gets the request url.
protected T1	send() Send this request.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseCollectionRequest

public BaseCollectionRequest(java.lang.String requestUrl,
                     IOneDriveClient client,
                     java.util.List<Option> options,
                     java.lang.Class<T1> responseClass,
                     java.lang.Class<T2> collectionPageClass)

Create the collection 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.

collectionPageClass - The class for the collection page.

Method Detail

send

protected T1 send()
           throws ClientException

Send this request.

Returns:

The response object.

Throws:

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

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.

getHeaders

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

Gets the headers.

Specified by:

getHeaders in interface IHttpRequest

Returns:

The headers.

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.

getOptions

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

Gets the full list of options for this request.

Specified by:

getOptions in interface IHttpRequest

Returns:

The full list of options for this request.

addQueryOption

public void addQueryOption(QueryOption option)

Adds a query option.

Parameters:

option - The query option to add.

getBaseRequest

protected BaseRequest getBaseRequest()

Gets the base request for this collection request.

Returns:

The base request for this collection request.

getCollectionPageClass

public java.lang.Class<T2> getCollectionPageClass()

Gets the class for the collection page.

Returns:

The class for the collection page.