org.openestate.is24.restapi.hc42

Class HttpComponents42Client

java.lang.Object

org.openestate.is24.restapi.AbstractClient

org.openestate.is24.restapi.hc42.HttpComponents42Client

public class HttpComponents42Client
extends AbstractClient

Author:

Andreas Rudolph

Field Summary

Fields inherited from class org.openestate.is24.restapi.AbstractClient

DELETE_METHOD, GET_METHOD, LIVE_API, POST_METHOD, PUT_METHOD, SANDBOX_API

Constructor Summary

Constructors

Constructor and Description
HttpComponents42Client(String apiBaseUrl, String apiAccessKey, String apiAccessSecret)
HttpComponents42Client(String apiBaseUrl, String apiAccessKey, String apiAccessSecret, org.apache.http.client.HttpClient httpClient)

Method Summary

Methods

Modifier and Type	Method and Description
protected oauth.signpost.OAuthConsumer	buildOAuthConsumer(String apiAccessKey, String apiAccessSecret)
protected oauth.signpost.OAuthProvider	buildOAuthProvider(String apiBaseUrl)
protected Response	createResponse(org.apache.http.HttpResponse response)
protected Response	sendVideoUploadRequest(URL url, RequestMethod method, String auth, InputStream input, String fileName, long fileSize) Sends video with an authentication value to a webservice.
protected Response	sendXmlAttachmentRequest(URL url, RequestMethod method, String xml, InputStream input, String fileName, String mimeType) Sends XML string together with a file to a webservice.
protected Response	sendXmlRequest(URL url, RequestMethod method, String xml) Sends XML string to a webservice.
void	setDefaultHttpClient()
void	setDefaultHttpClient(int timeout)
void	setHttpClient(org.apache.http.client.HttpClient httpClient)

Methods inherited from class org.openestate.is24.restapi.AbstractClient

authorize, authorize, authorizeAfterVerification, authorizeAfterVerification, fetchVerification, fetchVerification, getApiBaseUrl, getAuthConsumer, getAuthProvider, getEncodedParameterValue, getEncoding

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpComponents42Client

public HttpComponents42Client(String apiBaseUrl,
                      String apiAccessKey,
                      String apiAccessSecret)

HttpComponents42Client

public HttpComponents42Client(String apiBaseUrl,
                      String apiAccessKey,
                      String apiAccessSecret,
                      org.apache.http.client.HttpClient httpClient)

Method Detail

buildOAuthConsumer

protected oauth.signpost.OAuthConsumer buildOAuthConsumer(String apiAccessKey,
                                              String apiAccessSecret)

Overrides:

buildOAuthConsumer in class AbstractClient

buildOAuthProvider

protected oauth.signpost.OAuthProvider buildOAuthProvider(String apiBaseUrl)

Overrides:

buildOAuthProvider in class AbstractClient

createResponse

protected Response createResponse(org.apache.http.HttpResponse response)
                           throws IOException

Throws:

IOException

sendXmlRequest

protected Response sendXmlRequest(URL url,
                      RequestMethod method,
                      String xml)
                           throws IOException,
                                  oauth.signpost.exception.OAuthException

Description copied from class: AbstractClient

Sends XML string to a webservice.

Specified by:

sendXmlRequest in class AbstractClient

Parameters:

url - the URL of the webserice

method - the HTTP method of the outgoing request

xml - the XML string, that is sent to the webservice

Returns:

the response, that was received from the webservice

Throws:

IOException

oauth.signpost.exception.OAuthException

sendXmlAttachmentRequest

protected Response sendXmlAttachmentRequest(URL url,
                                RequestMethod method,
                                String xml,
                                InputStream input,
                                String fileName,
                                String mimeType)
                                     throws IOException,
                                            oauth.signpost.exception.OAuthException

Description copied from class: AbstractClient

Sends XML string together with a file to a webservice.

Specified by:

sendXmlAttachmentRequest in class AbstractClient

Parameters:

url - the URL of the webserice

method - the HTTP method of the outgoing request

xml - the XML string, that is sent to the webservice

input - the file content, that is sent to the webservice

fileName - the name of the file, that is sent to the webservice

mimeType - the MIME-type of the file, that is sent to the webservice

Returns:

the response, that was received from the webservice

Throws:

IOException

oauth.signpost.exception.OAuthException

sendVideoUploadRequest

protected Response sendVideoUploadRequest(URL url,
                              RequestMethod method,
                              String auth,
                              InputStream input,
                              String fileName,
                              long fileSize)
                                   throws IOException,
                                          oauth.signpost.exception.OAuthException

Description copied from class: AbstractClient

Sends video with an authentication value to a webservice.

Specified by:

sendVideoUploadRequest in class AbstractClient

Parameters:

url - the URL of the webserice

method - the HTTP method of the outgoing request

auth - the authentication value, that is sent to the webservice

input - the file content, that is sent to the webservice

fileName - the name of the file, that is sent to the webservice

fileSize - the size of the file, that is sent to the webservice (in bytes)

Returns:

the response, that was received from the webservice

Throws:

IOException

oauth.signpost.exception.OAuthException

setDefaultHttpClient

public void setDefaultHttpClient()

setDefaultHttpClient

public void setDefaultHttpClient(int timeout)

setHttpClient

public void setHttpClient(org.apache.http.client.HttpClient httpClient)