com.uploadcare.api

Class RequestHelper

java.lang.Object

com.uploadcare.api.RequestHelper

public class RequestHelper
extends java.lang.Object

A helper class for doing API calls to the Uploadcare API. Supports API version 0.4. TODO Support of throttled requests needs to be added

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATE_FORMAT
static java.lang.String	DATE_FORMAT_ISO_8601
static java.lang.String	LIBRARY_VERSION
static java.util.TimeZone	UTC

Method Summary

Modifier and Type	Method and Description
org.apache.http.HttpResponse	executeCommand(org.apache.http.client.methods.HttpUriRequest request, boolean apiHeaders) Executes the request et the Uploadcare API and return the HTTP Response object.
<T,U> java.lang.Iterable<T>	executePaginatedQuery(java.net.URI url, java.util.List<UrlParameter> urlParameters, boolean apiHeaders, java.lang.Class<? extends PageData<U>> dataClass, DataWrapper<T,U> dataWrapper)
<T> T	executeQuery(org.apache.http.client.methods.HttpUriRequest request, boolean apiHeaders, java.lang.Class<T> dataClass)
static java.lang.String	iso8601(java.util.Date date)
java.lang.String	makeSignature(org.apache.http.client.methods.HttpUriRequest request, java.lang.String date)
static java.lang.String	rfc2822(java.util.Date date)
void	setApiHeaders(org.apache.http.client.methods.HttpUriRequest request)
static void	setQueryParameters(org.apache.http.client.utils.URIBuilder builder, java.util.List<UrlParameter> parameters)

Methods inherited from class java.lang.Object

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

Field Detail

LIBRARY_VERSION

public static final java.lang.String LIBRARY_VERSION

See Also:

Constant Field Values

DATE_FORMAT

public static final java.lang.String DATE_FORMAT

See Also:

Constant Field Values

DATE_FORMAT_ISO_8601

public static final java.lang.String DATE_FORMAT_ISO_8601

See Also:

Constant Field Values

UTC

public static final java.util.TimeZone UTC

Method Detail

rfc2822

public static java.lang.String rfc2822(java.util.Date date)

iso8601

public static java.lang.String iso8601(java.util.Date date)

makeSignature

public java.lang.String makeSignature(org.apache.http.client.methods.HttpUriRequest request,
                                      java.lang.String date)
                               throws java.security.NoSuchAlgorithmException,
                                      java.security.InvalidKeyException

Throws:

java.security.NoSuchAlgorithmException

java.security.InvalidKeyException

setApiHeaders

public void setApiHeaders(org.apache.http.client.methods.HttpUriRequest request)

executeQuery

public <T> T executeQuery(org.apache.http.client.methods.HttpUriRequest request,
                          boolean apiHeaders,
                          java.lang.Class<T> dataClass)

setQueryParameters

public static void setQueryParameters(org.apache.http.client.utils.URIBuilder builder,
                                      java.util.List<UrlParameter> parameters)

executePaginatedQuery

public <T,U> java.lang.Iterable<T> executePaginatedQuery(java.net.URI url,
                                                         java.util.List<UrlParameter> urlParameters,
                                                         boolean apiHeaders,
                                                         java.lang.Class<? extends PageData<U>> dataClass,
                                                         DataWrapper<T,U> dataWrapper)

executeCommand

public org.apache.http.HttpResponse executeCommand(org.apache.http.client.methods.HttpUriRequest request,
                                                   boolean apiHeaders)

Executes the request et the Uploadcare API and return the HTTP Response object. The existence of this method(and it's return type) enables the end user to extend the functionality of the Uploadcare API client by creating a subclass of Client.

Parameters:

request - request to be sent to the API

apiHeaders - TRUE if the default API headers should be set

Returns:

HTTP Response object