com.onedrive.sdk.http

Class BaseRequest

java.lang.Object

com.onedrive.sdk.http.BaseRequest

All Implemented Interfaces:

IHttpRequest

Direct Known Subclasses:

BaseCopyRequest, BaseCreateLinkRequest, BaseCreateSessionRequest, BaseDriveRequest, BaseItemRequest, BasePermissionRequest, BaseShareRequest, BaseThumbnailRequest, BaseThumbnailSetRequest

public abstract class BaseRequest
extends java.lang.Object
implements IHttpRequest

An http request.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	REQUEST_STATS_HEADER_VALUE_FORMAT_STRING The request stats header value format string.

Constructor Summary

Constructors

Constructor and Description
BaseRequest(java.lang.String requestUrl, IOneDriveClient client, java.util.List<Option> options, java.lang.Class responseClass) Create the 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.
IOneDriveClient	getClient() Gets the client.
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.util.List<QueryOption>	getQueryOptions() Gets the query options for this request.
java.net.URL	getRequestUrl() Gets the request url.
java.lang.Class	getResponseType() Gets the response type.
protected <T1,T2> void	send(HttpMethod method, ICallback<T1> callback, T2 serializedObject) Sends this request.
protected <T1,T2> T1	send(HttpMethod method, T2 serializedObject) Sends this request.
void	setHttpMethod(HttpMethod httpMethod) Sets the http method.

Methods inherited from class java.lang.Object

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

Field Detail

REQUEST_STATS_HEADER_VALUE_FORMAT_STRING

public static final java.lang.String REQUEST_STATS_HEADER_VALUE_FORMAT_STRING

The request stats header value format string.

See Also:

Constant Field Values

Constructor Detail

BaseRequest

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

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

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.

send

protected <T1,T2> void send(HttpMethod method,
                ICallback<T1> callback,
                T2 serializedObject)

Sends this request.

Type Parameters:

T1 - The type of the callback result.

T2 - The type of the serialized body.

Parameters:

method - The http method.

callback - The callback when this request complements.

serializedObject - The object to serialize as the body.

send

protected <T1,T2> T1 send(HttpMethod method,
              T2 serializedObject)
           throws ClientException

Sends this request.

Type Parameters:

T1 - The type of the callback result.

T2 - The type of the serialized body.

Parameters:

method - The http method.

serializedObject - The object to serialize as the body.

Returns:

The response object.

Throws:

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

getQueryOptions

public java.util.List<QueryOption> getQueryOptions()

Gets the query options for this request.

Returns:

The query options for this request.

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.

setHttpMethod

public void setHttpMethod(HttpMethod httpMethod)

Sets the http method.

Parameters:

httpMethod - The http method.

getClient

public IOneDriveClient getClient()

Gets the client.

Returns:

The client.

getResponseType

public java.lang.Class getResponseType()

Gets the response type.

Returns:

The response type.