com.worklight.wlclient.api

Class WLRequestOptions

java.lang.Object

com.worklight.wlclient.api.WLRequestOptions

public class WLRequestOptions
extends java.lang.Object

This class changes the timeout and invocation context.

Constructor Summary

Constructors

Constructor and Description
WLRequestOptions()

Method Summary

Modifier and Type	Method and Description
void	addHeader(java.lang.String name, java.lang.String value)
void	addParameter(java.lang.String name, java.lang.String value)
java.lang.Object	getInvocationContext() Return the user invocation context
<any>	getOkHeaders()
java.util.Map<java.lang.String,java.lang.String>	getParameters()
WLResponseListener	getResponseListener()
int	getTimeout() This method gets the request timeout that you currently use.
boolean	isAZRequest()
boolean	isFromChallenge()
boolean	isJsonContentType()
boolean	isTextContentType()
void	setAZRequest(boolean isAZRequest) Set true for authorization requests
void	setFromChallenge(boolean flag)
void	setInvocationContext(java.lang.Object invocationContext) User can add to the request any object, that will be available on the callback (success/failure) functions.
void	setJsonContentType(boolean isJsonContentType)
void	setResponseListener(WLResponseListener responseListener)
void	setTextContentType(boolean isTextContent)
void	setTimeout(int timeout) This method sets a new timeout.

Methods inherited from class java.lang.Object

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

Constructor Detail

WLRequestOptions

public WLRequestOptions()

Method Detail

getTimeout

public int getTimeout()

This method gets the request timeout that you currently use. The default request timeout is 10 seconds.

Returns:

The timeout, in milliseconds, to wait for the procedure invocation. If the timeout expires, the WLResponseListener.onFailure(WLFailResponse) method is called. The value 0 indicates that there is no timeout.

setTimeout

public void setTimeout(int timeout)

This method sets a new timeout.

Parameters:

timeout - The timeout, in milliseconds, to wait for the procedure invocation. If the timeout expires, the WLResponseListener.onFailure(WLFailResponse) method is called. The value 0 indicates that there is no timeout.

getInvocationContext

public java.lang.Object getInvocationContext()

Return the user invocation context

Returns:

An object that is returned with WLResponse to the listener methods onSuccess and onFailure.
You can use this object to identify and distinguish different invokeProcedure calls.
This object is returned as is to the listener methods

setInvocationContext

public void setInvocationContext(java.lang.Object invocationContext)

User can add to the request any object, that will be available on the callback (success/failure) functions.

Parameters:

invocationContext - An object that is returned with WLResponse to the listener methods onSuccess and onFailure.
You can use this object to identify and distinguish different invokeProcedure calls.
This object is returned as is to the listener methods.

getParameters

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

getResponseListener

public WLResponseListener getResponseListener()

setResponseListener

public void setResponseListener(WLResponseListener responseListener)

addParameter

public void addParameter(java.lang.String name,
                         java.lang.String value)

addHeader

public void addHeader(java.lang.String name,
                      java.lang.String value)

getOkHeaders

public <any> getOkHeaders()

isFromChallenge

public boolean isFromChallenge()

setFromChallenge

public void setFromChallenge(boolean flag)

isJsonContentType

public boolean isJsonContentType()

setJsonContentType

public void setJsonContentType(boolean isJsonContentType)

isAZRequest

public boolean isAZRequest()

setAZRequest

public void setAZRequest(boolean isAZRequest)

Set true for authorization requests

Parameters:

isAZRequest -

isTextContentType

public boolean isTextContentType()

setTextContentType

public void setTextContentType(boolean isTextContent)