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

An implementation of AbstractClient, that makes use of Apache HttpComponents 4.2 for HTTP transfers.

Since:

0.1

Author:

Andreas Rudolph

See Also:

Apache HttpComponents 4.2

Field Summary

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

LIVE_API, RESPONSE_HEADER_API_CLIENT, RESPONSE_HEADER_CAUSER_ID, RESPONSE_HEADER_REQUEST_REFNUM, RESPONSE_HEADER_RESOURCE_ID, SANDBOX_API

Constructor Summary

Constructors

Constructor and Description
HttpComponents42Client(String apiBaseUrl, String consumerToken, String consumerSecret) Creates an instance of HttpComponents42Client.
HttpComponents42Client(String apiBaseUrl, String consumerToken, String consumerSecret, org.apache.http.client.HttpClient httpClient) Creates an instance of HttpComponents42Client.

Method Summary

Modifier and Type	Method and Description
protected oauth.signpost.OAuthConsumer	buildOAuthConsumer(String apiAccessKey, String apiAccessSecret) Create an OAuthConsumer object for access credentials.
protected oauth.signpost.OAuthProvider	buildOAuthProvider(String apiBaseUrl) Create an OAuthProvider for the IS24-Webservice.
protected Response	createResponse(org.apache.http.HttpResponse response) Retrieves a Response from a HttpResponse.
protected Response	sendVideoUploadRequest(URL url, RequestMethod method, String auth, InputStream input, String fileName, long fileSize) Send a video with an authentication value to the IS24-Webservice.
protected Response	sendXmlAttachmentRequest(URL url, RequestMethod method, String xml, InputStream input, String fileName, String mimeType) Send a XML string together with a file to the IS24-Webservice.
protected Response	sendXmlRequest(URL url, RequestMethod method, String xml) Send a XML string to the IS24-Webservice.
void	setDefaultHttpClient() Use a default HttpClient for HTTP traffic.
void	setDefaultHttpClient(int timeout) Use a default HttpClient for HTTP traffic.
void	setHttpClient(org.apache.http.client.HttpClient httpClient) Use a specific HttpClient for HTTP traffic.

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

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

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 consumerToken,
                              String consumerSecret)

Creates an instance of HttpComponents42Client.

Parameters:

apiBaseUrl - base URL of the IS24-Webservice (see AbstractClient.LIVE_API and AbstractClient.SANDBOX_API)

consumerToken - consumer token, that identifies the application at the IS24-Webservice

consumerSecret - consumer secret, that identifies the application at the IS24-Webservice

HttpComponents42Client

public HttpComponents42Client(String apiBaseUrl,
                              String consumerToken,
                              String consumerSecret,
                              org.apache.http.client.HttpClient httpClient)

Creates an instance of HttpComponents42Client.

Parameters:

apiBaseUrl - base URL of the IS24-Webservice (see AbstractClient.LIVE_API and AbstractClient.SANDBOX_API)

consumerToken - consumer token, that identifies the application at the IS24-Webservice

consumerSecret - consumer secret, that identifies the application at the IS24-Webservice

httpClient - HttpClient, that is used for HTTP transfers

Method Detail

buildOAuthConsumer

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

Description copied from class: AbstractClient

Create an OAuthConsumer object for access credentials.

Different implementations of AbstractClient may create different OAuthConsumer objects.

Overrides:

buildOAuthConsumer in class AbstractClient

Parameters:

apiAccessKey - access or verification token

apiAccessSecret - access or verification secret

Returns:

an instance of OAuthConsumer for the provided credentials

buildOAuthProvider

protected oauth.signpost.OAuthProvider buildOAuthProvider(String apiBaseUrl)

Description copied from class: AbstractClient

Create an OAuthProvider for the IS24-Webservice.

Different implementations of AbstractClient may create different OAuthProvider objects.

Overrides:

buildOAuthProvider in class AbstractClient

Parameters:

apiBaseUrl - URL of the IS24-Webservice

Returns:

an instance of OAuthProvider for the provided URL

createResponse

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

Retrieves a Response from a HttpResponse.

Parameters:

response - HttpResponse, that was received by the client

Returns:

Response of the request

Throws:

IOException - if the Response can't be obtained

sendXmlRequest

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

Description copied from class: AbstractClient

Send a XML string to the IS24-Webservice.

This function must be implemendet by specific implementations of AbstractClient.

Specified by:

sendXmlRequest in class AbstractClient

Parameters:

url - URL of the IS24-Webservice, where the request is sent to

method - HTTP method of the outgoing request

xml - XML string, that is sent to the IS24-Webservice

Returns:

response, that was received from the IS24-Webservice

Throws:

IOException - if communication with IS24-Webservice failed

oauth.signpost.exception.OAuthException - if authorization failed

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

Send a XML string together with a file to the IS24-Webservice.

This function must be implemendet by specific implementations of AbstractClient.

Specified by:

sendXmlAttachmentRequest in class AbstractClient

Parameters:

url - URL of the IS24-Webservice, where the request is sent to

method - the HTTP method of the outgoing request

xml - the XML string, that is sent to the IS24-Webservice

input - the file content, that is sent to the IS24-Webservice

fileName - the name of the file, that is sent to the IS24-Webservice

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

Returns:

the response, that was received from the IS24-Webservice

Throws:

IOException - if communication with IS24-Webservice failed

oauth.signpost.exception.OAuthException - if authorization failed

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

Send a video with an authentication value to the IS24-Webservice.

This function must be implemendet by specific implementations of AbstractClient.

Specified by:

sendVideoUploadRequest in class AbstractClient

Parameters:

url - URL of the IS24-Webservice, where the request is sent to

method - HTTP method of the outgoing request

auth - authentication value, that is sent to the IS24-Webservice

input - file content, that is sent to the IS24-Webservice

fileName - name of the file, that is sent to the IS24-Webservice

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

Returns:

response, that was received from the IS24-Webservice

Throws:

IOException - if communication with IS24-Webservice failed

oauth.signpost.exception.OAuthException - if authorization failed

setDefaultHttpClient

public void setDefaultHttpClient()

Use a default HttpClient for HTTP traffic.

setDefaultHttpClient

public void setDefaultHttpClient(int timeout)

Use a default HttpClient for HTTP traffic.

Parameters:

timeout - timeout for HTTP communication (in milliseconds)

setHttpClient

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

Use a specific HttpClient for HTTP traffic.

Parameters:

httpClient - HttpClient, that is used for HTTP communication