com.worklight.wlclient.api

Class WLResponse

java.lang.Object

com.worklight.wlclient.api.WLResponse

Direct Known Subclasses:

WLFailResponse, WLProcedureInvocationResult

public class WLResponse
extends java.lang.Object

This class contains the result of a procedure invocation.

Constructor Summary

Constructors

Constructor and Description
WLResponse(Response httpResponse)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFirstHeader(java.lang.String headerName) Returns the first header from the response that matches the given header name.
java.util.List<java.lang.String>	getHeader(java.lang.String text)
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getHeaders()
java.lang.Object	getInvocationContext() Retrieves the invocation context object that is passed when the WLClient.invokeProcedure(WLProcedureInvocationData, WLResponseListener) method is called.
WLRequestOptions	getOptions()
byte[]	getResponseBytes() Retrieves the original response from the server, in the form of an array of bytes.
JSONObject	getResponseJSON()
java.lang.String	getResponseText() Retrieves the original response text from the server.
int	getStatus() Retrieves the HTTP status from the response.
java.lang.String	getStatusText()
void	setOptions(WLRequestOptions wlOptions)
void	setResponseText(java.lang.String _responseText)
void	setStatusText(java.lang.String statusText)
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WLResponse

public WLResponse(Response httpResponse)

Method Detail

getStatus

public int getStatus()

Retrieves the HTTP status from the response.

getInvocationContext

public java.lang.Object getInvocationContext()

Retrieves the invocation context object that is passed when the WLClient.invokeProcedure(WLProcedureInvocationData, WLResponseListener) method is called.

If this response did not originate from a procedure invocation, null is returned.

getResponseBytes

public byte[] getResponseBytes()

Retrieves the original response from the server, in the form of an array of bytes.

getResponseText

public java.lang.String getResponseText()

Retrieves the original response text from the server.

setResponseText

public void setResponseText(java.lang.String _responseText)

Parameters:

_responseText -

getOptions

public WLRequestOptions getOptions()

setOptions

public void setOptions(WLRequestOptions wlOptions)

getHeaders

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

Returns:

An array of Headers

getHeader

public java.util.List<java.lang.String> getHeader(java.lang.String text)

getFirstHeader

public java.lang.String getFirstHeader(java.lang.String headerName)

Returns the first header from the response that matches the given header name.

Parameters:

headerName - Name of header to search for

Returns:

First header with the given name, or null if no such headers exist.

getResponseJSON

public JSONObject getResponseJSON()

Returns:

JSON object obtained from response text.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getStatusText

public java.lang.String getStatusText()

setStatusText

public void setStatusText(java.lang.String statusText)