com.gigya.socialize

Class GSResponse

java.lang.Object

com.gigya.socialize.GSResponse

public class GSResponse
extends java.lang.Object

Wraps Gigya server's response.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>	headers

Constructor Summary

Constructors

Modifier	Constructor and Description
	GSResponse(java.lang.String method, GSObject params, int errorCode, GSLogger traceSoFar)
	GSResponse(java.lang.String method, GSObject params, int errorCode, java.lang.String errorMessage, GSLogger traceSoFar)
	GSResponse(java.lang.String method, GSObject params, int errorCode, java.lang.String errorMessage, java.lang.String errorDetails, GSLogger traceSoFar)
protected	GSResponse(java.lang.String method, java.lang.String responseText, GSLogger traceSoFar)

Method Summary

Modifier and Type	Method and Description
GSArray	getArray(java.lang.String key, GSArray defaultValue) Returns the GSArray value to which the specified key is mapped, or the defaultValue if this dictionary contains no mapping for the key.
boolean	getBool(java.lang.String key, boolean defaultValue) Returns the boolean value to which the specified key is mapped, or the defaultValue if this dictionary contains no mapping for the key.
GSObject	getData() Returns the response data in GSObject.
double	getDouble(java.lang.String key, double defaultValue) Returns the double value to which the specified key is mapped, or the defaultValue if this dictionary contains no mapping for the key.
int	getErrorCode() Returns the result code of the operation.
java.lang.String	getErrorDetails() Returns a description of the response error, for logging purposes.
java.lang.String	getErrorMessage() Returns a short textual description of the response error, for logging purposes.
static java.lang.String	getErrorMessage(int errorCode)
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getHeaders()
int	getInt(java.lang.String key, int defaultValue) Returns the int value to which the specified key is mapped, or the defaultValue if this dictionary contains no mapping for the key.
java.lang.String	getLog()
long	getLong(java.lang.String key, long defaultValue) Returns the long value to which the specified key is mapped, or the defaultValue if this dictionary contains no mapping for the key.
GSObject	getObject(java.lang.String key, GSObject defaultValue) Returns the GSObject value to which the specified key is mapped, or the defaultValue if this dictionary contains no mapping for the key.
java.lang.String	getResponseText() Returns the raw response data.
java.lang.String	getString(java.lang.String key, java.lang.String defaultValue) Returns the String value to which the specified key is mapped, or the defaultValue if this dictionary contains no mapping for the key.
boolean	hasData()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

headers

protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers

Constructor Detail

GSResponse

public GSResponse(java.lang.String method,
                  GSObject params,
                  int errorCode,
                  GSLogger traceSoFar)

GSResponse

public GSResponse(java.lang.String method,
                  GSObject params,
                  int errorCode,
                  java.lang.String errorMessage,
                  GSLogger traceSoFar)

GSResponse

public GSResponse(java.lang.String method,
                  GSObject params,
                  int errorCode,
                  java.lang.String errorMessage,
                  java.lang.String errorDetails,
                  GSLogger traceSoFar)

GSResponse

protected GSResponse(java.lang.String method,
                     java.lang.String responseText,
                     GSLogger traceSoFar)

Method Detail

getErrorCode

public int getErrorCode()

Returns the result code of the operation. Code '0' indicates success, any other number indicates failure. For the complete list of server error codes, see the Error Codes table.

Returns:

the error code

getErrorMessage

public java.lang.String getErrorMessage()

Returns a short textual description of the response error, for logging purposes.

Returns:

the error message string

getErrorDetails

public java.lang.String getErrorDetails()

Returns a description of the response error, for logging purposes.

Returns:

the error details string

getResponseText

public java.lang.String getResponseText()

Returns the raw response data. The raw response data is in JSON format, by default. If the request was sent with the format parameter set to "xml", the raw response data will be in XML format.

Returns:

the raw response data

getData

public GSObject getData()

Returns the response data in GSObject. Please refer to Gigya's REST API reference, for a list of response data structure per method request. Note: If the request was sent with the format parameter set to "xml", the getData() will return null and you should use getResponseText() method instead. We only parse response text into GSObject if the request format is "json", which is the default.

Returns:

a GSObject containing the response data

hasData

public boolean hasData()

getLog

public java.lang.String getLog()

getHeaders

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getHeaders()

getBool

public boolean getBool(java.lang.String key,
                       boolean defaultValue)

Returns the boolean value to which the specified key is mapped, or the defaultValue if this dictionary contains no mapping for the key.

Parameters:

key - the key whose associated value is to be returned

defaultValue - the boolean value to be returned if this dictionary doesn't contain the specified key.

Returns:

the boolean value to which the specified key is mapped, or the defaultValue if this dictionary contains no mapping for the key.

getInt

public int getInt(java.lang.String key,
                  int defaultValue)

Returns the int value to which the specified key is mapped, or the defaultValue if this dictionary contains no mapping for the key.

Parameters:

key - the key whose associated value is to be returned

defaultValue - the int value to be returned if this dictionary doesn't contain the specified key.

Returns:

the int value to which the specified key is mapped, or the defaultValue if this dictionary contains no mapping for the key.

getLong

public long getLong(java.lang.String key,
                    long defaultValue)

Returns the long value to which the specified key is mapped, or the defaultValue if this dictionary contains no mapping for the key.

Parameters:

key - the key whose associated value is to be returned

defaultValue - the long value to be returned if this dictionary doesn't contain the specified key.

Returns:

the long value to which the specified key is mapped, or the defaultValue if this dictionary contains no mapping for the key.

getDouble

public double getDouble(java.lang.String key,
                        double defaultValue)

Returns the double value to which the specified key is mapped, or the defaultValue if this dictionary contains no mapping for the key.

Parameters:

key - the key whose associated value is to be returned

defaultValue - the double value to be returned if this dictionary doesn't contain the specified key.

Returns:

the double value to which the specified key is mapped, or the defaultValue if this dictionary contains no mapping for the key.

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.String defaultValue)

Returns the String value to which the specified key is mapped, or the defaultValue if this dictionary contains no mapping for the key.

Parameters:

key - the key whose associated value is to be returned

defaultValue - the String value to be returned if this dictionary doesn't contain the specified key.

Returns:

the String value to which the specified key is mapped, or the defaultValue if this dictionary contains no mapping for the key.

getObject

public GSObject getObject(java.lang.String key,
                          GSObject defaultValue)

Returns the GSObject value to which the specified key is mapped, or the defaultValue if this dictionary contains no mapping for the key.

Parameters:

key - the key whose associated value is to be returned

defaultValue - the GSObject value to be returned if this dictionary doesn't contain the specified key.

Returns:

the GSObject value to which the specified key is mapped, or the defaultValue if this dictionary contains no mapping for the key.

getArray

public GSArray getArray(java.lang.String key,
                        GSArray defaultValue)

Returns the GSArray value to which the specified key is mapped, or the defaultValue if this dictionary contains no mapping for the key.

Parameters:

key - the key whose associated value is to be returned

defaultValue - the GSArray value to be returned if this dictionary doesn't contain the specified key.

Returns:

the GSArray value to which the specified key is mapped, or the defaultValue if this dictionary contains no mapping for the key.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getErrorMessage

public static java.lang.String getErrorMessage(int errorCode)