org.openestate.is24.restapi

Class AbstractClient

java.lang.Object

org.openestate.is24.restapi.AbstractClient

Direct Known Subclasses:

DefaultClient, HttpComponents42Client, HttpComponents43Client

public abstract class AbstractClient
extends Object

Author:

Andreas Rudolph

Field Summary

Fields

Modifier and Type	Field and Description
static String	DELETE_METHOD
static String	GET_METHOD
static String	LIVE_API
static String	POST_METHOD
static String	PUT_METHOD
static String	SANDBOX_API

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractClient(String apiBaseUrl, String apiAccessKey, String apiAccessSecret)

Method Summary

Methods

Modifier and Type	Method and Description
void	authorize(Authorization authorization)
void	authorize(String accessToken, String accessTokenSecret)
Authorization	authorizeAfterVerification(String requestToken, String requestTokenSecret, String verificationCode)
Authorization	authorizeAfterVerification(Verification verification, String verificationCode)
protected oauth.signpost.OAuthConsumer	buildOAuthConsumer(String apiAccessKey, String apiAccessSecret)
protected oauth.signpost.OAuthProvider	buildOAuthProvider(String apiBaseUrl)
Verification	fetchVerification() Fetch URL for access verification.
Verification	fetchVerification(String callbackUrl) Fetch URL for access verification.
String	getApiBaseUrl()
oauth.signpost.OAuthConsumer	getAuthConsumer()
oauth.signpost.OAuthProvider	getAuthProvider()
String	getEncodedParameterValue(String value)
String	getEncoding()
protected abstract Response	sendVideoUploadRequest(URL url, RequestMethod method, String auth, InputStream input, String fileName, long fileSize) Sends video with an authentication value to a webservice.
protected abstract 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 abstract Response	sendXmlRequest(URL url, RequestMethod method, String xml) Sends XML string to a webservice.

Methods inherited from class java.lang.Object

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

Field Detail

GET_METHOD

public static final String GET_METHOD

See Also:

Constant Field Values

POST_METHOD

public static final String POST_METHOD

See Also:

Constant Field Values

PUT_METHOD

public static final String PUT_METHOD

See Also:

Constant Field Values

DELETE_METHOD

public static final String DELETE_METHOD

See Also:

Constant Field Values

LIVE_API

public static final String LIVE_API

See Also:

Constant Field Values

SANDBOX_API

public static final String SANDBOX_API

See Also:

Constant Field Values

Constructor Detail

AbstractClient

protected AbstractClient(String apiBaseUrl,
              String apiAccessKey,
              String apiAccessSecret)

Method Detail

authorize

public final void authorize(Authorization authorization)
                     throws oauth.signpost.exception.OAuthException

Throws:

oauth.signpost.exception.OAuthException

authorize

public final void authorize(String accessToken,
             String accessTokenSecret)
                     throws oauth.signpost.exception.OAuthException

Throws:

oauth.signpost.exception.OAuthException

authorizeAfterVerification

public final Authorization authorizeAfterVerification(Verification verification,
                                       String verificationCode)
                                               throws oauth.signpost.exception.OAuthException

Throws:

oauth.signpost.exception.OAuthException

authorizeAfterVerification

public final Authorization authorizeAfterVerification(String requestToken,
                                       String requestTokenSecret,
                                       String verificationCode)
                                               throws oauth.signpost.exception.OAuthException

Throws:

oauth.signpost.exception.OAuthException

buildOAuthConsumer

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

buildOAuthProvider

protected oauth.signpost.OAuthProvider buildOAuthProvider(String apiBaseUrl)

fetchVerification

public final Verification fetchVerification()
                                     throws oauth.signpost.exception.OAuthException

Fetch URL for access verification.

Returns:

Throws:

oauth.signpost.exception.OAuthException

fetchVerification

public final Verification fetchVerification(String callbackUrl)
                                     throws oauth.signpost.exception.OAuthException

Fetch URL for access verification.

Parameters:

callbackUrl -

Returns:

Throws:

oauth.signpost.exception.OAuthException

getApiBaseUrl

public final String getApiBaseUrl()

getAuthConsumer

public final oauth.signpost.OAuthConsumer getAuthConsumer()
                                                   throws oauth.signpost.exception.OAuthNotAuthorizedException

Throws:

oauth.signpost.exception.OAuthNotAuthorizedException

getAuthProvider

public final oauth.signpost.OAuthProvider getAuthProvider()
                                                   throws oauth.signpost.exception.OAuthNotAuthorizedException

Throws:

oauth.signpost.exception.OAuthNotAuthorizedException

getEncodedParameterValue

public final String getEncodedParameterValue(String value)

getEncoding

public final String getEncoding()

sendXmlRequest

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

Sends XML string to a webservice.

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 abstract Response sendXmlAttachmentRequest(URL url,
                                RequestMethod method,
                                String xml,
                                InputStream input,
                                String fileName,
                                String mimeType)
                                              throws IOException,
                                                     oauth.signpost.exception.OAuthException

Sends XML string together with a file to a webservice.

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 abstract Response sendVideoUploadRequest(URL url,
                              RequestMethod method,
                              String auth,
                              InputStream input,
                              String fileName,
                              long fileSize)
                                            throws IOException,
                                                   oauth.signpost.exception.OAuthException

Sends video with an authentication value to a webservice.

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