com.smartgwt.client.rpc

Class RPCRequest

java.lang.Object

com.smartgwt.client.core.JsObject

com.smartgwt.client.core.DataClass

com.smartgwt.client.core.RefDataClass

com.smartgwt.client.rpc.RPCRequest

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers

Direct Known Subclasses:

DSRequest, WSRequest

public class RPCRequest
extends RefDataClass

Encapsulates a client/server RPC request. You'll need to provide an instance of this class (or a constructor for it) to the RPCManager.sendRequest() method. If you use the RPCManager.send() method, an instance of RPCRequest will be created for you.

See Also:

RPCManager.send(java.lang.String, com.smartgwt.client.rpc.RPCCallback, com.smartgwt.client.rpc.RPCRequest), RPCManager.sendRequest(com.smartgwt.client.rpc.RPCRequest)

Field Summary

Fields inherited from class com.smartgwt.client.core.RefDataClass

id

Fields inherited from class com.smartgwt.client.core.DataClass

factoryCreated, factoryProperties

Fields inherited from class com.smartgwt.client.core.JsObject

jsObj

Constructor Summary

Constructors

Constructor and Description
RPCRequest()
RPCRequest(com.google.gwt.core.client.JavaScriptObject jsObj)

Method Summary

Modifier and Type	Method and Description
boolean	downloadCallback(RPCResponse response, java.util.Map data, java.lang.String fileName, java.lang.String type, RPCRequest request) Callback for download requests with transport set to "xmlHttpRequest".
java.lang.String	getActionURL() Overrides RPCManager.actionURL for this request only.
java.lang.Boolean	getAllowIE9Leak() Advanced flag to avoid a potential memory leak in Internet Explorer 9 for requests with JSON formatted responses.
java.lang.Boolean	getBypassCache() For xmlHttp transport + httpMethod: "GET" only, set to true to force a conditional GET request even if the browser thinks it has a current cached response.
java.lang.String	getCallbackParam() For use only with the scriptInclude transport, this attribute specifies the name of the URL parameter which is used to specify the callback function that the server is expected to call by writing out JavaScript code.
java.lang.Boolean	getContainsCredentials() For use during Relogin, this property marks this request an attempt to login, therefore a response containing the loginRequiredMarker is a normal condition and should result in the status code STATUS_LOGIN_INCORRECT rather than a call to loginRequired().
java.lang.String	getContentType() Valid with the xmlHttpRequest transport only and only when httpMethod is set to "POST".
com.google.gwt.core.client.JavaScriptObject	getData() Returns the payload of this request to be sent to the server, as a JavaScriptObject.
java.lang.String	getDataAsString()
java.lang.Boolean	getDownloadResult() If enabled, causes the RPCRequest to download the requested resource as a file, either showing the browser's Save dialog or displaying the file-content in a new browser window.
java.lang.Boolean	getDownloadToNewWindow() When downloadResult is true, setting this attribute to true causes the content of the downloaded file to be displayed in a new browser window.
java.lang.Boolean	getEvalResult() This works similarly to serverOutputAsString except the resulting String is automatically evaluated as JavaScript.
java.util.Map	getHttpHeaders() HTTP headers to send, as a Object mapping Header name -> Header value, eg { "Content-Type" : "text/xml" }
java.lang.String	getHttpMethod() Selects the HTTP method that will be used for the request.
java.lang.String	getHttpProxyURL() The proxy URL to use for this request (if useHttpProxy is set for this request).
java.lang.Boolean	getIgnoreTimeout() When set to true, no reply is expected from the server.
java.lang.Boolean	getIsBackgroundRequest() Is this a background request?
java.lang.Boolean	getMockMode() If enabled and request is applied to RPCManager.cacheScreens() or RPCManager.loadScreen() indicates that referenced DataSources should be loaded in mock mode.
java.lang.Boolean	getOmitNullMapValuesInResponse() If enabled, the server omits any key/value pairs in map that have null values from the response.
static RPCRequest	getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
java.util.Map	getParams() Values to be sent as simple HTTP params, as a JavaScript Object where each property/value pair will become an HTTP parameter name and value.
java.lang.String	getPrompt() Overrides RPCManager.defaultPrompt for this request only.
java.lang.String	getPromptCursor() Controls the cursor shown when promptStyle is set to "cursor" for this request only.
int	getPromptDelay() Overrides RPCManager.promptDelay for this request only.
PromptStyle	getPromptStyle() Controls the prompt style for this request only.
java.lang.Boolean	getReportDownloadErrorsAsDocuments() Whether errors during download should be reported inside the document, rather than through the normal mechanism.
java.lang.Boolean	getSendNoQueue() When set to true, this request is sent to the server immediately, bypassing any current queue.
java.lang.Boolean	getServerOutputAsString() Setting this flag makes the body of the HTTP response available as a String in the callback as RPCResponse.data.
java.lang.Boolean	getShowPrompt() Overrides RPCManager.showPrompt for this request only.
java.lang.Boolean	getSuppressAutoDraw() If evalResult is set, setting this property to true causes Canvas.autoDraw to be set to false for the duration of the result evaluation - which is generally what you want if you're returning new components from the server.
java.lang.Integer	getTimeout() Sets the timeout on this request.
RPCTransport	getTransport() Selects the transport used for this RPCRequest.
boolean	getUseCursorTracker() If true, an image is shown to the right of the cursor when promptStyle is set to "cursor", otherwise the cursor itself is modified via css to the value of promptCursor.
java.lang.Boolean	getUseHttpProxy() Indicates whether this request should use the HttpProxyServlet in order to enable contacting hosts other than the origin server (available only in Pro Edition or better).
java.lang.Boolean	getUseSimpleHttp() When set to true, assume the request is not going to the Smart GWT server, and hence send a simple HTTP request that does not use Smart GWT-specific request encoding.
java.lang.Boolean	getUseStrictJSON() If set true, tells the server to use strict JSON format when serializing the response data.
java.lang.Boolean	getWillHandleError() With willHandleError:false, rpcResponses that indicate an error go through centralized handling in the RPCManager and rpcRequest.callback is never invoked.
java.lang.Boolean	getWithCredentials() In browsers that support Cross-Origin Resource Sharing and XMLHttpRequest 2, and where the service at the actionURL allows the origin to send credentials (see Access-Control-Allow-Credentials), should user credentials such as cookies, HTTP authentication, and client-side SSL certificates be sent with the actual CORS request?
protected static boolean	isDSRequest(com.google.gwt.core.client.JavaScriptObject jsObj)
RPCRequest	setActionURL(java.lang.String actionURL) Overrides RPCManager.actionURL for this request only.
RPCRequest	setAllowIE9Leak(java.lang.Boolean allowIE9Leak) Advanced flag to avoid a potential memory leak in Internet Explorer 9 for requests with JSON formatted responses.
RPCRequest	setBypassCache(java.lang.Boolean bypassCache) For xmlHttp transport + httpMethod: "GET" only, set to true to force a conditional GET request even if the browser thinks it has a current cached response.
RPCRequest	setCallbackParam(java.lang.String callbackParam) For use only with the scriptInclude transport, this attribute specifies the name of the URL parameter which is used to specify the callback function that the server is expected to call by writing out JavaScript code.
RPCRequest	setContainsCredentials(java.lang.Boolean containsCredentials) For use during Relogin, this property marks this request an attempt to login, therefore a response containing the loginRequiredMarker is a normal condition and should result in the status code STATUS_LOGIN_INCORRECT rather than a call to loginRequired().
RPCRequest	setContentType(java.lang.String contentType) Valid with the xmlHttpRequest transport only and only when httpMethod is set to "POST".
void	setData(com.google.gwt.core.client.JavaScriptObject data) This attribute specifies the payload of the RPCRequest.
RPCRequest	setData(java.util.Map data) This attribute specifies the payload of the RPCRequest.
RPCRequest	setData(Record data) This attribute specifies the payload of the RPCRequest.
RPCRequest	setData(java.lang.String data) This attribute specifies the payload of the RPCRequest.
RPCRequest	setDownloadResult(java.lang.Boolean downloadResult) If enabled, causes the RPCRequest to download the requested resource as a file, either showing the browser's Save dialog or displaying the file-content in a new browser window.
RPCRequest	setDownloadToNewWindow(java.lang.Boolean downloadToNewWindow) When downloadResult is true, setting this attribute to true causes the content of the downloaded file to be displayed in a new browser window.
RPCRequest	setEvalResult(java.lang.Boolean evalResult) This works similarly to serverOutputAsString except the resulting String is automatically evaluated as JavaScript.
RPCRequest	setEvalVars(java.util.Map evalVars) If you've set evalResult : true, then the property values of this object will be available in the evaluation scope of the result under the variable names specified by the property names.
RPCRequest	setHttpHeaders(java.util.Map httpHeaders) HTTP headers to send, as a Object mapping Header name -> Header value, eg { "Content-Type" : "text/xml" }
RPCRequest	setHttpMethod(java.lang.String httpMethod) Selects the HTTP method that will be used for the request.
RPCRequest	setHttpProxyURL(java.lang.String httpProxyURL) The proxy URL to use for this request (if useHttpProxy is set for this request).
RPCRequest	setIgnoreTimeout(java.lang.Boolean ignoreTimeout) When set to true, no reply is expected from the server.
RPCRequest	setIsBackgroundRequest(java.lang.Boolean isBackgroundRequest) Is this a background request?
RPCRequest	setMockMode(java.lang.Boolean mockMode) If enabled and request is applied to RPCManager.cacheScreens() or RPCManager.loadScreen() indicates that referenced DataSources should be loaded in mock mode.
RPCRequest	setOmitNullMapValuesInResponse(java.lang.Boolean omitNullMapValuesInResponse) If enabled, the server omits any key/value pairs in map that have null values from the response.
RPCRequest	setParams(java.util.Map params) Values to be sent as simple HTTP params, as a JavaScript Object where each property/value pair will become an HTTP parameter name and value.
RPCRequest	setPrompt(java.lang.String prompt) Overrides RPCManager.defaultPrompt for this request only.
RPCRequest	setPromptCursor(java.lang.String promptCursor) Controls the cursor shown when promptStyle is set to "cursor" for this request only.
RPCRequest	setPromptDelay(int promptDelay) Overrides RPCManager.promptDelay for this request only.
RPCRequest	setPromptStyle(PromptStyle promptStyle) Controls the prompt style for this request only.
RPCRequest	setReportDownloadErrorsAsDocuments(java.lang.Boolean reportDownloadErrorsAsDocuments) Whether errors during download should be reported inside the document, rather than through the normal mechanism.
RPCRequest	setSendNoQueue(java.lang.Boolean sendNoQueue) When set to true, this request is sent to the server immediately, bypassing any current queue.
RPCRequest	setServerOutputAsString(java.lang.Boolean serverOutputAsString) Setting this flag makes the body of the HTTP response available as a String in the callback as RPCResponse.data.
RPCRequest	setShowPrompt(java.lang.Boolean showPrompt) Overrides RPCManager.showPrompt for this request only.
RPCRequest	setSuppressAutoDraw(java.lang.Boolean suppressAutoDraw) If evalResult is set, setting this property to true causes Canvas.autoDraw to be set to false for the duration of the result evaluation - which is generally what you want if you're returning new components from the server.
RPCRequest	setTimeout(java.lang.Integer timeout) Sets the timeout on this request.
RPCRequest	setTransport(RPCTransport transport) Selects the transport used for this RPCRequest.
RPCRequest	setUseCursorTracker(boolean useCursorTracker) If true, an image is shown to the right of the cursor when promptStyle is set to "cursor", otherwise the cursor itself is modified via css to the value of promptCursor.
RPCRequest	setUseHttpProxy(java.lang.Boolean useHttpProxy) Indicates whether this request should use the HttpProxyServlet in order to enable contacting hosts other than the origin server (available only in Pro Edition or better).
RPCRequest	setUseSimpleHttp(java.lang.Boolean useSimpleHttp) When set to true, assume the request is not going to the Smart GWT server, and hence send a simple HTTP request that does not use Smart GWT-specific request encoding.
RPCRequest	setUseStrictJSON(java.lang.Boolean useStrictJSON) If set true, tells the server to use strict JSON format when serializing the response data.
RPCRequest	setWillHandleError(java.lang.Boolean willHandleError) With willHandleError:false, rpcResponses that indicate an error go through centralized handling in the RPCManager and rpcRequest.callback is never invoked.
RPCRequest	setWithCredentials(java.lang.Boolean withCredentials) In browsers that support Cross-Origin Resource Sharing and XMLHttpRequest 2, and where the service at the actionURL allows the origin to send credentials (see Access-Control-Allow-Credentials), should user credentials such as cookies, HTTP authentication, and client-side SSL certificates be sent with the actual CORS request?
void	xhr_onProgress(java.util.Map progressEvent, RPCRequest request) Progress event notification fired repeatedly during requests with transport set to "xmlHttpRequest".

Methods inherited from class com.smartgwt.client.core.RefDataClass

getRef, getRef, internalSetID

Methods inherited from class com.smartgwt.client.core.DataClass

applyFactoryProperties, doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated

Methods inherited from class com.smartgwt.client.core.JsObject

equals, getJsObj, hashCode, isCreated, setJavaScriptObject, setJsObj

Methods inherited from class java.lang.Object

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

Constructor Detail

RPCRequest

public RPCRequest()

RPCRequest

public RPCRequest(com.google.gwt.core.client.JavaScriptObject jsObj)

Method Detail

getOrCreateRef

public static RPCRequest getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

setActionURL

public RPCRequest setActionURL(java.lang.String actionURL)

Overrides RPCManager.actionURL for this request only. If you're using queuing, note that queues as per-URL - in other words all RPCRequests in a queue must go to a single URL. If you attempt to send a request with an actionURL that is different from those already in the queue, it will be sent to the server separately, ahead of the queue, and a warning will be logged to the Developer Console.

Parameters:

actionURL - New actionURL value. Default value is RPCManager.actionURL

Returns:

RPCRequest instance, for chaining setter calls

See Also:

com.smartgwt.client.rpc.RPCManager#actionURL, URL

getActionURL

public java.lang.String getActionURL()

Overrides RPCManager.actionURL for this request only. If you're using queuing, note that queues as per-URL - in other words all RPCRequests in a queue must go to a single URL. If you attempt to send a request with an actionURL that is different from those already in the queue, it will be sent to the server separately, ahead of the queue, and a warning will be logged to the Developer Console.

Returns:

Current actionURL value. Default value is RPCManager.actionURL

See Also:

com.smartgwt.client.rpc.RPCManager#actionURL, URL

setAllowIE9Leak

public RPCRequest setAllowIE9Leak(java.lang.Boolean allowIE9Leak)

Advanced flag to avoid a potential memory leak in Internet Explorer 9 for requests with JSON formatted responses.

This attribute may be set to false to explicitly enable the workaround described here for this request, avoiding a potential memory leak in Internet Explorer 9.

This workaround has a limitation in that if parsing the JSON response generates certain object types including JavaScript Date or function objects, attempts to interact with these objects can subsequently lead to a JavaScript error with the message "Can't execute code from a freed script".

This workaround therefore may not be suitable for all transactions or dataSources within a given application.

This property may also be set globally within an application (via allowIE9Leak)_.

Note: This memory leak and workaround is discussed further in the online Smart GWT FAQ.

Note : This is an advanced setting

Parameters:

allowIE9Leak - New allowIE9Leak value. Default value is null

Returns:

RPCRequest instance, for chaining setter calls

getAllowIE9Leak

public java.lang.Boolean getAllowIE9Leak()

Advanced flag to avoid a potential memory leak in Internet Explorer 9 for requests with JSON formatted responses.

This attribute may be set to false to explicitly enable the workaround described here for this request, avoiding a potential memory leak in Internet Explorer 9.

This workaround has a limitation in that if parsing the JSON response generates certain object types including JavaScript Date or function objects, attempts to interact with these objects can subsequently lead to a JavaScript error with the message "Can't execute code from a freed script".

This workaround therefore may not be suitable for all transactions or dataSources within a given application.

This property may also be set globally within an application (via allowIE9Leak)_.

Note: This memory leak and workaround is discussed further in the online Smart GWT FAQ.

Returns:

Current allowIE9Leak value. Default value is null

setBypassCache

public RPCRequest setBypassCache(java.lang.Boolean bypassCache)

For xmlHttp transport + httpMethod: "GET" only, set to true to force a conditional GET request even if the browser thinks it has a current cached response.

Note : This is an advanced setting

Parameters:

bypassCache - New bypassCache value. Default value is false

Returns:

RPCRequest instance, for chaining setter calls

getBypassCache

public java.lang.Boolean getBypassCache()

For xmlHttp transport + httpMethod: "GET" only, set to true to force a conditional GET request even if the browser thinks it has a current cached response.

Returns:

Current bypassCache value. Default value is false

setCallbackParam

public RPCRequest setCallbackParam(java.lang.String callbackParam)

For use only with the scriptInclude transport, this attribute specifies the name of the URL parameter which is used to specify the callback function that the server is expected to call by writing out JavaScript code. The actual function to call is automatically generated and differs for every request (to allow concurrency).

For example, with callbackParam set to it's default value of "callback", the server might be contacted with a URL like:

     loadData?callback=isc_scriptIncludeCallback_5
  

.. then the server's response should look like:

     isc_scriptIncludeCallback_5({ .. data .. });
  

The name "isc_scriptIncludeCallback_5" is automatically generated and will differ each time the server is contacted.

Smart GWT makes of this server-provided callback mechanism, then calls callback normally.

rpcRequest.callbackParam is ignored by all transport other than scriptInclude.

Parameters:

callbackParam - New callbackParam value. Default value is "callback"

Returns:

RPCRequest instance, for chaining setter calls

getCallbackParam

public java.lang.String getCallbackParam()

For use only with the scriptInclude transport, this attribute specifies the name of the URL parameter which is used to specify the callback function that the server is expected to call by writing out JavaScript code. The actual function to call is automatically generated and differs for every request (to allow concurrency).

For example, with callbackParam set to it's default value of "callback", the server might be contacted with a URL like:

     loadData?callback=isc_scriptIncludeCallback_5
  

.. then the server's response should look like:

     isc_scriptIncludeCallback_5({ .. data .. });
  

The name "isc_scriptIncludeCallback_5" is automatically generated and will differ each time the server is contacted.

Smart GWT makes of this server-provided callback mechanism, then calls callback normally.

rpcRequest.callbackParam is ignored by all transport other than scriptInclude.

Returns:

Current callbackParam value. Default value is "callback"

setContainsCredentials

public RPCRequest setContainsCredentials(java.lang.Boolean containsCredentials)

For use during Relogin, this property marks this request an attempt to login, therefore a response containing the loginRequiredMarker is a normal condition and should result in the status code STATUS_LOGIN_INCORRECT rather than a call to loginRequired().

It is not required to set containsCredentials, however, it does typically simplify relogin logic by separating the handling of RPCs that are login attempts from RPCs that are not.

Note : This is an advanced setting

Parameters:

containsCredentials - New containsCredentials value. Default value is false

Returns:

RPCRequest instance, for chaining setter calls

See Also:

Relogin

getContainsCredentials

public java.lang.Boolean getContainsCredentials()

For use during Relogin, this property marks this request an attempt to login, therefore a response containing the loginRequiredMarker is a normal condition and should result in the status code STATUS_LOGIN_INCORRECT rather than a call to loginRequired().

It is not required to set containsCredentials, however, it does typically simplify relogin logic by separating the handling of RPCs that are login attempts from RPCs that are not.

Returns:

Current containsCredentials value. Default value is false

See Also:

Relogin

setContentType

public RPCRequest setContentType(java.lang.String contentType)

Valid with the xmlHttpRequest transport only and only when httpMethod is set to "POST".

Parameters:

contentType - New contentType value. Default value is "application/x-www-form-urlencoded"

Returns:

RPCRequest instance, for chaining setter calls

getContentType

public java.lang.String getContentType()

Valid with the xmlHttpRequest transport only and only when httpMethod is set to "POST".

Returns:

Current contentType value. Default value is "application/x-www-form-urlencoded"

setData

public RPCRequest setData(java.lang.String data)

This attribute specifies the payload of the RPCRequest. When using the Smart GWT server, objects sent to the server as request.data will be available on the server-side RPCRequest object as Java Objects. This is achieved by serializing the client side data in a JSON type format and generating Java Objects on the server from this serialized data.

If the client side request.data is set to a Java object in your SmartGWT code it will be serialized as JSON as follows:
- Numeric client side values (int, Integer, etc) will be serialized as JavaScript numbers.
- String values will be serialized as JavaScript strings.
- Date values will be serialized as JavaScript dates.
- Maps or Record objects will be serialized as JavaScript Objects.
- Arrays or Lists will become JavaScript arrays
Serialization of Maps and Arrays is recursive - each entry in an Array, or attribute on a Map will also be serialized according to the above rules.
Note that you can also set request.data directly to a JavaScriptObject, and use the JSOHelper class or SomeObject.getJSObj() to perform your own data conversions on the client. The serialized JavaScript will then be converted back to Java on the server according to the following rules.

Here are the mapping of JavaScript types to their corresponding server object types:

JS Type	Java Type
Object: {}	Map
Array: []	List
String	String
Number	Long|Double
Boolean	Boolean
Date	java.util.Date
String	com.smartgwt.client.types.ValueEnum

Note that the order of keys/values in the Maps created on the server is not guaranteed because JavaScript Object literals do not guarantee order.

When using JPA or Hibernate Java value used can be affected by the Java Bean declaration. See DsRequestBeanTypes for details.

Server->client conversion follows this table as well, with some extras. See the toJS() method on JSTranslater in the server documentation for a description of additional behaviors.

When not communicating with the Smart GWT server, rpcRequest.data becomes simple HTTP parameters or an HTTP request body - see useSimpleHttp for details.

Parameters:

data - New data value. Default value is null

Returns:

RPCRequest instance, for chaining setter calls

See Also:

com.smartgwt.client.rpc.RPCResponse#setData

setData

public RPCRequest setData(Record data)

This attribute specifies the payload of the RPCRequest. When using the Smart GWT server, objects sent to the server as request.data will be available on the server-side RPCRequest object as Java Objects. This is achieved by serializing the client side data in a JSON type format and generating Java Objects on the server from this serialized data.

If the client side request.data is set to a Java object in your SmartGWT code it will be serialized as JSON as follows:
- Numeric client side values (int, Integer, etc) will be serialized as JavaScript numbers.
- String values will be serialized as JavaScript strings.
- Date values will be serialized as JavaScript dates.
- Maps or Record objects will be serialized as JavaScript Objects.
- Arrays or Lists will become JavaScript arrays
Serialization of Maps and Arrays is recursive - each entry in an Array, or attribute on a Map will also be serialized according to the above rules.
Note that you can also set request.data directly to a JavaScriptObject, and use the JSOHelper class or SomeObject.getJSObj() to perform your own data conversions on the client. The serialized JavaScript will then be converted back to Java on the server according to the following rules.

Here are the mapping of JavaScript types to their corresponding server object types:

JS Type	Java Type
Object: {}	Map
Array: []	List
String	String
Number	Long|Double
Boolean	Boolean
Date	java.util.Date
String	com.smartgwt.client.types.ValueEnum

Note that the order of keys/values in the Maps created on the server is not guaranteed because JavaScript Object literals do not guarantee order.

When using JPA or Hibernate Java value used can be affected by the Java Bean declaration. See DsRequestBeanTypes for details.

Server->client conversion follows this table as well, with some extras. See the toJS() method on JSTranslater in the server documentation for a description of additional behaviors.

When not communicating with the Smart GWT server, rpcRequest.data becomes simple HTTP parameters or an HTTP request body - see useSimpleHttp for details.

Parameters:

data - New data value. Default value is null

Returns:

RPCRequest instance, for chaining setter calls

See Also:

com.smartgwt.client.rpc.RPCResponse#setData

setData

public RPCRequest setData(java.util.Map data)

This attribute specifies the payload of the RPCRequest. When using the Smart GWT server, objects sent to the server as request.data will be available on the server-side RPCRequest object as Java Objects. This is achieved by serializing the client side data in a JSON type format and generating Java Objects on the server from this serialized data.

If the client side request.data is set to a Java object in your SmartGWT code it will be serialized as JSON as follows:
- Numeric client side values (int, Integer, etc) will be serialized as JavaScript numbers.
- String values will be serialized as JavaScript strings.
- Date values will be serialized as JavaScript dates.
- Maps or Record objects will be serialized as JavaScript Objects.
- Arrays or Lists will become JavaScript arrays
Serialization of Maps and Arrays is recursive - each entry in an Array, or attribute on a Map will also be serialized according to the above rules.
Note that you can also set request.data directly to a JavaScriptObject, and use the JSOHelper class or SomeObject.getJSObj() to perform your own data conversions on the client. The serialized JavaScript will then be converted back to Java on the server according to the following rules.

Here are the mapping of JavaScript types to their corresponding server object types:

JS Type	Java Type
Object: {}	Map
Array: []	List
String	String
Number	Long|Double
Boolean	Boolean
Date	java.util.Date
String	com.smartgwt.client.types.ValueEnum

Note that the order of keys/values in the Maps created on the server is not guaranteed because JavaScript Object literals do not guarantee order.

When using JPA or Hibernate Java value used can be affected by the Java Bean declaration. See DsRequestBeanTypes for details.

Server->client conversion follows this table as well, with some extras. See the toJS() method on JSTranslater in the server documentation for a description of additional behaviors.

When not communicating with the Smart GWT server, rpcRequest.data becomes simple HTTP parameters or an HTTP request body - see useSimpleHttp for details.

Parameters:

data - New data value. Default value is null

Returns:

RPCRequest instance, for chaining setter calls

See Also:

com.smartgwt.client.rpc.RPCResponse#setData

setDownloadResult

public RPCRequest setDownloadResult(java.lang.Boolean downloadResult)

If enabled, causes the RPCRequest to download the requested resource as a file, either showing the browser's Save dialog or displaying the file-content in a new browser window.

Download requests will use transport: "hiddenFrame" by default.

In this mode, the download will be performed by a standard HTTP request issued by the browser. If DSRequest.downloadToNewWindow is true, the request will be targeted against a new browser window, and if the resulting file can be displayed inline by the browser it will be. If DSRequest.downloadToNewWindow is not true, or the browser cannot display the returned file inline, the browser will download the file and store it to the user's file system.

Download requests with transport: "hiddenFrame" do not fire any callbacks.

If a developer explicitly sets request.transport to "xmlHttpRequest", the browser will instead use an XMLHttpRequest to download the data from the server. This mode differs from hiddenFrame downloads in various ways:

• Explicit httpHeaders may be sent to the server in this mode
• Instead of automatically downloading the response to the user's filesystem, the server response will be available as a Blob, and the downloadCallback() will be invoked, if specified.
  Returning false from the downloadCallback will suppress the default behavior of saving the file to the user's filesystem, giving developers an opportunity to take other actions, such as generating a data URL from the Blob.
• xmlHttpRequest download does not have a built-in progress bar to indicate download progress. Developers may make use of the xhr_onProgress() event to indicate download progress if required.

Note : This is an advanced setting

Parameters:

downloadResult - New downloadResult value. Default value is false

Returns:

RPCRequest instance, for chaining setter calls

getDownloadResult

public java.lang.Boolean getDownloadResult()

If enabled, causes the RPCRequest to download the requested resource as a file, either showing the browser's Save dialog or displaying the file-content in a new browser window.

Download requests will use transport: "hiddenFrame" by default.

In this mode, the download will be performed by a standard HTTP request issued by the browser. If DSRequest.downloadToNewWindow is true, the request will be targeted against a new browser window, and if the resulting file can be displayed inline by the browser it will be. If DSRequest.downloadToNewWindow is not true, or the browser cannot display the returned file inline, the browser will download the file and store it to the user's file system.

Download requests with transport: "hiddenFrame" do not fire any callbacks.

If a developer explicitly sets request.transport to "xmlHttpRequest", the browser will instead use an XMLHttpRequest to download the data from the server. This mode differs from hiddenFrame downloads in various ways:

• Explicit httpHeaders may be sent to the server in this mode
• Instead of automatically downloading the response to the user's filesystem, the server response will be available as a Blob, and the downloadCallback() will be invoked, if specified.
  Returning false from the downloadCallback will suppress the default behavior of saving the file to the user's filesystem, giving developers an opportunity to take other actions, such as generating a data URL from the Blob.
• xmlHttpRequest download does not have a built-in progress bar to indicate download progress. Developers may make use of the xhr_onProgress() event to indicate download progress if required.

Returns:

Current downloadResult value. Default value is false

setDownloadToNewWindow

public RPCRequest setDownloadToNewWindow(java.lang.Boolean downloadToNewWindow)

When downloadResult is true, setting this attribute to true causes the content of the downloaded file to be displayed in a new browser window.

Note that this setting is currently incompatible with transport:"xmlHttpRequest". See the downloadResult documentation for more details on xmlHttpRequest downloads

Note : This is an advanced setting

Parameters:

downloadToNewWindow - New downloadToNewWindow value. Default value is false

Returns:

RPCRequest instance, for chaining setter calls

getDownloadToNewWindow

public java.lang.Boolean getDownloadToNewWindow()

When downloadResult is true, setting this attribute to true causes the content of the downloaded file to be displayed in a new browser window.

Note that this setting is currently incompatible with transport:"xmlHttpRequest". See the downloadResult documentation for more details on xmlHttpRequest downloads

Returns:

Current downloadToNewWindow value. Default value is false

setEvalResult

public RPCRequest setEvalResult(java.lang.Boolean evalResult)

This works similarly to serverOutputAsString except the resulting String is automatically evaluated as JavaScript. The result of the evaluation is then passed to any specified callback as RPCResponse.data.

This feature can be used to dynamically load new application modules into a running application. An RPCRequest with evalResult enabled can be used to fetch a static .js file or JavaScript dynamically generated by the server. The returned JavaScript can contain anything that a JavaScript file loaded at init time can contain, including new views and new Smart GWT class definitions.

Example usage with RPCManager.sendRequest():

       RPCRequest rpcRequestProperties = new RPCRequest();
       rpcRequestProperties.setEvalResult(true);
       rpcRequestProperties.setActionURL("js/loadLabel.js");
       Map evalVars = new HashMap();
       evalVars.put(var1, "A Value");
       rpcRequestProperties.setEvalVars(evalVars);
       RPCManager.sendRequest(rpcRequestProperties);     
  

This call would execute the code from loadLabel.js, and make the variable var1 available to that code. Therefore if the .js file contained this code:

       Label label = new Label();
       label.setContents(var1);
  

A label would be created with contents set to the value of var1 - the string "A Value".

This feature relies on the XMLHttpRequest object which can be disabled by end-users in some supported browsers. See PlatformDependencies for more information.

Note : This is an advanced setting

Parameters:

evalResult - New evalResult value. Default value is false

Returns:

RPCRequest instance, for chaining setter calls

See Also:

ViewLoader, setEvalVars(java.util.Map)

getEvalResult

public java.lang.Boolean getEvalResult()

This works similarly to serverOutputAsString except the resulting String is automatically evaluated as JavaScript. The result of the evaluation is then passed to any specified callback as RPCResponse.data.

This feature can be used to dynamically load new application modules into a running application. An RPCRequest with evalResult enabled can be used to fetch a static .js file or JavaScript dynamically generated by the server. The returned JavaScript can contain anything that a JavaScript file loaded at init time can contain, including new views and new Smart GWT class definitions.

Example usage with RPCManager.sendRequest():

       RPCRequest rpcRequestProperties = new RPCRequest();
       rpcRequestProperties.setEvalResult(true);
       rpcRequestProperties.setActionURL("js/loadLabel.js");
       Map evalVars = new HashMap();
       evalVars.put(var1, "A Value");
       rpcRequestProperties.setEvalVars(evalVars);
       RPCManager.sendRequest(rpcRequestProperties);     
  

This call would execute the code from loadLabel.js, and make the variable var1 available to that code. Therefore if the .js file contained this code:

       Label label = new Label();
       label.setContents(var1);
  

A label would be created with contents set to the value of var1 - the string "A Value".

This feature relies on the XMLHttpRequest object which can be disabled by end-users in some supported browsers. See PlatformDependencies for more information.

Returns:

Current evalResult value. Default value is false

See Also:

ViewLoader, com.smartgwt.client.rpc.RPCRequest#getEvalVars

setEvalVars

public RPCRequest setEvalVars(java.util.Map evalVars)

If you've set evalResult : true, then the property values of this object will be available in the evaluation scope of the result under the variable names specified by the property names.

So e.g. if evalVars is: {foo: "bar"} then a reference to the variable foo in the result will evaluate to "bar".

Note : This is an advanced setting

Parameters:

evalVars - New evalVars value. Default value is null

Returns:

RPCRequest instance, for chaining setter calls

setHttpHeaders

public RPCRequest setHttpHeaders(java.util.Map httpHeaders)

HTTP headers to send, as a Object mapping Header name -> Header value, eg
{ "Content-Type" : "text/xml" }

Valid with the xmlHttpRequest transport only.

Parameters:

httpHeaders - New httpHeaders value. Default value is null

Returns:

RPCRequest instance, for chaining setter calls

getHttpHeaders

public java.util.Map getHttpHeaders()

HTTP headers to send, as a Object mapping Header name -> Header value, eg
{ "Content-Type" : "text/xml" }

Valid with the xmlHttpRequest transport only.

Returns:

Current httpHeaders value. Default value is null

setHttpMethod

public RPCRequest setHttpMethod(java.lang.String httpMethod)

Selects the HTTP method that will be used for the request. Typical values are "POST" and "GET".

The more obscure "PUT", "DELETE" and "HEAD" methods are also valid, however, none of these are supported by the Safari browser previous to version 3.0.

Parameters:

httpMethod - New httpMethod value. Default value is "POST"

Returns:

RPCRequest instance, for chaining setter calls

getHttpMethod

public java.lang.String getHttpMethod()

Selects the HTTP method that will be used for the request. Typical values are "POST" and "GET".

The more obscure "PUT", "DELETE" and "HEAD" methods are also valid, however, none of these are supported by the Safari browser previous to version 3.0.

Returns:

Current httpMethod value. Default value is "POST"

setHttpProxyURL

public RPCRequest setHttpProxyURL(java.lang.String httpProxyURL)

The proxy URL to use for this request (if useHttpProxy is set for this request). If unset, the value of httpProxyURL will be used instead.

Parameters:

httpProxyURL - New httpProxyURL value. Default value is null

Returns:

RPCRequest instance, for chaining setter calls

See Also:

com.smartgwt.client.rpc.RPCManager#httpProxyURL

getHttpProxyURL

public java.lang.String getHttpProxyURL()

The proxy URL to use for this request (if useHttpProxy is set for this request). If unset, the value of httpProxyURL will be used instead.

Returns:

Current httpProxyURL value. Default value is null

See Also:

com.smartgwt.client.rpc.RPCManager#httpProxyURL

setIgnoreTimeout

public RPCRequest setIgnoreTimeout(java.lang.Boolean ignoreTimeout)

When set to true, no reply is expected from the server. However, if a reply is received, it will be processed.

Note: setting this to true, forces sendNoQueue to true for this request.

Note : This is an advanced setting

Parameters:

ignoreTimeout - New ignoreTimeout value. Default value is false

Returns:

RPCRequest instance, for chaining setter calls

getIgnoreTimeout

public java.lang.Boolean getIgnoreTimeout()

When set to true, no reply is expected from the server. However, if a reply is received, it will be processed.

Note: setting this to true, forces sendNoQueue to true for this request.

Returns:

Current ignoreTimeout value. Default value is false

setIsBackgroundRequest

public RPCRequest setIsBackgroundRequest(java.lang.Boolean isBackgroundRequest)

Is this a background request?

This attribute may be set to true for requests that do not interfere with the normal flow of user interaction within an application.

Background requests are ignored by AutoTest.waitForSystemDone(), giving automated testing tools a way to identify specific operations that should not interfere with the flow of the test, without entirely disabling the ability to wait for network operations.

Parameters:

isBackgroundRequest - New isBackgroundRequest value. Default value is null

Returns:

RPCRequest instance, for chaining setter calls

getIsBackgroundRequest

public java.lang.Boolean getIsBackgroundRequest()

Is this a background request?

This attribute may be set to true for requests that do not interfere with the normal flow of user interaction within an application.

Background requests are ignored by AutoTest.waitForSystemDone(), giving automated testing tools a way to identify specific operations that should not interfere with the flow of the test, without entirely disabling the ability to wait for network operations.

Returns:

Current isBackgroundRequest value. Default value is null

setMockMode

public RPCRequest setMockMode(java.lang.Boolean mockMode)

If enabled and request is applied to RPCManager.cacheScreens() or RPCManager.loadScreen() indicates that referenced DataSources should be loaded in mock mode.

Parameters:

mockMode - New mockMode value. Default value is null

Returns:

RPCRequest instance, for chaining setter calls

getMockMode

public java.lang.Boolean getMockMode()

If enabled and request is applied to RPCManager.cacheScreens() or RPCManager.loadScreen() indicates that referenced DataSources should be loaded in mock mode.

Returns:

Current mockMode value. Default value is null

setOmitNullMapValuesInResponse

public RPCRequest setOmitNullMapValuesInResponse(java.lang.Boolean omitNullMapValuesInResponse)

If enabled, the server omits any key/value pairs in map that have null values from the response. This can reduce the size of the response when many fields have null values.

To enable this globally for all responses you can set RPCManager.omitNullMapValuesInResponse in server.properties.

Note that SQL DataSources don't add nulls to results for null values so this flag does nothing in that case.

Note : This is an advanced setting

Parameters:

omitNullMapValuesInResponse - New omitNullMapValuesInResponse value. Default value is false

Returns:

RPCRequest instance, for chaining setter calls

getOmitNullMapValuesInResponse

public java.lang.Boolean getOmitNullMapValuesInResponse()

If enabled, the server omits any key/value pairs in map that have null values from the response. This can reduce the size of the response when many fields have null values.

To enable this globally for all responses you can set RPCManager.omitNullMapValuesInResponse in server.properties.

Note that SQL DataSources don't add nulls to results for null values so this flag does nothing in that case.

Returns:

Current omitNullMapValuesInResponse value. Default value is false

setParams

public RPCRequest setParams(java.util.Map params)

Values to be sent as simple HTTP params, as a JavaScript Object where each property/value pair will become an HTTP parameter name and value. These parameters are then accessible on the server, for example, using servletRequest.getParameter(paramName) in Java Servlets.

Array-valued parameters will be submitted as multiple instances of the same parameter, similar to an HTML form with a multi-select (?paramName=value1&paramName=value2 ...), accessible as getParameterValues(paramName) in Java Servlets. Any non-atomic type, such as an Object, will be serialized to JSON by the JSONEncoder. If this isn't desirable, serialize the data in advance so that the value provided in rpcRequest.params is a String.

Note that this API is primarily used in combination with useSimpleHttp - when contacting the Smart GWT Server, use data instead, which provides full JavaScript <-> Java translation of arbitrary structures. rpcRequest.params can also be used with the Smart GWT Server, where it provides an an opportunity to send additional data aside from the main data payload. This is useful for adding data to DataSource requests which will be kept separate from the automatically sent DataSource data, or for making parts of the request visible in the URL for HTTP-level logging or layer 4 switches.

Note that in contrast to data object, the data in rpcRequest.params is not deserialized by the Smart GWT server, and all values arrive on the server as String type (like HTTP parameters always do).

Note: The params are submitted once per http transaction. If you are using request queuing to bundle multiple RPCRequests or DSRequests into a single HTTP turnaround, the params from the various RPCRequests will be merged, with the later-queued transactions winning on parameter name collisions. A warning will be logged in the Developer Console if multiple RPCRequests specified params.

Parameters:

params - New params value. Default value is null

Returns:

RPCRequest instance, for chaining setter calls

getParams

public java.util.Map getParams()

Values to be sent as simple HTTP params, as a JavaScript Object where each property/value pair will become an HTTP parameter name and value. These parameters are then accessible on the server, for example, using servletRequest.getParameter(paramName) in Java Servlets.

Array-valued parameters will be submitted as multiple instances of the same parameter, similar to an HTML form with a multi-select (?paramName=value1&paramName=value2 ...), accessible as getParameterValues(paramName) in Java Servlets. Any non-atomic type, such as an Object, will be serialized to JSON by the JSONEncoder. If this isn't desirable, serialize the data in advance so that the value provided in rpcRequest.params is a String.

Note that this API is primarily used in combination with useSimpleHttp - when contacting the Smart GWT Server, use data instead, which provides full JavaScript <-> Java translation of arbitrary structures. rpcRequest.params can also be used with the Smart GWT Server, where it provides an an opportunity to send additional data aside from the main data payload. This is useful for adding data to DataSource requests which will be kept separate from the automatically sent DataSource data, or for making parts of the request visible in the URL for HTTP-level logging or layer 4 switches.

Note that in contrast to data object, the data in rpcRequest.params is not deserialized by the Smart GWT server, and all values arrive on the server as String type (like HTTP parameters always do).

Note: The params are submitted once per http transaction. If you are using request queuing to bundle multiple RPCRequests or DSRequests into a single HTTP turnaround, the params from the various RPCRequests will be merged, with the later-queued transactions winning on parameter name collisions. A warning will be logged in the Developer Console if multiple RPCRequests specified params.

Returns:

Current params value. Default value is null

setPrompt

public RPCRequest setPrompt(java.lang.String prompt)

Overrides RPCManager.defaultPrompt for this request only. If you're using queuing, note that the prompt string from the first request in the queue is the one that is shown to the user.

Parameters:

prompt - New prompt value. Default value is RPCManager.defaultPrompt

Returns:

RPCRequest instance, for chaining setter calls

See Also:

com.smartgwt.client.rpc.RPCManager#defaultPrompt, com.smartgwt.client.rpc.RPCManager#showPrompt, com.smartgwt.client.rpc.RPCManager#promptStyle, com.smartgwt.client.rpc.RPCManager#promptCursor, setShowPrompt(java.lang.Boolean), setPromptStyle(com.smartgwt.client.types.PromptStyle), setPromptCursor(java.lang.String), HTMLString, RpcPrompt overview and related methods

getPrompt

public java.lang.String getPrompt()

Overrides RPCManager.defaultPrompt for this request only. If you're using queuing, note that the prompt string from the first request in the queue is the one that is shown to the user.

Returns:

Current prompt value. Default value is RPCManager.defaultPrompt

See Also:

com.smartgwt.client.rpc.RPCManager#defaultPrompt, com.smartgwt.client.rpc.RPCManager#showPrompt, com.smartgwt.client.rpc.RPCManager#promptStyle, com.smartgwt.client.rpc.RPCManager#promptCursor, getShowPrompt(), getPromptStyle(), getPromptCursor(), HTMLString, RpcPrompt overview and related methods

setPromptCursor

public RPCRequest setPromptCursor(java.lang.String promptCursor)

Controls the cursor shown when promptStyle is set to "cursor" for this request only. Defaults to promptCursor.

Parameters:

promptCursor - New promptCursor value. Default value is "progress"

Returns:

RPCRequest instance, for chaining setter calls

See Also:

com.smartgwt.client.rpc.RPCManager#promptCursor, RpcPrompt overview and related methods

getPromptCursor

public java.lang.String getPromptCursor()

Controls the cursor shown when promptStyle is set to "cursor" for this request only. Defaults to promptCursor.

Returns:

Current promptCursor value. Default value is "progress"

See Also:

com.smartgwt.client.rpc.RPCManager#promptCursor, RpcPrompt overview and related methods

setPromptDelay

public RPCRequest setPromptDelay(int promptDelay)

Overrides RPCManager.promptDelay for this request only. Defaults to promptDelay.

If you're using queuing, note that the promptDelay of the first request is used for the entire queue.

Note : This is an advanced setting

Parameters:

promptDelay - New promptDelay value. Default value is RPCManager.promptDelay

Returns:

RPCRequest instance, for chaining setter calls

See Also:

setShowPrompt(java.lang.Boolean), com.smartgwt.client.rpc.RPCManager#promptDelay, RpcPrompt overview and related methods

getPromptDelay

public int getPromptDelay()

Overrides RPCManager.promptDelay for this request only. Defaults to promptDelay.

If you're using queuing, note that the promptDelay of the first request is used for the entire queue.

Returns:

Current promptDelay value. Default value is RPCManager.promptDelay

See Also:

getShowPrompt(), com.smartgwt.client.rpc.RPCManager#promptDelay, RpcPrompt overview and related methods

setPromptStyle

public RPCRequest setPromptStyle(PromptStyle promptStyle)

Controls the prompt style for this request only. Defaults to promptStyle.

Parameters:

promptStyle - New promptStyle value. Default value is RPCManager.promptStyle

Returns:

RPCRequest instance, for chaining setter calls

See Also:

com.smartgwt.client.rpc.RPCManager#promptStyle, RpcPrompt overview and related methods

getPromptStyle

public PromptStyle getPromptStyle()

Controls the prompt style for this request only. Defaults to promptStyle.

Returns:

Current promptStyle value. Default value is RPCManager.promptStyle

See Also:

com.smartgwt.client.rpc.RPCManager#promptStyle, RpcPrompt overview and related methods

setReportDownloadErrorsAsDocuments

public RPCRequest setReportDownloadErrorsAsDocuments(java.lang.Boolean reportDownloadErrorsAsDocuments)

Whether errors during download should be reported inside the document, rather than through the normal mechanism. If unset, this will be defaulted from reportDownloadErrorsAsDocuments.

Parameters:

reportDownloadErrorsAsDocuments - New reportDownloadErrorsAsDocuments value. Default value is null

Returns:

RPCRequest instance, for chaining setter calls

getReportDownloadErrorsAsDocuments

public java.lang.Boolean getReportDownloadErrorsAsDocuments()

Whether errors during download should be reported inside the document, rather than through the normal mechanism. If unset, this will be defaulted from reportDownloadErrorsAsDocuments.

Returns:

Current reportDownloadErrorsAsDocuments value. Default value is null

setSendNoQueue

public RPCRequest setSendNoQueue(java.lang.Boolean sendNoQueue)

When set to true, this request is sent to the server immediately, bypassing any current queue.

Note : This is an advanced setting

Parameters:

sendNoQueue - New sendNoQueue value. Default value is false

Returns:

RPCRequest instance, for chaining setter calls

getSendNoQueue

public java.lang.Boolean getSendNoQueue()

When set to true, this request is sent to the server immediately, bypassing any current queue.

Returns:

Current sendNoQueue value. Default value is false

setServerOutputAsString

public RPCRequest setServerOutputAsString(java.lang.Boolean serverOutputAsString)

Setting this flag makes the body of the HTTP response available as a String in the callback as RPCResponse.data. This is typically only useful if you are sending a request that will not be received by the Smart GWT Java Server, however in that case, set useSimpleHttp:true instead, which implies serverOutputAsString:true.

serverOutputAsString:true allows you to, for example, load the contents of static files off your webserver into a string for processing on the client with no server support. The actionURL must be in the same domain as the current page for this to work.

This feature relies on the XMLHttpRequest object which can be disabled by end-users in some supported browsers. See PlatformDependencies for more information.

Generally this API is used for either non-Java backends or for advanced usage such as content that requires processing before it can be used in Smart GWT components (such as client-side web scraping). Note that Smart GWT provides higher-level APIs for loading common types of data, see eg HTMLFlow for HTML content, ViewLoader for loading Smart GWT components, XMLTools.loadXML() for loading XML, evalResult for loading JSON, and DataSource for loading structured data in various formats.

Note : This is an advanced setting

Parameters:

serverOutputAsString - New serverOutputAsString value. Default value is false

Returns:

RPCRequest instance, for chaining setter calls

getServerOutputAsString

public java.lang.Boolean getServerOutputAsString()

Setting this flag makes the body of the HTTP response available as a String in the callback as RPCResponse.data. This is typically only useful if you are sending a request that will not be received by the Smart GWT Java Server, however in that case, set useSimpleHttp:true instead, which implies serverOutputAsString:true.

serverOutputAsString:true allows you to, for example, load the contents of static files off your webserver into a string for processing on the client with no server support. The actionURL must be in the same domain as the current page for this to work.

This feature relies on the XMLHttpRequest object which can be disabled by end-users in some supported browsers. See PlatformDependencies for more information.

Generally this API is used for either non-Java backends or for advanced usage such as content that requires processing before it can be used in Smart GWT components (such as client-side web scraping). Note that Smart GWT provides higher-level APIs for loading common types of data, see eg HTMLFlow for HTML content, ViewLoader for loading Smart GWT components, XMLTools.loadXML() for loading XML, evalResult for loading JSON, and DataSource for loading structured data in various formats.

Returns:

Current serverOutputAsString value. Default value is false

setShowPrompt

public RPCRequest setShowPrompt(java.lang.Boolean showPrompt)

Overrides RPCManager.showPrompt for this request only.

If you're using queuing, note that if any of the requests in the queue specify showPrompt:true, then a prompt will be shown for the entire queue with the prompt text of the first request in the queue to specify a custom prompt if promptStyle is set to "dialog".

If promptStyle is set to "cursor" for the request that specified showPrompt: true, then the entire queue uses the "cursor" style for the prompt.

Parameters:

showPrompt - New showPrompt value. Default value is null

Returns:

RPCRequest instance, for chaining setter calls

See Also:

com.smartgwt.client.rpc.RPCManager#showPrompt, setPromptStyle(com.smartgwt.client.types.PromptStyle), RpcPrompt overview and related methods

getShowPrompt

public java.lang.Boolean getShowPrompt()

Overrides RPCManager.showPrompt for this request only.

If you're using queuing, note that if any of the requests in the queue specify showPrompt:true, then a prompt will be shown for the entire queue with the prompt text of the first request in the queue to specify a custom prompt if promptStyle is set to "dialog".

If promptStyle is set to "cursor" for the request that specified showPrompt: true, then the entire queue uses the "cursor" style for the prompt.

Returns:

Current showPrompt value. Default value is null

See Also:

com.smartgwt.client.rpc.RPCManager#showPrompt, getPromptStyle(), RpcPrompt overview and related methods

setSuppressAutoDraw

public RPCRequest setSuppressAutoDraw(java.lang.Boolean suppressAutoDraw)

If evalResult is set, setting this property to true causes Canvas.autoDraw to be set to false for the duration of the result evaluation - which is generally what you want if you're returning new components from the server.

This also effects components loaded via the RPCManager.loadScreen() API.

Note : This is an advanced setting

Parameters:

suppressAutoDraw - New suppressAutoDraw value. Default value is true

Returns:

RPCRequest instance, for chaining setter calls

getSuppressAutoDraw

public java.lang.Boolean getSuppressAutoDraw()

If evalResult is set, setting this property to true causes Canvas.autoDraw to be set to false for the duration of the result evaluation - which is generally what you want if you're returning new components from the server.

This also effects components loaded via the RPCManager.loadScreen() API.

Returns:

Current suppressAutoDraw value. Default value is true

setTimeout

public RPCRequest setTimeout(java.lang.Integer timeout)

Sets the timeout on this request. Default is to use defaultTimeout.

If you're using queuing, note that the timeout setting derived from the last request in the queue is used for the entire queue. If you want to override the timeout for the queue, make sure to set your override at least on the last request in the queue.

For the "xmlHttpRequest" transport, this timeout can only happen if the server actually fails to respond within the specified number of milliseconds. For the "hiddenFrame" transport, this timeout will occur for non-200 (HTTP_OK) responses.

If timeout is set to zero, the RPCManager will not enforce a timeout for this request. However, note that all browsers enforce their own timeouts on HTTP requests, and may have different timeouts for different kinds of failures (no response at all from server, hung response after receiving headers, hung response after receiving partial data, etc). Also, intervening web proxies or firewalls may impose timeouts of their own.

As a rough rule of thumb, if your server response will have a lengthy pause before data begins to be sent, 1-2 minutes is the maximum allowable pause for a public site and still may not work for a minority of users, but up to 4 minutes may be allowable in a controlled environment (intranet or extranet with well-known user base).

Above these limits, your code should return some kind of immediate response to the browser, then kick off a server-side process to complete processing. The browser can then either poll for completion, or use a server-push notification system such as Smart GWT Real-Time Messaging (see http://smartclient.com/product).

Note : This is an advanced setting

Parameters:

timeout - New timeout value. Default value is null

Returns:

RPCRequest instance, for chaining setter calls

See Also:

com.smartgwt.client.rpc.RPCManager#defaultTimeout

getTimeout

public java.lang.Integer getTimeout()

Sets the timeout on this request. Default is to use defaultTimeout.

If you're using queuing, note that the timeout setting derived from the last request in the queue is used for the entire queue. If you want to override the timeout for the queue, make sure to set your override at least on the last request in the queue.

For the "xmlHttpRequest" transport, this timeout can only happen if the server actually fails to respond within the specified number of milliseconds. For the "hiddenFrame" transport, this timeout will occur for non-200 (HTTP_OK) responses.

If timeout is set to zero, the RPCManager will not enforce a timeout for this request. However, note that all browsers enforce their own timeouts on HTTP requests, and may have different timeouts for different kinds of failures (no response at all from server, hung response after receiving headers, hung response after receiving partial data, etc). Also, intervening web proxies or firewalls may impose timeouts of their own.

As a rough rule of thumb, if your server response will have a lengthy pause before data begins to be sent, 1-2 minutes is the maximum allowable pause for a public site and still may not work for a minority of users, but up to 4 minutes may be allowable in a controlled environment (intranet or extranet with well-known user base).

Above these limits, your code should return some kind of immediate response to the browser, then kick off a server-side process to complete processing. The browser can then either poll for completion, or use a server-push notification system such as Smart GWT Real-Time Messaging (see http://smartclient.com/product).

Returns:

Current timeout value. Default value is null

See Also:

com.smartgwt.client.rpc.RPCManager#defaultTimeout

setTransport

public RPCRequest setTransport(RPCTransport transport)

Selects the transport used for this RPCRequest. If unset, the value of defaultTransport will be used.

If you're using queueing, note that all requests in the queue must use the same transport. If you attempt to send a request via a different transport than those that are currently on the queue, it will be sent to the server separately, ahead of the queue, and a warning will be logged to the Developer Console.

If you specify an unknown transport, an error will be logged to the DeveloperConsole and defaultTransport will be used instead.

If you specify the xmlHttpRequest transport and it is not available, a warning will be logged to the Developer Console and the RPCManager will attempt to use the hiddenFrame transport instead for this request. Note that some features like serverOutputAsString require the xmlHttpRequest transport and will not work if the xmlHttpRequest transport is unavailable (this can happen if the end user is using Internet Explorer and has disabled ActiveX). You can check whether or not the xmlHttpRequest transport is currently available by calling RPCManager.xmlHttpRequestAvailable().

Note : This is an advanced setting

Parameters:

transport - New transport value. Default value is RPCManager.defaultTransport

Returns:

RPCRequest instance, for chaining setter calls

See Also:

com.smartgwt.client.rpc.RPCManager#defaultTransport

getTransport

public RPCTransport getTransport()

Selects the transport used for this RPCRequest. If unset, the value of defaultTransport will be used.

If you're using queueing, note that all requests in the queue must use the same transport. If you attempt to send a request via a different transport than those that are currently on the queue, it will be sent to the server separately, ahead of the queue, and a warning will be logged to the Developer Console.

If you specify an unknown transport, an error will be logged to the DeveloperConsole and defaultTransport will be used instead.

If you specify the xmlHttpRequest transport and it is not available, a warning will be logged to the Developer Console and the RPCManager will attempt to use the hiddenFrame transport instead for this request. Note that some features like serverOutputAsString require the xmlHttpRequest transport and will not work if the xmlHttpRequest transport is unavailable (this can happen if the end user is using Internet Explorer and has disabled ActiveX). You can check whether or not the xmlHttpRequest transport is currently available by calling RPCManager.xmlHttpRequestAvailable().

Returns:

Current transport value. Default value is RPCManager.defaultTransport

See Also:

com.smartgwt.client.rpc.RPCManager#defaultTransport

setUseCursorTracker

public RPCRequest setUseCursorTracker(boolean useCursorTracker)

If true, an image is shown to the right of the cursor when promptStyle is set to "cursor", otherwise the cursor itself is modified via css to the value of promptCursor.

If left unspecified, the default value is set by useCursorTracker.

Parameters:

useCursorTracker - New useCursorTracker value. Default value is false

Returns:

RPCRequest instance, for chaining setter calls

See Also:

com.smartgwt.client.rpc.RPCManager#useCursorTracker, RpcPrompt overview and related methods

getUseCursorTracker

public boolean getUseCursorTracker()

If true, an image is shown to the right of the cursor when promptStyle is set to "cursor", otherwise the cursor itself is modified via css to the value of promptCursor.

If left unspecified, the default value is set by useCursorTracker.

Returns:

Current useCursorTracker value. Default value is false

See Also:

com.smartgwt.client.rpc.RPCManager#useCursorTracker, RpcPrompt overview and related methods

setUseHttpProxy

public RPCRequest setUseHttpProxy(java.lang.Boolean useHttpProxy)

Indicates whether this request should use the HttpProxyServlet in order to enable contacting hosts other than the origin server (available only in Pro Edition or better).

When various UI components issues requests automatically, or when a call to RPCManager.sendProxied() is made, the HttpProxy will automatically be used for a URL that starts with "http" and uses a hostname other than "localhost" or window.location.hostname, or if the port number differs.

rpcRequest.useHttpProxy should only be used to force requests to go through the HttpProxy when the above rules don't work, or to avoid using the HttpProxy when contacting hosts that allow cross-site calls via the Http Access Control standard.

You can also set useHttpProxy:false to avoid ever using the HttpProxyServlet.

Parameters:

useHttpProxy - New useHttpProxy value. Default value is null

Returns:

RPCRequest instance, for chaining setter calls

getUseHttpProxy

public java.lang.Boolean getUseHttpProxy()

Indicates whether this request should use the HttpProxyServlet in order to enable contacting hosts other than the origin server (available only in Pro Edition or better).

When various UI components issues requests automatically, or when a call to RPCManager.sendProxied() is made, the HttpProxy will automatically be used for a URL that starts with "http" and uses a hostname other than "localhost" or window.location.hostname, or if the port number differs.

rpcRequest.useHttpProxy should only be used to force requests to go through the HttpProxy when the above rules don't work, or to avoid using the HttpProxy when contacting hosts that allow cross-site calls via the Http Access Control standard.

You can also set useHttpProxy:false to avoid ever using the HttpProxyServlet.

Returns:

Current useHttpProxy value. Default value is null

setUseSimpleHttp

public RPCRequest setUseSimpleHttp(java.lang.Boolean useSimpleHttp)

When set to true, assume the request is not going to the Smart GWT server, and hence send a simple HTTP request that does not use Smart GWT-specific request encoding.

Values specified in params are sent to to the server as HTTP request parameters. If httpMethod is "GET", parameters appear in the request URL, otherwise if httpMethod is "POST", parameters are encoded in the request body (exactly like an HTML form does). These parameters are then accessible via typical server-side APIs for retrieving HTTP parameters, eg, servletRequest.getParameter(paramName) in Java Servlets.

Note that if httpMethod method is POST and data is supplied, data is assumed to be a string to post as the HTTP request body, and params are sent as URL parameters instead. This usage is for sending custom request bodies such as the XML payloads used for SOAP. In this case, contentType is typically also set to indicate the content type of the request body.

Setting useSimpleHttp to true also automatically sets serverOutputAsString to true as well.

Note : This is an advanced setting

Parameters:

useSimpleHttp - New useSimpleHttp value. Default value is false

Returns:

RPCRequest instance, for chaining setter calls

getUseSimpleHttp

public java.lang.Boolean getUseSimpleHttp()

When set to true, assume the request is not going to the Smart GWT server, and hence send a simple HTTP request that does not use Smart GWT-specific request encoding.

Values specified in params are sent to to the server as HTTP request parameters. If httpMethod is "GET", parameters appear in the request URL, otherwise if httpMethod is "POST", parameters are encoded in the request body (exactly like an HTML form does). These parameters are then accessible via typical server-side APIs for retrieving HTTP parameters, eg, servletRequest.getParameter(paramName) in Java Servlets.

Note that if httpMethod method is POST and data is supplied, data is assumed to be a string to post as the HTTP request body, and params are sent as URL parameters instead. This usage is for sending custom request bodies such as the XML payloads used for SOAP. In this case, contentType is typically also set to indicate the content type of the request body.

Setting useSimpleHttp to true also automatically sets serverOutputAsString to true as well.

Returns:

Current useSimpleHttp value. Default value is false

setUseStrictJSON

public RPCRequest setUseStrictJSON(java.lang.Boolean useStrictJSON)

If set true, tells the server to use strict JSON format when serializing the response data. If set false, tells the server to use a more permissive encoding that is still valid JS, but is not technically valid JSON. The default value of null tells the server to use the default global setting (see below).

To enable this globally for all responses you can set RPCManager.useStrictJSON in server.properties. If the global flag is not set either way in server.properties, it defaults to false.

Note : This is an advanced setting

Parameters:

useStrictJSON - New useStrictJSON value. Default value is null

Returns:

RPCRequest instance, for chaining setter calls

See Also:

DSRequest.setUseStrictJSON(java.lang.Boolean)

getUseStrictJSON

public java.lang.Boolean getUseStrictJSON()

If set true, tells the server to use strict JSON format when serializing the response data. If set false, tells the server to use a more permissive encoding that is still valid JS, but is not technically valid JSON. The default value of null tells the server to use the default global setting (see below).

To enable this globally for all responses you can set RPCManager.useStrictJSON in server.properties. If the global flag is not set either way in server.properties, it defaults to false.

Returns:

Current useStrictJSON value. Default value is null

See Also:

DSRequest.getUseStrictJSON()

setWillHandleError

public RPCRequest setWillHandleError(java.lang.Boolean willHandleError)

With willHandleError:false, rpcResponses that indicate an error go through centralized handling in the RPCManager and rpcRequest.callback is never invoked.

Setting willHandleError:true means that your rpcRequest.callback will receive rpcResponses that have an error status and must handle them.

See also the error handling section in the RPCManager docs.

Parameters:

willHandleError - New willHandleError value. Default value is false

Returns:

RPCRequest instance, for chaining setter calls

See Also:

RPCManager, Error Handling Overview

getWillHandleError

public java.lang.Boolean getWillHandleError()

With willHandleError:false, rpcResponses that indicate an error go through centralized handling in the RPCManager and rpcRequest.callback is never invoked.

Setting willHandleError:true means that your rpcRequest.callback will receive rpcResponses that have an error status and must handle them.

See also the error handling section in the RPCManager docs.

Returns:

Current willHandleError value. Default value is false

See Also:

RPCManager, Error Handling Overview

setWithCredentials

public RPCRequest setWithCredentials(java.lang.Boolean withCredentials)

In browsers that support Cross-Origin Resource Sharing and XMLHttpRequest 2, and where the service at the actionURL allows the origin to send credentials (see Access-Control-Allow-Credentials), should user credentials such as cookies, HTTP authentication, and client-side SSL certificates be sent with the actual CORS request?

This setting only applies when the request transport is RPCTransport.XMLHTTPREQUEST.

Note that Internet Explorer 10 and 11 do not send cookies as part of user credentials: IE10 doesn't support cookies on cross origin XMLHttpRequest withCredentials=true.

Note : This is an advanced setting

Parameters:

withCredentials - New withCredentials value. Default value is null

Returns:

RPCRequest instance, for chaining setter calls

getWithCredentials

public java.lang.Boolean getWithCredentials()

In browsers that support Cross-Origin Resource Sharing and XMLHttpRequest 2, and where the service at the actionURL allows the origin to send credentials (see Access-Control-Allow-Credentials), should user credentials such as cookies, HTTP authentication, and client-side SSL certificates be sent with the actual CORS request?

This setting only applies when the request transport is RPCTransport.XMLHTTPREQUEST.

Note that Internet Explorer 10 and 11 do not send cookies as part of user credentials: IE10 doesn't support cookies on cross origin XMLHttpRequest withCredentials=true.

Returns:

Current withCredentials value. Default value is null

downloadCallback

public boolean downloadCallback(RPCResponse response,
                                java.util.Map data,
                                java.lang.String fileName,
                                java.lang.String type,
                                RPCRequest request)

Callback for download requests with transport set to "xmlHttpRequest".

This method will fire when a download request completes. If DSRequest.willHandleError is true it will fire on both successful completion or failure as reflected by the DSResponse.status.

By default, successful download requests will save the returned file to the filesystem. To suppress this behavior, return false from this callback. This allows you to take some other action such as generating a data url to display media, etc.

Note that for a successful download request, the data parameter will be a Blob. For an unsuccessful download attempt, the data parameter typically contains the error message from the server. To invoke standard error handling, RPCManager.runDefaultErrorHandling() may be called.

Parameters:

response - the response to the request

data - The Blob returned by the server, or error message if the download was unsuccessful

fileName - The file name for the downloaded file, derived from the content-disposition header.

type - the content type for the downloaded file, as specified by the content-type header.

request - the request that initiated the download

Returns:

return false to suppress default behavior of saving the download file to the user's filesystem.

xhr_onProgress

public void xhr_onProgress(java.util.Map progressEvent,
                           RPCRequest request)

Progress event notification fired repeatedly during requests with transport set to "xmlHttpRequest".

This callback will be invoked from the native XMLHttpRequest progress event.

This is typically useful to provide visual feedback to the user when a lengthy download is in progress.

Parameters:

progressEvent - The native ProgressEvent with attributes indicating the loaded content so far, and, if Content-Length headers were set on the response, the total download size. Note that this is a native event produced by the browser and Smart GWT does not guarantee consistency for the event object, or the timing of the onprogress event notifications across browsers.

request - the request that initiated the download

setData

public void setData(com.google.gwt.core.client.JavaScriptObject data)

This attribute specifies the payload of the RPCRequest. When using the Smart GWT server, objects sent to the server as request.data will be available on the server-side RPCRequest object as Java Objects. This is achieved by serializing the client side data in a JSON type format and generating Java Objects on the server from this serialized data.

If the client side request.data is set to a Java object in your SmartGWT code on the client side, logic in your server side code will be passed the following equivalent objects:

Client	Server Type
boolean primitive or Boolean	Boolean
Non-fractional numeric value (e.g: int, Integer, long, Long)	Long
Fractional numeric value (e.g:float, Float, double, Double)	Double
String	String
Date	Date
List, Set, Iterator	List
Map	Map
Record	Map
RecordList	List of Map
ResultSet	List of Map (containing only loaded rows if the ResultSet has a partial cache on the client)

Note that the order of keys/values in the Maps created on the server is not guaranteed because JavaScript Object literals do not guarantee order.

Server->client conversion follows this table as well, with some extras. See the toJS() method on JSTranslater in the server documentation for a description of additional behaviors.

When not communicating with the Smart GWT server, rpcRequest.data becomes simple HTTP parameters or an HTTP request body - see useSimpleHttp for details.

Parameters:

data - data Default value is null

See Also:

RPCResponse.getDataAsMap(), RPCResponse.getDataAsObject(), RPCResponse.getDataAsString()

getData

public com.google.gwt.core.client.JavaScriptObject getData()

Returns the payload of this request to be sent to the server, as a JavaScriptObject.

When using the Smart GWT server, objects sent to the server as request.data will be available on the server-side RPCRequest object as Java Objects. This is achieved by serializing the client side data in a JSON type format and generating Java Objects on the server from this serialized data.

If the client side request.data is set to a Java object in your SmartGWT code on the client side, logic in your server side code will be passed the following equivalent objects:

Client	Server Type
boolean primitive or Boolean	Boolean
Non-fractional numeric value (e.g: int, Integer, long, Long)	Long
Fractional numeric value (e.g:float, Float, double, Double)	Double
String	String
Date	Date
List, Set, Iterator	List
Map	Map
Record	Map
RecordList	List of Map
ResultSet	List of Map (containing only loaded rows if the ResultSet has a partial cache on the client)

Note that the order of keys/values in the Maps created on the server is not guaranteed because JavaScript Object literals do not guarantee order.

Server->client conversion follows this table as well, with some extras. See the toJS() method on JSTranslater in the server documentation for a description of additional behaviors.

When not communicating with the Smart GWT server, rpcRequest.data becomes simple HTTP parameters or an HTTP request body - see useSimpleHttp for details.

See Also:

RPCResponse.getDataAsMap(), RPCResponse.getDataAsObject(), RPCResponse.getDataAsString()

getDataAsString

public java.lang.String getDataAsString()

isDSRequest

protected static boolean isDSRequest(com.google.gwt.core.client.JavaScriptObject jsObj)