com.smartgwt.client.data
Class RestDataSource

java.lang.Object
  extended by com.smartgwt.client.core.BaseClass
      extended by com.smartgwt.client.data.DataSource
          extended by com.smartgwt.client.data.RestDataSource
All Implemented Interfaces:
HasHandlers, HasHandleErrorHandlers

public class RestDataSource
extends DataSource

The RestDataSource implements the 4 core DataSource operations using a simple protocol of XML or JSON requests and responses sent over HTTP, which can be easily fulfilled by any HTTP server technology.

RestDataSource is named for the REST (REpresentational State Transfer) pattern, which in brief says that simple messages passed over HTTP is a sufficient protocol for many web applications, without the need for further protocols such as WSDL or SOAP.

A RestDataSource is used just like a normal DataSource. RestDataSources are pre-configured, using the general-purpose databinding facilities of DataSources, to expect a particular format for responses and to send requests in a specific format. These request and response formats represent Isomorphic's recommended best practices for binding Smart GWT to backends which do not already support a similar, pre-existing request and response format and where the Smart GWT Java Server cannot be used.

If you have a pre-existing REST or WSDL service which is difficult to change, consider adapting Smart GWT to the existing service instead, by starting with a normal DataSource and using the client-side data integration facilities to create a mapping between Smart GWT's DSRequest and DSResponse objects and the message formats of your existing services.

RestDataSource is typically used with PHP, Ruby, Python, Perl or custom server technologies, and represents an alternative to installing the Smart GWT Server in a Java technology stack, or using WSDL-based binding with .NET or other WSDL-capable technologies. Note that Smart GWT Server also provides built-in support for the REST protocol via its RESTHandler servlet; this is primarily to allow non-Smart GWT clients to make use of DataSource operations. If you particularly wished to do so, you could use RestDataSource to make a Smart GWT app talk to the Smart GWT Server using REST rather than the proprietary wire format normally used when communicating with Smart GWT Server (this is how we are able to write automated tests for the RESTHandler servlet). However, doing this provides no benefit, imposes a number of inconveniences, and makes a handful of server-based features less useful (field-level declarative security, for example), so we strongly recommend that you do not do this; it is only mentioned here for completeness while we are discussing REST.

The request and response formats used by the RestDataSource allow for many of the available features of Smart GWT's databinding system to be used, including data paging, searching & sorting, long transactions, automatic cache sync, relogin and queuing. However, advanced features such as uploading / binary fields and export aren't available with RestDataSource and need to be re-implemented as needed. Most, though not all, server-based features are still available when using RestDataSource, as long as you are also using the RESTHandler servlet that is part of Smart GWT Server. However, as noted above, this approach is not recommended; if you are using Isomorphic technology both client- and server-side, it makes more sense to use the proprietary wire format.

RestDataSource and binary data

Binary data in a response provided to a RestDataSource must be delivered as valid XML or JSON Strings. Once delivered to the browser as Strings, there is no way to trigger the browser's "Save As" dialog to download the data, and in most cases no way to trigger other helper applications that might be launched to handle binary data (such as Excel or a PDF viewer). Hence for binary it usually makes sense to make a direct request via RPCManager.sendRequest() with downloadResult:true, separate from RestDataSource.

If you are using the Smart GWT Server included in Pro, Power end Enterprise to handle your REST requests server-side, there is transparent support for conversion between Java InputStreams representing binary data, and Strings containing that binary data encoded using the Base64 algorithm. Thus, on the server, the binary data is in its raw binary form, with transparent conversion to or from Base64 for messages to or from the REST client.

Examples

XML formatted responses:

RestDataSource expects a response like the following in response to a "fetch" request:

  <response>
     <status>0</status>
     <startRow>0</startRow>
     <endRow>76</endRow>
     <totalRows>546</totalRows>
     <data>
       <record>
           <field1>value</field1>
           <field2>value</field2>
       </record>
       <record>
           <field1>value</field1>
           <field2>value</field2>
       </record>
       ... 76 total records ... 
     </data>
  </response>
  
The <status> element indicates whether the fetch operation was successful (see StatusCodes).

The <data> element contains a list of record nodes, each of which represents a record returned by the server. The optional <startRow>, <endRow> and <totalRows> elements are needed only if data paging is in use, and populate the startRow, endRow and totalRows properties of the DSResponse.

Note: for a more compact format, simple field values may be specified on record nodes directly as attributes - in this case a record element might be structured like this:

      <record field1="value" field2="value" />
  

Note that a RestDataSource will bypass browser caching of all responses by default. See preventHTTPCaching.

Successful "add" or "update" request responses are similar in format - in this case the data element would be expected to contain a single record object containing the details of the record, as saved on the server.

The response from a "remove" operation would again include status and data elements, but in this case, only the primary key field value(s) of the removed record would be expected to be present under the data element.

If a validation failure occurred on the server, the response would have status set to STATUS_VALIDATION_ERROR [-4], and any validation errors could be included as per-field sub-elements of an "errors" element. For a validation error, the response is not expected to contain any <data> element.

A response showing a validation error might look like this:

  <response>
     <status>-4</status>
     <errors>
       <field1>
           <errorMessage>A validation error occurred for this field</errorMessage>
       </field1>
     </errors>
  </response>
  

An unrecoverable error, such as an unexpected server failure, can be flagged by setting <status> to -1 and setting <data> to an error message. In this case the <errors> element is not used (it's specific to validation errors). An unrecoverable error causes all response processing to be skipped and RPCManager.handleError to be invoked, which by default will show the provided error message as an alert using isc.warn.

JSON formatted responses:

JSON format responses are expected to contain the same data / meta-data as XMLresponses, encapsulated in a simple object with a "response" attribute.
The response to a "fetch" request would therefore have this format:

  {
     "response": {
        "status": 0,
        "startRow": 0,
        "endRow": 76,
        "totalRows": 546,
        "data": [
            {"field1": "value", "field2": "value"},
            {"field1": "value", "field2": "value"},
            ... 76 total records ...
        ]
     }
  }
  
The structure successful for "add", "update" and "remove" responses would be similar, though the data array would be expected to contain only a single object, representing the values as saved. This allows the server to return values such as an auto-generated sequence primaryKey, a last modified timestamp, or similar server-generated field values.

For a remove, only the value for the primaryKey field[s] would be required.

For a validation error, the status attribute would be set to STATUS_VALIDATION_ERROR [-4], and errors would be specified in the errors attribute of the response. For example:

  {    "response":
       {   "status": -4,
           "errors":
               {   "field1": {"errorMessage": "A validation error on field1"},
                   "field2": {"errorMessage": "A validation error on field2"}
               }
       }
  }
  
An array of errors may also be returned for a single field, like this:
  {    "response":
       {   "status": -4,
           "errors":
               {   "field1": [
                       {"errorMessage": "First error on field1"},
                       {"errorMessage": "Second error on field1"}
                   ]
               }
       }
  }
  

As with the XML format above, an unrecoverable error is indicated by setting the status attribute to -1 and the data property to the error message.

Server inbound data formats

The format of data sent to the server is determined by the dataProtocol specified for the operation. Request data is sent as parameters if the format is specified as "getParams" or "postParams".

In this case, the parameters sent to the server will consist of the DSRequest's data, and any parameters explicitly specified on the DSRequest object (as params.
If sendMetaData is true, the DSRequest meta data properties will also be present as parameters, prefixed with metaDataPrefix.

Example URL constructed with the metaDataPrefix set to "_" (the default):

   [dataURL]?field1=value1&_operationType=fetch&_startRow=0&_endRow=50&_sortBy=-field2&_dataSource=dsName

In this case the server would be able to separate the request's data from the meta data via the "_" prefix.

If data is sent to the server via the "postMessage" dataProtocol, the data will be serialized as an XML or JSON message according to the dataFormat setting. Both XML and JSON messages will contain request metadata such as startRow and endRow, and will appear exactly as though the subset of the DSRequest that is meaningful to the server had been passed to DataSource.xmlSerialize or JSON.encode respectively.

An example of an XML message might look like this:

     <request>
         <data>
             <countryCode>US</countryCode>
             <countryName>Edited Value</countryName>
             <capital>Edited Value</capital>
             <continent>Edited Value</continent>
         </data>
         <dataSource>countryDS</dataSource>
         <operationType>update</operationType>
     </request>
  
An example of an XML message for a fetch operation passing simple criteria:
     <request>
         <data>
             <continent>North America</continent>
         </data>
         <dataSource>countryDS</dataSource>
         <operationType>fetch</operationType>
         <startRow>0</startRow>
         <endRow>75</endRow>
         <componentId>worldGrid</componentId>
         <textMatchStyle>exact</textMatchStyle>
     </request>
  
And an example of an XML message for a fetch operation passing AdvancedCriteria:
     <request>
         <data>
             <_constructor>AdvancedCriteria</_constructor>
             <operator>or</operator>
             <criteria>
                 <criterion>
                     <fieldName>continent</fieldName>
                     <operator>equals</continent>
                     <value>North America</value>
                 </criterion>
                 <criterion>
                     <operator>and</operator>
                     <criteria>
                         <criterion>
                             <fieldName>continent</fieldName>
                             <operator>equals</operator>
                             <value>Europe</value>
                         </criterion>
                         <criterion>
                             <fieldName>population</fieldName>
                             <operator>greaterThan</operator>
                             <value>50000000</value>
                         </criterion>
                     </criteria>
                 </criterion>
             </criteria>
         </data>
         <dataSource>countryDS</dataSource>
         <operationType>fetch</operationType>
         <startRow>0</startRow>
         <endRow>75</endRow>
         <componentId>worldGrid</componentId>
     </request>
  
An example of an XML message for a fetch operation when using server-side summaries:
     <request>
         <data></data>
         <dataSource>countryDS</dataSource>
         <operationType>fetch</operationType>
         <summaryFunctions>
             <pk>count</pk>
         </summaryFunctions>
         <groupBy>member_g8</groupBy>
     </request>
  
JSON messages are just the plain JSON form of the structures shown in the above XML examples. The advanced criteria XML example above but in JSON form:
  {
      data: {
          _constructor: "AdvancedCriteria",
          operator: "or",
          criteria: [
              {
                  fieldName: "continent",
                  operator: "equals",
                  value: "North America
              },
              {
                  operator: "and", criteria: [
                      {
                          fieldName: "continent",
                          operator: "equals",
                          value: "Europe"
                      },
                      {
                          fieldName: "population",
                          operator: "greaterThan",
                          value: 50000000
                      }
                  ]
              }
          ]
      }
      dataSource: "countryDS",
      operationType: "fetch",
      startRow: 0,
      endRow: 75,
      componentId: "worldGrid"
  }
  
The default OperationBindings for a RestDataSource specify dataProtocol as "getParams" for the fetch operation, and "postParams" for update, add and remove operations. Note that most webservers impose a limit on the maximum size of GET requests (specifically, on the size of the request URL + HTTP headers). Using dataProtocol:"getParams" for "fetch" operations that involve complex AdvancedCriteria will result in a JSON serialization of the AdvancedCriteria in the request URL, and when combined with large cookies this can easily overflow the default limits on certain webservers (see http://stackoverflow.com/questions/686217/maximum-on-http-header-values). For this reason, we recommend that you use the "postMessage" protocol whenever you are intending to use AdvancedCriteria with RestDataSource.

Date, time and datetime values

Date, time and datetime values must be communicated using XML Schema format, as in the following examples:

    <dateField>2007-04-22</dateField>
    <timeField>11:07:13</timeField>
    <dateTimeField>2007-04-22T11:07:13</dateTimeField>
    <dateTimeField>2007-04-22T11:07:13.582</dateTimeField>
  

And the equivalent in JSON:

    dateField: "2007-04-22"
    timeField: "11:07:13"
    dateTimeField: "2007-04-22T11:07:13"
    dateTimeField: "2007-04-22T11:07:13.582"
  

Both RestDataSource on the client-side and the RESTHandler servlet on the server side automatically handle encoding and decoding temporal values using these formats. Both also handle datetime formats including or excluding milliseconds automatically. When encoding, both honot the trimMilliseconds setting on the DataSource, falling back to the server.properties setting rest.trimMilliseconds; when decoding, both detect whether or not to try to parse milliseconds based on the string they receive.

Fields of type "date" and "time" are considered to hold logical date and time values, as discussed in the date and time handling article, and are not affected by timezones. Fields of type "datetime" will be converted to UTC on the client side by RestDataSource, and will be sent back down to the client as UTC by the server-side RESTHandler. We recommend that your own REST client and/or server code do the same thing (ie, transmit all datetime values in both directions as UTC). Note that the examples given above give no timezone information, and will be treated by the Smart GWT Server as UTC values. If you wish to work with datetime values in a particular timezone, use a format like this:

    <dateField>2007-04-22T11:07:13-0800</dateField>
    <dateField>2012-11-19T22:12:04+0100</dateField>
  

And the equivalent in JSON:

    dateTimeField: "2007-04-22T11:07:13-0800"
    dateTimeField: "2012-11-19T22:12:04+0100"
  

NOTE: Although we refer above to XML Schema format, the format used for specifying timezone offset is slightly different from XML Schema - as shown in the above examples, you specify "+HHMM" or "-HHMM", as opposed to the XML Schema format which requires a ":" character between the hours and minutes. The reason for this difference is simply that the Java SimpleDateFormat class imposes it.

RestDataSource queuing support

RestDataSource supports queuing of DSRequests. This allows you to send multiple requests to the server in a single HTTP turnaround, thus minimizing network traffic and allowing the server to treat multiple requests as a single transaction, if the server is able to do so (in Power Edition and above, the Smart GWT Server transparently supports grouping multiple REST requests in a queue into a single database transaction when using one of the built-in DataSource types). Note that you can disable queuing support with the disableQueuing flag.

If you want to use queuing with RestDataSource, you must use the "postMessage" dataProtocol with either XML or JSON dataFormat. Message format is similar to the non-queued examples shown earlier: it is simply extended to cope with the idea of multiple DSRequests encapsulated in the message.

An example of the XML message sent from RestDataSource to the server for two update requests combined into a queue, using XML dataFormat:

  <transaction>
      <operations>
          <request>
              <data>
                  <pk>1</pk>
                  <countryName>Edited Value</countryName>
                  <capital>Edited Value</capital>
                  <continent>Edited Value</continent>
              </data>
              <dataSource>countryDS</dataSource>
              <operationType>update</operationType>
          </request>
          <request>
              <data>
                  <pk>2</pk>
                  <capital>Edited Value</capital>
                  <population>123456</population>
              </data>
              <dataSource>countryDS</dataSource>
              <operationType>update</operationType>
          </request>
      </operations>
  <transaction>
  
And the same message in JSON format:
  { 
      transaction: { 
          operations: [{
              dataSource:"countryDS", 
              operationType:"update", 
              data: {
                  pk: 1
                  countryName: "Edited Value",
                  capital: "Edited Value",
                  continent: "Edited Value"
              }
          }, {
              dataSource:"countryDS", 
              operationType:"update", 
              data: {
                  pk: 2,
                  capital: "Edited Value",
                  popuilation: 123456
              }
          }]
      }
  }
  
RestDataSource expects the response to a queue of requests to be a queue of responses in the same order as the original requests. Again, the message format is very similar to the unqueued REST format, it just has an outer container construct. Note also that the individual DSResponses in a queued response have an extra property, queueStatus. This allows each individual response to determine whether the queue as a whole succeeded. For example, if the first update succeeded but the second failed validation, the first response would have a status of 0, but a queueStatus of -1, while the second response would have both properties set to -1.

The update queue example given above would expect a response like this (in XML):

  <responses>
      <response>
          <status>0</status>
          <queueStatus>0</queueStatus>
          <data>
              <record>
                  <countryName>Edited Value</countryName>
                  <gdp>1700.0</gdp>
                  <continent>Edited Value</continent>
                  <capital>Edited Value</capital>
                  <pk>1</pk>
              </record>
          </data>
      </response>
      <response>
          <status>0</status>
          <queueStatus>0</queueStatus>
          <data>
              <record>
                  <countryName>United States</countryName>
                  <gdp>7247700.0</gdp>
                  <continent>North America</continent>
                  <independence>1776-07-04</independence>
                  <capital>Washington DC</capital>
                  <pk>2</pk>
                  <population>123456</population>
              </record>
          </data>
      </response>
  </responses>
  
And in JSON:
  [
  {
      "response": {
          "queueStatus": 0,
          "status": 0, 
          "data": [{
              "countryName": "Edited Value",
              "gdp": 1700.0,
              "continent": "Edited Value",
              "capital": "Edited Value",
              "pk": 1
          }]
      }
  },
  {
      "response": {
          "queueStatus": 0,
          "status": 0,
          "data": [{
              "countryName": "United States",
              "gdp": 7247700.0,
              "continent": "North America",
              "independence": "1776-07-04",
              "capital": "Washington DC",
              "pk": 2,
              "population": 123456
          }]
      }
  }
  ]
  
Hierarchical (Tree) data:

To create a hierarchical DataSource, in the DataSource's fields array, a field must be specified as the parent id field - the field which will contain a pointer to the id of each node's parent. This can be achieved by setting the foreignKey and the rootValue attributes on the field definition. For example:

  RestDataSource.create({
     ID:"supplyItem",
     fields : [
         {name:"itemId", type:"sequence", primaryKey:true},
         {name:"parentId", type:"integer", foreignKey:"supplyItem.itemId", rootValue:0},
         ...
     ]
  });
  
Tree Data is then treated on the server as a flat list of records linked by parent id.

Tree data is typically displayed using a dataBound TreeGrid component. TreeGrids automatically create a ResultTree data object, which requests data directly from the DataSource. ResultTrees load data on demand, only requesting currently visible (open) nodes from the server. This is handled by including a specified value for the parent id field in the request criteria.
To implement a standard load-on-demand tree RestDataSource back end, you should therefore simply return the set of nodes that match the criteria passed in. For example, if your DataSource was defined as the "supplyItem" code snippet above, a fetch request for all children of a node with itemId set to 12 would have "parentId" set to 12 in the request criteria. A valid response would then contain all the records that matched this criteria. For example:

  <response>
     <status>0</status>
     <data>
       <record>
           <itemId>15</itemId>
           <parentId>12</parentId>
       </record>
       <record>
           <itemId>16</itemId>
           <parentId>12</parentId>
       </record>
     </data>
  </response>
  
The structure of responses for Add, Update and Delete type requests will be the same regardless of whether the data is hierarchical. However you should be aware that the underlying data storage may need to be managed slightly differently in some cases.

Specifically, Add and Update operations may change the structure of the tree by returning a new parent id field value for the modified node. Depending on how your data is stored you may need to include special back-end logic to handle this.

Also, if a user deletes a folder within a databound tree, any children of that folder will also be dropped from the tree, and can be removed from the back-end data storage.

Note: For a general overview of binding components to Tree structured data, see Tree Databinding.


Field Summary
 
Fields inherited from class com.smartgwt.client.core.BaseClass
config, id, scClassName
 
Constructor Summary
RestDataSource()
           
RestDataSource(JavaScriptObject jsObj)
           
 
Method Summary
 JavaScriptObject create()
           
 String getAddDataURL()
          Custom dataURL for add type operations
 DSDataFormat getDataFormat()
          Expected format for server responses.
 DSProtocol getDataProtocol()
          Rather than setting dataProtocol, to control the format in which inputs are sent to the dataURL, you must specify a replacement OperationBinding and specify dataProtocol on that operationBinding.
 String getDataURL()
          Default URL to contact to fulfill all DSRequests.
 Boolean getDisableQueuing()
          If set, disables request queuing for this RestDataSource.
 String getFetchDataURL()
          Custom dataURL for fetch type operations
 String getJsonPrefix()
          Allows you to specify an arbitrary prefix string to apply to all json format responses sent from the server to this application.
 String getJsonRecordXPath()
          recordXPath mapping to the data node of json returned by the server.
 String getJsonSuffix()
          Allows you to specify an arbitrary suffix string to apply to all json format responses sent from the server to this application.
 String getMetaDataPrefix()
          If sendMetaData is true, this attribute is used to specify the prefix to apply to 'meta data' properties when assembling parameters to send to the server.
 OperationBinding[] getOperationBindings()
          RestDataSource OperationBindings set to specify default dataProtocol per operationType.
static RestDataSource getOrCreateRef(JavaScriptObject jsObj)
           
 Boolean getPrettyPrintJSON()
          When using dataFormat:"json" and dataProtocol:"postMessage" should we use the prettyPrint feature to enable indented, highly readable JSON messages.
 String getRecordXPath()
          For RestDataSources, by default, either the xmlRecordXPath or jsonRecordXPath is used based on the dataFormat setting.
 String getRemoveDataURL()
          Custom dataURL for remove type operations
 Boolean getSendMetaData()
          Should operation meta data be included when assembling parameters to send to the server? If true, meta data parameters will be prefixed with the metaDataPrefix.
Applies to operations where OperationBinding.dataProtocol is set to "getParams" or "postParams" only.
 String getUpdateDataURL()
          Custom dataURL for update type operations
 XmlNamespaces getXmlNamespaces()
          When dataFormat is "xml", xmlNamespaces configures the set of namespace prefixes that are added to the document element of the XML message sent to the server.
 String getXmlRecordXPath()
          recordXPath mapping to the data node of XML returned by the server.
 void setAddDataURL(String addDataURL)
          Custom dataURL for add type operations
 void setDataFormat(DSDataFormat dataFormat)
          Expected format for server responses.
 void setDataProtocol(DSProtocol dataProtocol)
          Rather than setting dataProtocol, to control the format in which inputs are sent to the dataURL, you must specify a replacement OperationBinding and specify dataProtocol on that operationBinding.
 void setDataURL(String dataURL)
          Default URL to contact to fulfill all DSRequests.
 void setDisableQueuing(Boolean disableQueuing)
          If set, disables request queuing for this RestDataSource.
 void setFetchDataURL(String fetchDataURL)
          Custom dataURL for fetch type operations
 void setJsonPrefix(String jsonPrefix)
          Allows you to specify an arbitrary prefix string to apply to all json format responses sent from the server to this application.
 void setJsonRecordXPath(String jsonRecordXPath)
          recordXPath mapping to the data node of json returned by the server.
 void setJsonSuffix(String jsonSuffix)
          Allows you to specify an arbitrary suffix string to apply to all json format responses sent from the server to this application.
 void setMetaDataPrefix(String metaDataPrefix)
          If sendMetaData is true, this attribute is used to specify the prefix to apply to 'meta data' properties when assembling parameters to send to the server.
 void setOperationBindings(OperationBinding... operationBindings)
          RestDataSource OperationBindings set to specify default dataProtocol per operationType.
 void setPrettyPrintJSON(Boolean prettyPrintJSON)
          When using dataFormat:"json" and dataProtocol:"postMessage" should we use the prettyPrint feature to enable indented, highly readable JSON messages.
 void setRecordXPath(String recordXPath)
          For RestDataSources, by default, either the xmlRecordXPath or jsonRecordXPath is used based on the dataFormat setting.
 void setRemoveDataURL(String removeDataURL)
          Custom dataURL for remove type operations
 void setSendMetaData(Boolean sendMetaData)
          Should operation meta data be included when assembling parameters to send to the server? If true, meta data parameters will be prefixed with the metaDataPrefix.
Applies to operations where OperationBinding.dataProtocol is set to "getParams" or "postParams" only.
 void setUpdateDataURL(String updateDataURL)
          Custom dataURL for update type operations
 void setXmlNamespaces(XmlNamespaces xmlNamespaces)
          When dataFormat is "xml", xmlNamespaces configures the set of namespace prefixes that are added to the document element of the XML message sent to the server.
 void setXmlRecordXPath(String xmlRecordXPath)
          recordXPath mapping to the data node of XML returned by the server.
 
Methods inherited from class com.smartgwt.client.data.DataSource
addData, addData, addData, addField, addHandleErrorHandler, applyFilter, applyFilter, canFlattenCriteria, combineCriteria, combineCriteria, combineCriteria, compareCriteria, compareCriteria, compareCriteria, compareDates, convertCriteria, convertCriteria, convertDataSourceCriteria, convertDataSourceCriteria, convertRelativeDates, convertRelativeDates, convertRelativeDates, convertRelativeDates, copyCriteria, copyRecord, copyRecords, downloadFile, downloadFile, downloadFile, evaluateCriterion, exportClientData, exportClientDataStatic, exportData, exportData, exportData, exportData, fetchData, fetchData, fetchData, fetchData, fetchRecord, fetchRecord, fetchRecord, fieldMatchesFilter, fieldMatchesFilter, filterData, filterData, filterData, filterData, flattenCriteria, get, get, getAddGlobalId, getAdvancedCriteriaDescription, getAllowAdvancedCriteria, getAutoCacheAllData, getAutoConvertRelativeDates, getAutoDeriveTitles, getAutoTitle, getCacheAcrossOperationIds, getCacheAllData, getCacheAllOperationId, getCacheData, getCacheMaxAge, getCallbackParam, getCanMultiSort, getChildrenField, getClientOnly, getClientOnlyDataSource, getClientOnlyDataSource, getClientOnlyDataSource, getClientOnlyResponse, getCriteriaPolicy, getDataField, getDataSource, getDataSource, getDataTransport, getDefaultParams, getDefaultTextMatchStyle, getDescriptionField, getDisplayValue, getDropExtraFields, getDropUnknownCriteria, getFetchDataURL, getFetchDataURL, getField, getFieldAutoTitle, getFieldCriterion, getFieldForDataPath, getFieldNames, getFieldNames, getFieldOperators, getFieldOperators, getFields, getFieldValue, getFieldValue, getFieldValue, getFieldValue, getFileURL, getFileURL, getFileURL, getGlobalNamespaces, getIconField, getIgnoreTextMatchStyleCaseSensitive, getInfoField, getInheritsFrom, getJsObj, getLegalChildTags, getPatternEscapeChar, getPatternMultiWildcard, getPatternMultiWildcardAsString, getPatternSingleWildcard, getPatternSingleWildcardAsString, getPluralTitle, getPreventHTTPCaching, getPrimaryKeyField, getPrimaryKeyFieldName, getPrimaryKeyFieldNames, getPrimaryKeyFields, getProgressiveLoading, getQualifyColumnNames, getRequestProperties, getRequiredMessage, getResultBatchSize, getResultSetClass, getSchemaNamespace, getSendExtraFields, getSendParentNode, getServiceNamespace, getShowLocalFieldsOnly, getShowPrompt, getSortBy, getSortSpecifiers, getStrictSQLFiltering, getTagName, getTestData, getTitle, getTitleField, getTranslatePatternOperators, getTrimMilliseconds, getTypeOperators, getTypeOperators, getUseFlatFields, getUseHttpProxy, getUseLocalValidators, getUseOfflineStorage, getUseParentFieldOrder, getUseStrictJSON, getUseTestDataFetch, getValidateRelatedRecords, hasAllData, invalidateCache, isCreated, isFlatCriteria, load, load, load, loadWithParents, loadWithParents, loadWithParents, onInit, performCustomOperation, performCustomOperation, performCustomOperation, performCustomOperation, processResponse, recordsAreEqual, recordsAsText, recordsAsText, recordsFromText, recordsFromText, recordsFromXML, registerID, removeData, removeData, removeData, setAddGlobalId, setAllowAdvancedCriteria, setAutoCacheAllData, setAutoConvertRelativeDates, setAutoDeriveTitles, setCacheAllData, setCacheData, setCacheMaxAge, setCallbackParam, setCanMultiSort, setChildrenField, setClientOnly, setCriteriaPolicy, setDataField, setDataTransport, setDefaultParams, setDefaultTextMatchStyle, setDescriptionField, setDropExtraFields, setDropUnknownCriteria, setEnumConstantProperty, setEnumOrdinalProperty, setEnumTranslateStrategy, setFields, setGlobalNamespaces, setHandleErrorCallback, setIconField, setID, setIgnoreTextMatchStyleCaseSensitive, setInfoField, setInheritsFrom, setInheritsFrom, setPatternEscapeChar, setPatternMultiWildcard, setPatternMultiWildcard, setPatternSingleWildcard, setPatternSingleWildcard, setPluralTitle, setPreventHTTPCaching, setProgressiveLoading, setQualifyColumnNames, setRecordName, setRequestProperties, setRequiredMessage, setResultBatchSize, setResultSetClass, setSendExtraFields, setSendParentNode, setServiceNamespace, setShowLocalFieldsOnly, setShowPrompt, setStrictSQLFiltering, setTagName, setTestData, setTitle, setTitleField, setTranslatePatternOperators, setTrimMilliseconds, setTypeOperators, setTypeOperators, setUseFlatFields, setUseHttpProxy, setUseLocalValidators, setUseOfflineStorage, setUseParentFieldOrder, setUseStrictJSON, setUseTestDataFetch, setValidateRelatedRecords, splitCriteria, supportsAdvancedCriteria, supportsTextMatchStyle, transformRequest, transformResponse, updateCaches, updateCaches, updateData, updateData, updateData, useOfflineResponse, validateData, validateData, validateData, viewFile, viewFile, viewFile, xmlSerialize, xmlSerialize, xmlSerialize, xmlSerialize, xmlSerialize
 
Methods inherited from class com.smartgwt.client.core.BaseClass
asSGWTComponent, createJsObj, destroy, doAddHandler, doInit, error, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getClassName, getConfig, getHandlerCount, getID, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, internalSetID, internalSetID, onBind, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setJavaScriptObject, setProperty, setProperty, setProperty, setProperty, setScClassName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 

Constructor Detail

RestDataSource

public RestDataSource()

RestDataSource

public RestDataSource(JavaScriptObject jsObj)
Method Detail

getOrCreateRef

public static RestDataSource getOrCreateRef(JavaScriptObject jsObj)

create

public JavaScriptObject create()
Overrides:
create in class DataSource

setAddDataURL

public void setAddDataURL(String addDataURL)
                   throws IllegalStateException
Custom dataURL for add type operations

Parameters:
addDataURL - Default value is null
Throws:
IllegalStateException - this property cannot be changed after the underlying component has been created

getAddDataURL

public String getAddDataURL()
Custom dataURL for add type operations

Returns:
String

setDataFormat

public void setDataFormat(DSDataFormat dataFormat)
                   throws IllegalStateException
Expected format for server responses. RestDataSources handle "json" and "xml" format responses by default. See class overview documentation for examples of responses in each format.

Overrides:
setDataFormat in class DataSource
Parameters:
dataFormat - Default value is "xml"
Throws:
IllegalStateException - this property cannot be changed after the underlying component has been created
See Also:
ClientDataIntegration overview and related methods, JSON DataSource Example, Simple JSON Example

getDataFormat

public DSDataFormat getDataFormat()
Expected format for server responses. RestDataSources handle "json" and "xml" format responses by default. See class overview documentation for examples of responses in each format.

Overrides:
getDataFormat in class DataSource
Returns:
DSDataFormat
See Also:
ClientDataIntegration overview and related methods, JSON DataSource Example, Simple JSON Example

setDataProtocol

public void setDataProtocol(DSProtocol dataProtocol)
                     throws IllegalStateException
Rather than setting dataProtocol, to control the format in which inputs are sent to the dataURL, you must specify a replacement OperationBinding and specify dataProtocol on that operationBinding.

This is because RestDataSource specifies default operationBindings for all operationTypes - see operationBindings.

Overrides:
setDataProtocol in class DataSource
Parameters:
dataProtocol - Default value is null
Throws:
IllegalStateException - this property cannot be changed after the underlying component has been created
See Also:
ClientDataIntegration overview and related methods

getDataProtocol

public DSProtocol getDataProtocol()
Rather than setting dataProtocol, to control the format in which inputs are sent to the dataURL, you must specify a replacement OperationBinding and specify dataProtocol on that operationBinding.

This is because RestDataSource specifies default operationBindings for all operationTypes - see operationBindings.

Overrides:
getDataProtocol in class DataSource
Returns:
DSProtocol
See Also:
ClientDataIntegration overview and related methods

setDataURL

public void setDataURL(String dataURL)
                throws IllegalStateException
Default URL to contact to fulfill all DSRequests. RestDataSources also allow per-operationType dataURLs to be set via

Overrides:
setDataURL in class DataSource
Parameters:
dataURL - Default value is null
Throws:
IllegalStateException - this property cannot be changed after the underlying component has been created
See Also:
ClientDataIntegration overview and related methods, JSON DataSource Example

getDataURL

public String getDataURL()
Default URL to contact to fulfill all DSRequests. RestDataSources also allow per-operationType dataURLs to be set via

Overrides:
getDataURL in class DataSource
Returns:
String
See Also:
ClientDataIntegration overview and related methods, JSON DataSource Example

setDisableQueuing

public void setDisableQueuing(Boolean disableQueuing)
If set, disables request queuing for this RestDataSource.

Parameters:
disableQueuing - Default value is false

getDisableQueuing

public Boolean getDisableQueuing()
If set, disables request queuing for this RestDataSource.

Returns:
Boolean

setFetchDataURL

public void setFetchDataURL(String fetchDataURL)
                     throws IllegalStateException
Custom dataURL for fetch type operations

Parameters:
fetchDataURL - Default value is null
Throws:
IllegalStateException - this property cannot be changed after the underlying component has been created

getFetchDataURL

public String getFetchDataURL()
Custom dataURL for fetch type operations

Returns:
String

setJsonPrefix

public void setJsonPrefix(String jsonPrefix)
Allows you to specify an arbitrary prefix string to apply to all json format responses sent from the server to this application. The client will expect to find this prefix on any JSON response received for this DataSource, and will strip it off before evaluating the response text.

The default prefix is "<SCRIPT>//'\"]]>>isc_JSONResponseStart>>".

The inclusion of such a prefix ensures your code is not directly executable outside of your application, as a preventative measure against javascript hijacking.

You can switch off JSON wrapping altogether by setting both this and jsonSuffix to empty strings.

If you are using Smart GWT Server's RESTHandler servlet, see the server-side Javadocs for details of how to change the way JSON wrapping works on the server side.

Overrides:
setJsonPrefix in class DataSource
Parameters:
jsonPrefix - Default value is See below
See Also:
setJsonSuffix(java.lang.String)

getJsonPrefix

public String getJsonPrefix()
Allows you to specify an arbitrary prefix string to apply to all json format responses sent from the server to this application. The client will expect to find this prefix on any JSON response received for this DataSource, and will strip it off before evaluating the response text.

The default prefix is "<SCRIPT>//'\"]]>>isc_JSONResponseStart>>".

The inclusion of such a prefix ensures your code is not directly executable outside of your application, as a preventative measure against javascript hijacking.

You can switch off JSON wrapping altogether by setting both this and jsonSuffix to empty strings.

If you are using Smart GWT Server's RESTHandler servlet, see the server-side Javadocs for details of how to change the way JSON wrapping works on the server side.

Overrides:
getJsonPrefix in class DataSource
Returns:
String
See Also:
getJsonSuffix()

setJsonRecordXPath

public void setJsonRecordXPath(String jsonRecordXPath)
                        throws IllegalStateException
recordXPath mapping to the data node of json returned by the server. Applies if this.dataFormat is set to "json"
The default value will pick up data from a response structured as follows:
  {response:
   {status:0,
    data:[
       {field1:"value", field2:"value"},
       {field1:"value", field2:"value"}
    ]
  }
  

Parameters:
jsonRecordXPath - Default value is "/response/data"
Throws:
IllegalStateException - this property cannot be changed after the underlying component has been created

getJsonRecordXPath

public String getJsonRecordXPath()
recordXPath mapping to the data node of json returned by the server. Applies if this.dataFormat is set to "json"
The default value will pick up data from a response structured as follows:
  {response:
   {status:0,
    data:[
       {field1:"value", field2:"value"},
       {field1:"value", field2:"value"}
    ]
  }
  

Returns:
String

setJsonSuffix

public void setJsonSuffix(String jsonSuffix)
Allows you to specify an arbitrary suffix string to apply to all json format responses sent from the server to this application. The client will expect to find this suffix on any JSON response received for this DataSource, and will strip it off before evaluating the response text.

The default suffix is "//isc_JSONResponseEnd".

Overrides:
setJsonSuffix in class DataSource
Parameters:
jsonSuffix - Default value is See below
See Also:
setJsonPrefix(java.lang.String)

getJsonSuffix

public String getJsonSuffix()
Allows you to specify an arbitrary suffix string to apply to all json format responses sent from the server to this application. The client will expect to find this suffix on any JSON response received for this DataSource, and will strip it off before evaluating the response text.

The default suffix is "//isc_JSONResponseEnd".

Overrides:
getJsonSuffix in class DataSource
Returns:
String
See Also:
getJsonPrefix()

setMetaDataPrefix

public void setMetaDataPrefix(String metaDataPrefix)
                       throws IllegalStateException
If sendMetaData is true, this attribute is used to specify the prefix to apply to 'meta data' properties when assembling parameters to send to the server. Applies to operations where OperationBinding.dataProtocol is set to "getParams" or "postParams" only.

Parameters:
metaDataPrefix - Default value is "_"
Throws:
IllegalStateException - this property cannot be changed after the underlying component has been created

getMetaDataPrefix

public String getMetaDataPrefix()
If sendMetaData is true, this attribute is used to specify the prefix to apply to 'meta data' properties when assembling parameters to send to the server. Applies to operations where OperationBinding.dataProtocol is set to "getParams" or "postParams" only.

Returns:
String

setOperationBindings

public void setOperationBindings(OperationBinding... operationBindings)
                          throws IllegalStateException
RestDataSource OperationBindings set to specify default dataProtocol per operationType. Default databindings are:
    operationBindings : [
      {operationType:"fetch", dataProtocol:"getParams"},
      {operationType:"add", dataProtocol:"postParams"},
      {operationType:"remove", dataProtocol:"postParams"},
      {operationType:"update", dataProtocol:"postParams"} 
    ],
  
If you are integrating with a REST server that requires the more obscure httpMethods of "PUT", "DELETE" or "HEAD", you can specify these httpMethod settings via requestProperties. dataProtocol settings that mention "GET" or "POST" are compatible with these additional HTTP methods as well. Typical operationBindings for a REST server that uses "PUT" and "DELETE" are as follows:
    operationBindings:[
      {operationType:"fetch", dataProtocol:"getParams"},
      {operationType:"add", dataProtocol:"postParams"},
      {operationType:"remove", dataProtocol:"getParams", requestProperties:{httpMethod:"DELETE"}},
      {operationType:"update", dataProtocol:"postParams", requestProperties:{httpMethod:"PUT"}}
    ],
  

Note that dataProtocol:"postMessage" is always used when queuing is used to send multiple DSRequests to the server as a single HttpRequest. See RestDataSource docs, "queuing support". We also recommend that you use the "postMessage" protocol whenever you are intending to use AdvancedCriteria with RestDataSource - this is discussed in the section "Server inbound data format" in the RestDataSource overview.

Overrides:
setOperationBindings in class DataSource
Parameters:
operationBindings - Default value is [...]
Throws:
IllegalStateException - this property cannot be changed after the underlying component has been created
See Also:
OperationBinding

getOperationBindings

public OperationBinding[] getOperationBindings()
RestDataSource OperationBindings set to specify default dataProtocol per operationType. Default databindings are:
    operationBindings : [
      {operationType:"fetch", dataProtocol:"getParams"},
      {operationType:"add", dataProtocol:"postParams"},
      {operationType:"remove", dataProtocol:"postParams"},
      {operationType:"update", dataProtocol:"postParams"} 
    ],
  
If you are integrating with a REST server that requires the more obscure httpMethods of "PUT", "DELETE" or "HEAD", you can specify these httpMethod settings via requestProperties. dataProtocol settings that mention "GET" or "POST" are compatible with these additional HTTP methods as well. Typical operationBindings for a REST server that uses "PUT" and "DELETE" are as follows:
    operationBindings:[
      {operationType:"fetch", dataProtocol:"getParams"},
      {operationType:"add", dataProtocol:"postParams"},
      {operationType:"remove", dataProtocol:"getParams", requestProperties:{httpMethod:"DELETE"}},
      {operationType:"update", dataProtocol:"postParams", requestProperties:{httpMethod:"PUT"}}
    ],
  

Note that dataProtocol:"postMessage" is always used when queuing is used to send multiple DSRequests to the server as a single HttpRequest. See RestDataSource docs, "queuing support". We also recommend that you use the "postMessage" protocol whenever you are intending to use AdvancedCriteria with RestDataSource - this is discussed in the section "Server inbound data format" in the RestDataSource overview.

Overrides:
getOperationBindings in class DataSource
Returns:
OperationBinding...
See Also:
OperationBinding

setPrettyPrintJSON

public void setPrettyPrintJSON(Boolean prettyPrintJSON)
                        throws IllegalStateException
When using dataFormat:"json" and dataProtocol:"postMessage" should we use the prettyPrint feature to enable indented, highly readable JSON messages.

True by default because the bandwidth involved is generally negligible and the benefits for troubleshooting are key.

Parameters:
prettyPrintJSON - Default value is true
Throws:
IllegalStateException - this property cannot be changed after the underlying component has been created

getPrettyPrintJSON

public Boolean getPrettyPrintJSON()
When using dataFormat:"json" and dataProtocol:"postMessage" should we use the prettyPrint feature to enable indented, highly readable JSON messages.

True by default because the bandwidth involved is generally negligible and the benefits for troubleshooting are key.

Returns:
Boolean

setRecordXPath

public void setRecordXPath(String recordXPath)
For RestDataSources, by default, either the xmlRecordXPath or jsonRecordXPath is used based on the dataFormat setting.

Note that you can also apply record xpath binding via recordXPath.

Overrides:
setRecordXPath in class DataSource
Parameters:
recordXPath - Default value is null
See Also:
ClientDataIntegration overview and related methods, XML DataSource Example, JSON XPath Binding Example

getRecordXPath

public String getRecordXPath()
For RestDataSources, by default, either the xmlRecordXPath or jsonRecordXPath is used based on the dataFormat setting.

Note that you can also apply record xpath binding via recordXPath.

Overrides:
getRecordXPath in class DataSource
Returns:
String
See Also:
ClientDataIntegration overview and related methods, XML DataSource Example, JSON XPath Binding Example

setRemoveDataURL

public void setRemoveDataURL(String removeDataURL)
                      throws IllegalStateException
Custom dataURL for remove type operations

Parameters:
removeDataURL - Default value is null
Throws:
IllegalStateException - this property cannot be changed after the underlying component has been created

getRemoveDataURL

public String getRemoveDataURL()
Custom dataURL for remove type operations

Returns:
String

setSendMetaData

public void setSendMetaData(Boolean sendMetaData)
                     throws IllegalStateException
Should operation meta data be included when assembling parameters to send to the server? If true, meta data parameters will be prefixed with the metaDataPrefix.
Applies to operations where OperationBinding.dataProtocol is set to "getParams" or "postParams" only.

Parameters:
sendMetaData - Default value is true
Throws:
IllegalStateException - this property cannot be changed after the underlying component has been created

getSendMetaData

public Boolean getSendMetaData()
Should operation meta data be included when assembling parameters to send to the server? If true, meta data parameters will be prefixed with the metaDataPrefix.
Applies to operations where OperationBinding.dataProtocol is set to "getParams" or "postParams" only.

Returns:
Boolean

setUpdateDataURL

public void setUpdateDataURL(String updateDataURL)
                      throws IllegalStateException
Custom dataURL for update type operations

Parameters:
updateDataURL - Default value is null
Throws:
IllegalStateException - this property cannot be changed after the underlying component has been created

getUpdateDataURL

public String getUpdateDataURL()
Custom dataURL for update type operations

Returns:
String

setXmlNamespaces

public void setXmlNamespaces(XmlNamespaces xmlNamespaces)
                      throws IllegalStateException
When dataFormat is "xml", xmlNamespaces configures the set of namespace prefixes that are added to the document element of the XML message sent to the server. Format is the same as xmlNamespaces.

By default, the "xsi" prefix is bound to "http://www.w3.org/2001/XMLSchema-instance" in order to allow explicit null values in Records to be sent for fields declared nillable. Set to null to avoid any prefixes being added.

Overrides:
setXmlNamespaces in class DataSource
Parameters:
xmlNamespaces - Default value is See below
Throws:
IllegalStateException - this property cannot be changed after the underlying component has been created
See Also:
DataSourceField.setNillable(java.lang.Boolean)

getXmlNamespaces

public XmlNamespaces getXmlNamespaces()
When dataFormat is "xml", xmlNamespaces configures the set of namespace prefixes that are added to the document element of the XML message sent to the server. Format is the same as xmlNamespaces.

By default, the "xsi" prefix is bound to "http://www.w3.org/2001/XMLSchema-instance" in order to allow explicit null values in Records to be sent for fields declared nillable. Set to null to avoid any prefixes being added.

Returns:
XmlNamespaces
See Also:
DataSourceField.getNillable()

setXmlRecordXPath

public void setXmlRecordXPath(String xmlRecordXPath)
                       throws IllegalStateException
recordXPath mapping to the data node of XML returned by the server. Applies if this.dataFormat is set to "xml".
The default value will pick up data from a response structured as follows:
  <response>
     <status>0</status>
     <data>
       <record>
           <field1>value</field1>
           <field2>value</field2>
       </record>
       <record>
           <field1>value</field1>
           <field2>value</field2>
       </record>
     </data>
  </response>
  

Parameters:
xmlRecordXPath - Default value is "/response/data/*"
Throws:
IllegalStateException - this property cannot be changed after the underlying component has been created

getXmlRecordXPath

public String getXmlRecordXPath()
recordXPath mapping to the data node of XML returned by the server. Applies if this.dataFormat is set to "xml".
The default value will pick up data from a response structured as follows:
  <response>
     <status>0</status>
     <data>
       <record>
           <field1>value</field1>
           <field2>value</field2>
       </record>
       <record>
           <field1>value</field1>
           <field2>value</field2>
       </record>
     </data>
  </response>
  

Returns:
String