com.gigya.socialize

Class GSRequest

java.lang.Object

com.gigya.socialize.GSRequest

public class GSRequest
extends java.lang.Object

This class is used for sending a request to Gigya Service.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	apiDomain
protected java.lang.String	apiMethod
static boolean	ENABLE_CONNECTION_POOLING
protected java.lang.String	format
protected java.lang.String	hostOverride
protected static long	timestampOffsetSec
static java.lang.String	VERSION

Constructor Summary

Constructors

Constructor and Description
GSRequest(java.lang.String accessToken, java.lang.String apiMethod)
GSRequest(java.lang.String accessToken, java.lang.String apiMethod, GSObject clientParams)
GSRequest(java.lang.String apiKey, java.lang.String secretKey, java.lang.String apiMethod)
GSRequest(java.lang.String apiKey, java.lang.String secretKey, java.lang.String apiMethod, boolean useHTTPS)
GSRequest(java.lang.String apiKey, java.lang.String secretKey, java.lang.String apiMethod, GSObject clientParams)
GSRequest(java.lang.String apiKey, java.lang.String secretKey, java.lang.String apiMethod, GSObject clientParams, boolean useHTTPS)
GSRequest(java.lang.String apiKey, java.lang.String secretKey, java.lang.String apiMethod, GSObject clientParams, boolean useHTTPS, java.lang.String userKey)
GSRequest(java.lang.String apiKey, java.lang.String secretKey, java.lang.String accessToken, java.lang.String apiMethod, GSObject clientParams, boolean useHTTPS)
GSRequest(java.lang.String apiKey, java.lang.String secretKey, java.lang.String accessToken, java.lang.String apiMethod, GSObject clientParams, boolean useHTTPS, java.lang.String userKey) Constructs a request using an apiKey and a secretKey.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	buildQS(GSObject params) Converts a GSObject to a query string.
void	clearParams() Clear request parameters
GSLogger	getLogger() Retrieves the logger object
java.lang.String	getMethod()
GSObject	getParams() Returns a GSObject object containing the parameters of this request.
GSResponse	send() Sends the request synchronously.
void	send(GSResponseListener listener) Sends the request asynchronously.
void	send(GSResponseListener listener, java.lang.Object context) Sends the request asynchronously.
GSResponse	send(int timeoutMS) Sends the request synchronously.
protected GSResponse	sendRequest(java.lang.String httpMethod, java.lang.String domain, java.lang.String path, GSObject params, java.lang.String token, java.lang.String secret, boolean useHTTPS, boolean isLoggedIn, int timeoutMS) Send the actual HTTP/S request
void	setAPIDomain(java.lang.String apiDomain) Sets the domain used for making API calls.
void	setHostOverride(java.lang.String host)
void	setLogger(GSLogger logger) Allows passing an existing GSLogger
void	setMethod(java.lang.String apiMethod)
void	setParam(java.lang.String key, boolean value) Sets a request parameter with a value.
void	setParam(java.lang.String key, GSArray value) Sets a request parameter with a value.
void	setParam(java.lang.String key, GSObject value) Sets a request parameter with a value.
void	setParam(java.lang.String key, int value) Sets a request parameter with a value.
void	setParam(java.lang.String key, long value) Sets a request parameter with a value.
void	setParam(java.lang.String key, java.lang.String value) Sets a request parameter with a value.
void	setParams(GSObject clientParams) Sets a GSObject object containing the parameters of this request.
void	setProxy(java.net.Proxy p) Sets a proxy.
void	setUseHTTPS(boolean useHTTPS)
static java.lang.String	UrlEncode(java.lang.String value) Applies URL encoding rules to the String value, and returns the outcome.
java.lang.String	urlEncodedParam(java.lang.String key)

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final java.lang.String VERSION

See Also:

Constant Field Values

ENABLE_CONNECTION_POOLING

public static boolean ENABLE_CONNECTION_POOLING

timestampOffsetSec

protected static long timestampOffsetSec

apiMethod

protected java.lang.String apiMethod

apiDomain

protected java.lang.String apiDomain

hostOverride

protected java.lang.String hostOverride

format

protected java.lang.String format

Constructor Detail

GSRequest

public GSRequest(java.lang.String accessToken,
                 java.lang.String apiMethod)

GSRequest

public GSRequest(java.lang.String accessToken,
                 java.lang.String apiMethod,
                 GSObject clientParams)

GSRequest

public GSRequest(java.lang.String apiKey,
                 java.lang.String secretKey,
                 java.lang.String apiMethod,
                 GSObject clientParams)

GSRequest

public GSRequest(java.lang.String apiKey,
                 java.lang.String secretKey,
                 java.lang.String apiMethod,
                 boolean useHTTPS)

GSRequest

public GSRequest(java.lang.String apiKey,
                 java.lang.String secretKey,
                 java.lang.String apiMethod)

GSRequest

public GSRequest(java.lang.String apiKey,
                 java.lang.String secretKey,
                 java.lang.String apiMethod,
                 GSObject clientParams,
                 boolean useHTTPS)

GSRequest

public GSRequest(java.lang.String apiKey,
                 java.lang.String secretKey,
                 java.lang.String accessToken,
                 java.lang.String apiMethod,
                 GSObject clientParams,
                 boolean useHTTPS)

GSRequest

public GSRequest(java.lang.String apiKey,
                 java.lang.String secretKey,
                 java.lang.String apiMethod,
                 GSObject clientParams,
                 boolean useHTTPS,
                 java.lang.String userKey)

GSRequest

public GSRequest(java.lang.String apiKey,
                 java.lang.String secretKey,
                 java.lang.String accessToken,
                 java.lang.String apiMethod,
                 GSObject clientParams,
                 boolean useHTTPS,
                 java.lang.String userKey)

Constructs a request using an apiKey and a secretKey. Suitable when using Gigya's proprietary authorization method. To learn more, please refer to our Using Gigya's REST API with our proprietary authorization method Guide Please provide a user ID (UID) in the params object to specify the user.

Parameters:

apiKey - your Gigya API-Key which can be obtained from the Site Setup page on Gigya's website (Read more in the Site Setup guide).

secretKey - your Gigya Secret-Key which can be obtained from the Site Setup page on Gigya's website.

apiMethod - the Gigya API method to call, including namespace. For example: "socialize.getUserInfo". Please refer to our REST API reference for the list of available methods.

clientParams - a GSObject object that contains the parameters for the Gigya API method to call. Please refer to our REST API reference and find in the specific method reference the list of method parameters. Please provide a user ID (UID) in the params object to specify the user.

useHTTPS - this parameter determines whether the request to Gigya will be sent over HTTP or HTTPS. To send of HTTPS, please set this parameter to true. The library uses HTTP (the request is signed with the session's secret key) and only uses HTTPS if the secret is not present. but you can use this parameter to override the decision.

userKey - A key of an administrative user with extra permissions. If this parameter is provided, then the secretKey parameter is assumed to be the admin user's secret key and not the site's secret key.

Method Detail

setLogger

public void setLogger(GSLogger logger)

Allows passing an existing GSLogger

Parameters:

logger -

getLogger

public GSLogger getLogger()

Retrieves the logger object

Returns:

logger object

setMethod

public void setMethod(java.lang.String apiMethod)

getMethod

public java.lang.String getMethod()

Returns:

API Method of the request

clearParams

public void clearParams()

Clear request parameters

setParam

public void setParam(java.lang.String key,
                     java.lang.String value)

Sets a request parameter with a value. If the request previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

key - key with which the specified value is to be associated

value - a String value to be associated with the specified key

setParam

public void setParam(java.lang.String key,
                     int value)

Sets a request parameter with a value. If the request previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

key - key with which the specified value is to be associated

value - a int value to be associated with the specified key

setParam

public void setParam(java.lang.String key,
                     long value)

Sets a request parameter with a value. If the request previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

key - key with which the specified value is to be associated

value - a long value to be associated with the specified key

setParam

public void setParam(java.lang.String key,
                     boolean value)

Sets a request parameter with a value. If the request previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

key - key with which the specified value is to be associated

value - a boolean value to be associated with the specified key

setParam

public void setParam(java.lang.String key,
                     GSObject value)

Sets a request parameter with a value. If the request previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

key - key with which the specified value is to be associated

value - a GSObject value to be associated with the specified key

setParam

public void setParam(java.lang.String key,
                     GSArray value)

Sets a request parameter with a value. If the request previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

key - key with which the specified value is to be associated

value - a GSArray value to be associated with the specified key

getParams

public GSObject getParams()

Returns a GSObject object containing the parameters of this request.

Returns:

the params field of this request.

setProxy

public void setProxy(java.net.Proxy p)

Sets a proxy.

Parameters:

p - a proxy settings object

setUseHTTPS

public void setUseHTTPS(boolean useHTTPS)

setParams

public void setParams(GSObject clientParams)

Sets a GSObject object containing the parameters of this request.

setAPIDomain

public void setAPIDomain(java.lang.String apiDomain)

Sets the domain used for making API calls.
Clients with sites defined under Gigya's European data center should set it to "eu1.gigya.com". To verify site location contact your implementation manager.

Parameters:

apiDomain - the domain of the data center to be used. For example: "eu1.gigya.com" for Europe data center

setHostOverride

public void setHostOverride(java.lang.String host)

send

public GSResponse send()

Sends the request synchronously. The method returns a GSResponse object which represents Gigya's response.

Returns:

a GSResponse object representing Gigya's response

send

public GSResponse send(int timeoutMS)

Sends the request synchronously. The method returns a GSResponse object which represents Gigya's response

Parameters:

timeoutMS - using this parameter you may set a timeout to this request. The timeout is the number of milliseconds till returning timeout response. If the timeout expires, the server will return a response with a "Request Timeout" error (error code 504002).

Returns:

a GSResponse object representing Gigya's response

send

public void send(GSResponseListener listener)

Sends the request asynchronously.

Parameters:

listener - an Object which implements the GSResponseListener

send

public void send(GSResponseListener listener,
                 java.lang.Object context)

Sends the request asynchronously.

Parameters:

listener - an Object which implements the GSResponseListener

context - this object will be passed untouched and received back in the response

buildQS

public static java.lang.String buildQS(GSObject params)

Converts a GSObject to a query string.

Parameters:

params - the GSObject to convert

Returns:

the query string

sendRequest

protected GSResponse sendRequest(java.lang.String httpMethod,
                                 java.lang.String domain,
                                 java.lang.String path,
                                 GSObject params,
                                 java.lang.String token,
                                 java.lang.String secret,
                                 boolean useHTTPS,
                                 boolean isLoggedIn,
                                 int timeoutMS)
                          throws java.lang.Exception

Send the actual HTTP/S request

Parameters:

httpMethod - "POST" or "GET"

domain -

path -

params -

token - session token

secret - session secret

useHTTPS - override HTTPS usage

Returns:

token and secret can be: 1. session secret & session token - for mobile login 2. OAuth token & null - from OAuth login endpoint 3. apiKey & secret - for server-to-server calls 4. apiKey & null - when passing requiresLogin=false, for calls that don't require login

Throws:

java.lang.Exception

urlEncodedParam

public java.lang.String urlEncodedParam(java.lang.String key)

UrlEncode

public static java.lang.String UrlEncode(java.lang.String value)

Applies URL encoding rules to the String value, and returns the outcome.

Parameters:

value - the string to encode

Returns:

the URL encoded string