com.sencha.gxt.data.client.loader

Class HttpProxy<C>

java.lang.Object

com.sencha.gxt.data.client.loader.HttpProxy<C>

Type Parameters:

C - the type of data used to configure the load from the proxy

All Implemented Interfaces:

DataProxy<C,String>

public class HttpProxy<C>
extends Object
implements DataProxy<C,String>

A DataProxy that retrieves data using a RequestBuilder instance.

When using a load config object that implements LoadConfig or ModelData, all properties and property values will be sent as request parameters in the load request.

See Also:

RequestBuilder, ScriptTagProxy

Field Summary

Fields

Modifier and Type	Field and Description
protected RequestBuilder	builder The request builder used by this data proxy.
protected String	initUrl The URL of the HTTP service, initialized from RequestBuilder#getUrl() and used by load(C, <any>) as the base part of the URL when appending encoded parameters for an HTTP GET request.
protected DataWriter<C,String>	writer

Constructor Summary

Constructors

Constructor and Description
HttpProxy(RequestBuilder builder) Creates a new HttpProxy.

Method Summary

Modifier and Type	Method and Description
protected String	generateUrl(C loadConfig) Encodes the load config into a format that can be used for a GET query string or a POST url-encoded body.
DataWriter<C,String>	getWriter() Returns the data writer for this proxy.
void	load(C loadConfig, <any> callback) Data should be retrieved using the specified load config.
protected void	setUrl(RequestBuilder rb, String url)
void	setWriter(DataWriter<C,String> writer) Sets the data writer for this proxy.
protected boolean	shouldUseBody() Decides if the config data should be written to the body or to the querystring.

Methods inherited from class java.lang.Object

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

Field Detail

builder

protected RequestBuilder builder

The request builder used by this data proxy.

initUrl

protected String initUrl

The URL of the HTTP service, initialized from RequestBuilder#getUrl() and used by load(C, <any>) as the base part of the URL when appending encoded parameters for an HTTP GET request.

writer

protected DataWriter<C,String> writer

Constructor Detail

HttpProxy

public HttpProxy(RequestBuilder builder)

Creates a new HttpProxy.

Parameters:

builder - the request builder. The URL must be set to the URL of the service. For requests that use the HTTP GET method, the URL should be set to the base part of the URL. It will be updated automatically to include the encoded request.

Method Detail

getWriter

public DataWriter<C,String> getWriter()

Returns the data writer for this proxy. The data writer is responsible for encoding the load config.

Returns:

the data writer

load

public void load(C loadConfig,
                 <any> callback)

Description copied from interface: DataProxy

Data should be retrieved using the specified load config. When specified, the DataReader can be used to "process" the raw data.

Specified by:

load in interface DataProxy<C,String>

Parameters:

loadConfig - the load config object to be passed to server

callback - the data callback

shouldUseBody

protected boolean shouldUseBody()

Decides if the config data should be written to the body or to the querystring. Defaults to using the body in the case of POST or PUT requests, and the querystring for all other requests. Can be overridden to change this behavior.

Returns:

true if the outgoing request should write the config data to the body instead of using writing to the querystring

setWriter

public void setWriter(DataWriter<C,String> writer)

Sets the data writer for this proxy. The data writer is responsible for encoding the load config.

Parameters:

writer - the data writer

generateUrl

protected String generateUrl(C loadConfig)

Encodes the load config into a format that can be used for a GET query string or a POST url-encoded body. Use setWriter(com.sencha.gxt.data.shared.writer.DataWriter<C, java.lang.String>) to set the data writer responsible for encoding the load config. If it is not set the load config is assumed to require no further encoding and its value is retrieved using its toString method.

Parameters:

loadConfig - the load config to encode

Returns:

the encoded load config

setUrl

protected void setUrl(RequestBuilder rb,
                      String url)