com.Upwork.api

Class OAuthClient

java.lang.Object

com.Upwork.api.OAuthClient

@ClassPreamble(author="Maksym Novozhylov <mnovozhilov@upwork.com>",
               date="5/31/2014",
               currentRevision=1,
               lastModified="9/30/2014",
               lastModifiedBy="Maksym Novozhylov",
               reviewers="Yiota Tsakiri")
public class OAuthClient
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
OAuthClient(Config properties) Constructor

Method Summary

Modifier and Type	Method and Description
JSONObject	delete(java.lang.String url) Send signed OAuth DELETE request without parameters
JSONObject	delete(java.lang.String url, java.util.HashMap<java.lang.String,java.lang.String> params) Send signed OAuth DELETE request
JSONObject	get(java.lang.String url) Send signed OAuth GET request without parameters
JSONObject	get(java.lang.String url, java.util.HashMap<java.lang.String,java.lang.String> params) Send signed OAuth GET request
java.util.HashMap<java.lang.String,java.lang.String>	getAccessTokenSet(java.lang.String verifier) Get access token-secret pair
java.lang.String	getAuthorizationUrl() Get authorization URL
java.lang.String	getAuthorizationUrl(java.lang.String oauthCallback) Get authorization URL, and use provided callback
JSONObject	post(java.lang.String url, java.util.HashMap<java.lang.String,java.lang.String> params) Send signed OAuth POST request
JSONObject	put(java.lang.String url) Send signed OAuth PUT request
JSONObject	put(java.lang.String url, java.util.HashMap<java.lang.String,java.lang.String> params) Send signed OAuth PUT request
void	setEntryPoint(java.lang.String ep) Setup entry point for the request(s)
java.util.HashMap<java.lang.String,java.lang.String>	setTokenWithSecret(java.lang.String aToken, java.lang.String aSecret) Setup access token and secret for OAuth client

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuthClient

public OAuthClient(Config properties)

Constructor

Parameters:

properties - Config properties

Method Detail

getAuthorizationUrl

public java.lang.String getAuthorizationUrl(java.lang.String oauthCallback)

Get authorization URL, and use provided callback

Parameters:

oauthCallback - URL, i.e. oauth_callback used in mobile applications

Returns:

URL for authorizing application

getAuthorizationUrl

public java.lang.String getAuthorizationUrl()

Get authorization URL

Returns:

URL for authorizing application

getAccessTokenSet

public java.util.HashMap<java.lang.String,java.lang.String> getAccessTokenSet(java.lang.String verifier)

Get access token-secret pair

Parameters:

verifier - OAuth verifier, which was got after authorization

Returns:

Access token-secret pair

setTokenWithSecret

public final java.util.HashMap<java.lang.String,java.lang.String> setTokenWithSecret(java.lang.String aToken,
                                                                                     java.lang.String aSecret)

Setup access token and secret for OAuth client

Parameters:

aToken - Access token

aSecret - Access secret

Returns:

Token-secret pair

setEntryPoint

public final void setEntryPoint(java.lang.String ep)

Setup entry point for the request(s)

Parameters:

ep - Entry point

get

public JSONObject get(java.lang.String url)
               throws JSONException

Send signed OAuth GET request without parameters

Parameters:

url - Relative URL

Returns:

JSONObject JSON Object that contains data from response

Throws:

JSONException - If JSON object is invalid or request was abnormal

get

public JSONObject get(java.lang.String url,
                      java.util.HashMap<java.lang.String,java.lang.String> params)
               throws JSONException

Send signed OAuth GET request

Parameters:

url - Relative URL

params - Hash of parameters

Returns:

JSONObject JSON Object that contains data from response

Throws:

JSONException - If JSON object is invalid or request was abnormal

post

public JSONObject post(java.lang.String url,
                       java.util.HashMap<java.lang.String,java.lang.String> params)
                throws JSONException

Send signed OAuth POST request

Parameters:

url - Relative URL

params - Hash of parameters

Returns:

JSONObject JSON Object that contains data from response

Throws:

JSONException - If JSON object is invalid or request was abnormal

put

public JSONObject put(java.lang.String url)
               throws JSONException

Send signed OAuth PUT request

Parameters:

url - Relative URL

Returns:

JSONObject JSON Object that contains data from response

Throws:

JSONException - If JSON object is invalid or request was abnormal

put

public JSONObject put(java.lang.String url,
                      java.util.HashMap<java.lang.String,java.lang.String> params)
               throws JSONException

Send signed OAuth PUT request

Parameters:

url - Relative URL

params - Hash of parameters

Returns:

JSONObject JSON Object that contains data from response

Throws:

JSONException - If JSON object is invalid or request was abnormal

delete

public JSONObject delete(java.lang.String url)
                  throws JSONException

Send signed OAuth DELETE request without parameters

Parameters:

url - Relative URL

Returns:

JSONObject JSON Object that contains data from response

Throws:

JSONException - If JSON object is invalid or request was abnormal

delete

public JSONObject delete(java.lang.String url,
                         java.util.HashMap<java.lang.String,java.lang.String> params)
                  throws JSONException

Send signed OAuth DELETE request

Parameters:

url - Relative URL

params - Hash of parameters

Returns:

JSONObject JSON Object that contains data from response

Throws:

JSONException - If JSON object is invalid or request was abnormal