Class RPCResponse
- All Implemented Interfaces:
HasHandlers
- Direct Known Subclasses:
DSResponse
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intIndicates that a response with invalid format has been received from server.static final intIndicates aDeclarative Securityfailure on the server.static final intThis response code only occurs when using the HTTP proxy.static final intstatic final intIndicates a generic failure on the server.static final intIndicates that an empty file was uploaded for a required 'binary' field.static final intIndicates that the RPC has been intercepted by an authenticator that requires the user to log in.static final intIndicates that a login is required before this RPCRequest can proceed.static final intIndicates that the login succeeded.static final intIndicates that an uploaded file's size exceeded the maximum file size allowed.static final intIndicates that too many authentication attempts have been made and the server refuses to accept any more login attempts.static final intIndicates that the total size of the data sent to the server was more than the server is configured to allow.static final intIndicates that the browser is currently offline, and that we do not hold a cached response for the request.static final intIndicates that an operation binding configured to requireOperationBinding.requiredCriterionhas received none.static final intIndicates a request timed out with no server response.static final intIndicates successful completion of the request.static final intIndicates that the request was either never attempted or was rolled back, because automatic or user transactions are in force and another request in the same transaction failed.static final intThis response code is usable only with the XMLHttpRequest transport and indicates that the server returned an HTTP response code outside the range 200-299 (all of these statuses indicate success, but ordinarily only 200 is used).static final intThis response code only occurs when using the HTTP proxy.static final intIndicates that the client attempted an update or remove operation without providing primary key field(s)static final intIndicates a validation failure on the server.Fields inherited from class com.smartgwt.client.core.RefDataClass
idFields inherited from class com.smartgwt.client.core.DataClass
factoryCreated, factoryProperties -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic voidcreate()RPCResponses shouldn't be created directly.The data sent by the server.The data sent by the server.The data sent by the server.HTTP headers returned by the server as a map from header name to header value.This attribute (available when using the thexmlHttpRequesttransport) contains the HTTP response code sent by the server.The actual text of the HTTP response.static RPCResponsegetOrCreateRef(JavaScriptObject jsObj) intStatus code for this response.ID of the transaction sent to the server viaRPCManager.sendQueue()containing theRPCRequestassociated with this response.protected static booleanisDSResponse(JavaScriptObject jsObj) setStatus(int status) Status code for this response.Methods inherited from class com.smartgwt.client.core.RefDataClass
getRef, getRef, internalSetIDMethods 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
-
Field Details
-
INVALID_RESPONSE_FORMAT
public static final int INVALID_RESPONSE_FORMATIndicates that a response with invalid format has been received from server. If the datasource is using "iscServer" dataFormat, this means that the response is not recognized as a valid ISC frame.One possible cause for this error can be the reception of a RestDataSource JSON response that lacks a valid
RestDataSource.jsonPrefixand/orRestDataSource.jsonSuffixIf it is using "xml" or "json" dataFormat, the response could not be parsed as XML or JSON.
- See Also:
-
STATUS_AUTHORIZATION_FAILURE
public static final int STATUS_AUTHORIZATION_FAILUREIndicates aDeclarative Securityfailure on the server. See the error handling section inRPCManager documentationfor more information.- See Also:
-
STATUS_CONNECTION_RESET_ERROR
public static final int STATUS_CONNECTION_RESET_ERRORThis response code only occurs when using the HTTP proxy. It is issued by the proxy servlet when the attempt to contact the target server results in a Java SocketException. This response probably indicates that the target server is currently down.- See Also:
-
STATUS_CRITERIA_REQUIRED_ERROR
public static final int STATUS_CRITERIA_REQUIRED_ERROR- See Also:
-
STATUS_FAILURE
public static final int STATUS_FAILUREIndicates a generic failure on the server. See the error handling section inRPCManager documentationfor more information.- See Also:
-
STATUS_FILE_REQUIRED_ERROR
public static final int STATUS_FILE_REQUIRED_ERRORIndicates that an empty file was uploaded for a required 'binary' field.- See Also:
-
STATUS_LOGIN_INCORRECT
public static final int STATUS_LOGIN_INCORRECTIndicates that the RPC has been intercepted by an authenticator that requires the user to log in.- See Also:
-
STATUS_LOGIN_REQUIRED
public static final int STATUS_LOGIN_REQUIREDIndicates that a login is required before this RPCRequest can proceed.Applications do not directly set this status code, instead, to trigger the relogin flow, return the loginRequiredMarker in the response sent by your server when login is required. See the
Relogin Overviewfor details.- See Also:
-
STATUS_LOGIN_SUCCESS
public static final int STATUS_LOGIN_SUCCESSIndicates that the login succeeded.- See Also:
-
STATUS_MAX_FILE_SIZE_EXCEEDED
public static final int STATUS_MAX_FILE_SIZE_EXCEEDEDIndicates that an uploaded file's size exceeded the maximum file size allowed.- See Also:
-
STATUS_MAX_LOGIN_ATTEMPTS_EXCEEDED
public static final int STATUS_MAX_LOGIN_ATTEMPTS_EXCEEDEDIndicates that too many authentication attempts have been made and the server refuses to accept any more login attempts.- See Also:
-
STATUS_MAX_POST_SIZE_EXCEEDED
public static final int STATUS_MAX_POST_SIZE_EXCEEDEDIndicates that the total size of the data sent to the server was more than the server is configured to allow. Most servers limit the post size to prevent out of memory style attack vectors that push a bunch of data at the server. Apache Tomcat, for example, is pre-configured to limit post size to 2mb, where the default max post-size in Jetty, used by default in Eclipse, is just 200k.On internal networks, these limits can typically be safely raised or removed. With Tomcat, for example, you can remove the post limit by specifying the following attribute on the <Connector> element in conf/server.xml:
maxPostSize="-1"
In Jetty, you can update or create war/WEB-INF/jetty-web.xml, adding a section like this
<Configure class="org.eclipse.jetty.webapp.WebAppContext"/> <Set name="maxFormContentSize">2000000</Set> </Configure>NOTE: this status code is used whenever the server framework receives a request where the POST data has been removed, however, there are other possible causes, including:- security software installed on the server or network that erroneously detects some kind of exploit attempt, if its behavior is to just strip the POST data but allow the rest of the request through (SiteMinder is one product known to do this)
- incorrectly written filter servlets that drop POST'd data
- See Also:
-
STATUS_OFFLINE
public static final int STATUS_OFFLINEIndicates that the browser is currently offline, and that we do not hold a cached response for the request.- See Also:
-
STATUS_REQUIRED_CRITERIA_MISSING
public static final int STATUS_REQUIRED_CRITERIA_MISSINGIndicates that an operation binding configured to requireOperationBinding.requiredCriterionhas received none.- See Also:
-
STATUS_SERVER_TIMEOUT
public static final int STATUS_SERVER_TIMEOUTIndicates a request timed out with no server response.This is a client-only error code - never sent by the server (since it's the server that times out).
NOTE that if using
hiddenFrameas the transport (not the default), a malformed response such as a "500 Server Error" or 404 errors will be reported as a timeout.- See Also:
-
STATUS_SUCCESS
public static final int STATUS_SUCCESSIndicates successful completion of the request. This is the default status and is automatically used by the RPCResponse on the server unless you override it with setStatus().
See the error handling section inRPCManager documentationfor more information.- See Also:
-
STATUS_TRANSACTION_FAILED
public static final int STATUS_TRANSACTION_FAILEDIndicates that the request was either never attempted or was rolled back, because automatic or user transactions are in force and another request in the same transaction failed. Note that the request(s) that actually failed will have a code specific to the failure; it is only the requests that would otherwise have succeeded that are marked with this failure code.- See Also:
-
STATUS_TRANSPORT_ERROR
public static final int STATUS_TRANSPORT_ERRORThis response code is usable only with the XMLHttpRequest transport and indicates that the server returned an HTTP response code outside the range 200-299 (all of these statuses indicate success, but ordinarily only 200 is used). To get the actual response code, you can query rpcResponse.httpResponseCode in your callback.Note that currently this error code will never occur for the
hiddenFrametransport - instead, useSTATUS_SERVER_TIMEOUTto detecthiddenFrametransport errors.- See Also:
-
STATUS_UNKNOWN_HOST_ERROR
public static final int STATUS_UNKNOWN_HOST_ERRORThis response code only occurs when using the HTTP proxy. It is issued by the proxy servlet when the target host is unknown (ie, cannot be resolved through DNS). This response probably indicates that you are attempting to contact a nonexistent server (though it might mean that you have DNS problems).- See Also:
-
STATUS_UPDATE_WITHOUT_PK_ERROR
public static final int STATUS_UPDATE_WITHOUT_PK_ERRORIndicates that the client attempted an update or remove operation without providing primary key field(s)- See Also:
-
STATUS_VALIDATION_ERROR
public static final int STATUS_VALIDATION_ERRORIndicates a validation failure on the server. See the error handling section inRPCManager documentationfor more information.- See Also:
-
-
Constructor Details
-
RPCResponse
public RPCResponse() -
RPCResponse
-
-
Method Details
-
getOrCreateRef
-
getHttpHeaders
HTTP headers returned by the server as a map from header name to header value.Headers are available only when the default
RPCTransport"xmlHttpRequest" is in use, and browsers may limit access to headers for cross-domain requests or in other security-sensitive scenarios.- Returns:
- Current httpHeaders value. Default value is null
-
getHttpResponseCode
This attribute (available when using the thexmlHttpRequesttransport) contains the HTTP response code sent by the server.Note that this is different from
status- that attribute is used to indicate a status code for the RPC itself whereas httpResponseCode is the raw HTTP response code for the HTTP request that contained the RPCRequest.This feature relies on the XMLHttpRequest object which can be disabled by end-users in some supported browsers. See
PlatformDependenciesfor more information.If you're using this attribute, you'll typically want to avoid the default error handling response of RPCManager. To do so, set
RPCRequest.willHandleErrortotrue.- Returns:
- Current httpResponseCode value. Default value is null
-
getHttpResponseText
The actual text of the HTTP response. Only available when the defaultRPCTransport"xmlHttpRequest" transport is in use,- Returns:
- Current httpResponseText value. Default value is null
-
setStatus
Status code for this response. Status codes less than zero are considered errors by the RPCManager, those greater than or equal to zero are considered successes. Please see the error handling section theRPCManager docsfor more information on what the RPCManager does with the status code and how you can override this behavior.When using the Smart GWT server you can set the rpcResponse.status by calling the server-side method RPCResponse.setStatus().
When not using the Smart GWT server, the RPCManager makes no assumptions about the structure of the response, so the status code just reflects the
httpResponseCode: status will beSTATUS_TRANSPORT_ERRORif an HTTP-level error occurred such as "500 server error". If you have a status code you need to transmit you can simply embed it in the response (as part ofdata) and interpret it from the callback.With or without the Smart GWT server, the
Reloginstatus codes (such asSTATUS_LOGIN_REQUIRED) are triggered whenever special markers, such as the loginRequiredMarker, appear in the body of the response. See theRelogin\n Overviewfor details.- Parameters:
status- New status value. Default value is 0- Returns:
RPCResponseinstance, for chaining setter calls- See Also:
-
getStatus
public int getStatus()Status code for this response. Status codes less than zero are considered errors by the RPCManager, those greater than or equal to zero are considered successes. Please see the error handling section theRPCManager docsfor more information on what the RPCManager does with the status code and how you can override this behavior.When using the Smart GWT server you can set the rpcResponse.status by calling the server-side method RPCResponse.setStatus().
When not using the Smart GWT server, the RPCManager makes no assumptions about the structure of the response, so the status code just reflects the
httpResponseCode: status will beSTATUS_TRANSPORT_ERRORif an HTTP-level error occurred such as "500 server error". If you have a status code you need to transmit you can simply embed it in the response (as part ofdata) and interpret it from the callback.With or without the Smart GWT server, the
Reloginstatus codes (such asSTATUS_LOGIN_REQUIRED) are triggered whenever special markers, such as the loginRequiredMarker, appear in the body of the response. See theRelogin\n Overviewfor details.- Returns:
- Current status value. Default value is 0
- See Also:
-
getTransactionNum
ID of the transaction sent to the server viaRPCManager.sendQueue()containing theRPCRequestassociated with this response.- Returns:
- Current transactionNum value. Default value is null
-
create
public static void create()RPCResponses shouldn't be created directly. Instances of this class are automatically created and optionally passed to you in the callback you specify as part of yourRPCRequest. -
getDataAsMap
The data sent by the server.When communicating with the SmartClient server,
rpcResponse.datais the data passed to the server-side methodRPCResponse.setData()by your Java code. This data is translated into JavaScript objects by the rules described underrpcRequest.datain the SmartClient Reference. Simple types (Numeric values, Strings, Dates, Booleans) will be available as their equivalent Java types in your client side GWT code. Complex objects (such as serializedMaps orLists from the server) will not be automatically translated back into Java on the client - they will arrive asJavaScriptObjectinstances. You can easily convert to the appropriate type yourself using theJSOHelperclass. TheJSOHelper.convertToJava(JavaScriptObject, boolean)method performs a recursive conversion ofJavaScriptObjects returning aList(or array) for JavaScript arrays or aMapfor simple JavaScript objects (key:value pairs).When not communicating with the SmartClient server
rpcResponse.datacontains the raw HTTP response body. SeerpcRequest.useSimpleHttp, rpcRequest.serverOutputAsString,rpcRequest.evalResultin the SmartClient Reference for details.- Returns:
- the data in the RPC response, as a Map
- See Also:
-
getDataAsString
The data sent by the server.When communicating with the SmartClient server,
rpcResponse.datais the data passed to the server-side methodRPCResponse.setData()by your Java code. This data is translated into JavaScript objects by the rules described underrpcRequest.datain the SmartClient Reference. Simple types (Numeric values, Strings, Dates, Booleans) will be available as their equivalent Java types in your client side GWT code. Complex objects (such as serializedMaps orLists from the server) will not be automatically translated back into Java on the client - they will arrive asJavaScriptObjectinstances. You can easily convert to the appropriate type yourself using theJSOHelperclass. TheJSOHelper.convertToJava(JavaScriptObject, boolean)method performs a recursive conversion ofJavaScriptObjects returning aList(or array) for JavaScript arrays or aMapfor simple JavaScript objects (key:value pairs).When not communicating with the SmartClient server
rpcResponse.datacontains the raw HTTP response body. SeerpcRequest.useSimpleHttp, rpcRequest.serverOutputAsString,rpcRequest.evalResultin the SmartClient Reference for details.- Returns:
- the data in the RPC response, as a String
- See Also:
-
getDataAsObject
The data sent by the server.When communicating with the SmartClient server,
rpcResponse.datais the data passed to the server-side methodRPCResponse.setData()by your Java code. This data is translated into JavaScript objects by the rules described underrpcRequest.datain the SmartClient Reference. Simple types (Numeric values, Strings, Dates, Booleans) will be available as their equivalent Java types in your client side GWT code. Complex objects (such as serializedMaps orLists from the server) will not be automatically translated back into Java on the client - they will arrive asJavaScriptObjectinstances. You can easily convert to the appropriate type yourself using theJSOHelperclass. TheJSOHelper.convertToJava(JavaScriptObject, boolean)method performs a recursive conversion ofJavaScriptObjects returning aList(or array) for JavaScript arrays or aMapfor simple JavaScript objects (key:value pairs).When not communicating with the SmartClient server
rpcResponse.datacontains the raw HTTP response body. SeerpcRequest.useSimpleHttp, rpcRequest.serverOutputAsString,rpcRequest.evalResultin the SmartClient Reference for details.- Returns:
- the data in the RPC response, as a JavaScriptObject
- See Also:
-
isDSResponse
-