com.google.gwt.user.client.rpc

类 RpcRequestBuilder

java.lang.Object

com.google.gwt.user.client.rpc.RpcRequestBuilder

public class RpcRequestBuilder
extends java.lang.Object

This class encapsulates the logic necessary to configure a RequestBuilder for use with an RPC proxy object. Users who wish to alter the specifics of the HTTP requests issued by RPC proxy objects may override the protected doXyz methods and pass an instance of the subclass to ServiceDefTarget.setRpcRequestBuilder(com.google.gwt.user.client.rpc.RpcRequestBuilder).

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	CONTENT_TYPE_HEADER Used by doSetContentType(com.google.gwt.http.client.RequestBuilder, java.lang.String).
static java.lang.String	MODULE_BASE_HEADER Used by doFinish(com.google.gwt.http.client.RequestBuilder).
static java.lang.String	STRONG_NAME_HEADER Used by doFinish(com.google.gwt.http.client.RequestBuilder).

构造器概要

构造器

构造器和说明
RpcRequestBuilder()

方法概要

方法

限定符和类型	方法和说明
RpcRequestBuilder	create(java.lang.String serviceEntryPoint) Initialize the RpcRequestBuilder.
protected com.google.gwt.http.client.RequestBuilder	doCreate(java.lang.String serviceEntryPoint) Called by create(java.lang.String) to instantiate the RequestBuilder object.
protected void	doFinish(com.google.gwt.http.client.RequestBuilder rb) Called by finish() prior to returning the RequestBuilder to the caller.
protected void	doSetCallback(com.google.gwt.http.client.RequestBuilder rb, com.google.gwt.http.client.RequestCallback callback) Called by setCallback(com.google.gwt.http.client.RequestCallback).
protected void	doSetContentType(com.google.gwt.http.client.RequestBuilder rb, java.lang.String contentType) Called by setContentType(java.lang.String).
protected void	doSetRequestData(com.google.gwt.http.client.RequestBuilder rb, java.lang.String data) Called by setRequestData(java.lang.String).
protected void	doSetRequestId(com.google.gwt.http.client.RequestBuilder rb, int id) Called by setRequestId(int).
com.google.gwt.http.client.RequestBuilder	finish() This method must be called to return the RequestBuilder that the RPC request will be made with.
RpcRequestBuilder	setCallback(com.google.gwt.http.client.RequestCallback callback) Sets the RequestCallback to be used by the RequestBuilder.
RpcRequestBuilder	setContentType(java.lang.String contentType) Sets the MIME content type to be used by the RequestBuilder.
RpcRequestBuilder	setRequestData(java.lang.String data) Sets the request data to be sent in the request.
RpcRequestBuilder	setRequestId(int id) Sets the request id of the request.
RpcRequestBuilder	setSync(boolean sync)

从类继承的方法 java.lang.Object

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

字段详细资料

CONTENT_TYPE_HEADER

public static final java.lang.String CONTENT_TYPE_HEADER

Used by doSetContentType(com.google.gwt.http.client.RequestBuilder, java.lang.String).

另请参阅:

常量字段值

MODULE_BASE_HEADER

public static final java.lang.String MODULE_BASE_HEADER

Used by doFinish(com.google.gwt.http.client.RequestBuilder).

另请参阅:

常量字段值

STRONG_NAME_HEADER

public static final java.lang.String STRONG_NAME_HEADER

Used by doFinish(com.google.gwt.http.client.RequestBuilder).

另请参阅:

常量字段值

构造器详细资料

RpcRequestBuilder

public RpcRequestBuilder()

方法详细资料

create

public final RpcRequestBuilder create(java.lang.String serviceEntryPoint)

Initialize the RpcRequestBuilder. This method must be called before any of the other methods in this class may be called. Calling create before calling finish() will reset the state of the RpcRequestBuilder.

This method delegates to doCreate(java.lang.String) to instantiate the RequestBuilder.

参数:

serviceEntryPoint - The URL entry point

返回:

this

另请参阅:

ServiceDefTarget.setServiceEntryPoint(String)

finish

public final com.google.gwt.http.client.RequestBuilder finish()

This method must be called to return the RequestBuilder that the RPC request will be made with.

This method will call doFinish(com.google.gwt.http.client.RequestBuilder) before returning the current RequestBuilder.

setCallback

public final RpcRequestBuilder setCallback(com.google.gwt.http.client.RequestCallback callback)

Sets the RequestCallback to be used by the RequestBuilder. Delegates to doSetCallback(com.google.gwt.http.client.RequestBuilder, com.google.gwt.http.client.RequestCallback).

参数:

callback - the RequestCallback to be used by the RequestBuilder

返回:

this

setContentType

public final RpcRequestBuilder setContentType(java.lang.String contentType)

Sets the MIME content type to be used by the RequestBuilder. Delegates to doSetContentType(com.google.gwt.http.client.RequestBuilder, java.lang.String).

参数:

contentType - the MIME content type to be used in the request

返回:

this

setRequestData

public final RpcRequestBuilder setRequestData(java.lang.String data)

Sets the request data to be sent in the request. Delegates to doSetRequestData(com.google.gwt.http.client.RequestBuilder, java.lang.String).

参数:

data - the data to send

返回:

this

setRequestId

public final RpcRequestBuilder setRequestId(int id)

Sets the request id of the request. Delegates to doSetRequestId(com.google.gwt.http.client.RequestBuilder, int).

参数:

id - the issue number of the request

返回:

this

doCreate

protected com.google.gwt.http.client.RequestBuilder doCreate(java.lang.String serviceEntryPoint)

Called by create(java.lang.String) to instantiate the RequestBuilder object.

The default implementation creates a POST RequestBuilder with the given entry point.

参数:

serviceEntryPoint - the URL to which the request should be issued

返回:

the RequestBuilder that should be ultimately passed to the RpcRequestBuilder's caller.

doFinish

protected void doFinish(com.google.gwt.http.client.RequestBuilder rb)

Called by finish() prior to returning the RequestBuilder to the caller.

The default implementation sets the "X-GWT-Permutation" header to the value returned by GWT.getPermutationStrongName().

参数:

rb - The RequestBuilder that is currently being configured

doSetCallback

protected void doSetCallback(com.google.gwt.http.client.RequestBuilder rb,
                 com.google.gwt.http.client.RequestCallback callback)

Called by setCallback(com.google.gwt.http.client.RequestCallback).

The default implementation calls RequestBuilder.setCallback(RequestCallback).

参数:

rb - the RequestBuilder that is currently being configured

callback - the user-provided callback

doSetContentType

protected void doSetContentType(com.google.gwt.http.client.RequestBuilder rb,
                    java.lang.String contentType)

Called by setContentType(java.lang.String).

The default implementation sets the "Content-Type" header to the value specified by contentType by calling RequestBuilder.setHeader(String, String).

参数:

rb - the RequestBuilder that is currently being configured

contentType - the desired MIME type of the request's contents

doSetRequestData

protected void doSetRequestData(com.google.gwt.http.client.RequestBuilder rb,
                    java.lang.String data)

Called by setRequestData(java.lang.String).

The default implementation invokes RequestBuilder.setRequestData(String).

参数:

rb - the RequestBuilder that is currently being configured

data - the data to send

doSetRequestId

protected void doSetRequestId(com.google.gwt.http.client.RequestBuilder rb,
                  int id)

Called by setRequestId(int).

The default implementation is a no-op.

参数:

rb - the RequestBuilder that is currently being configured

id - the request's issue id

setSync

public final RpcRequestBuilder setSync(boolean sync)