com.gwtplatform.dispatch.rest.client.gin

Class RestDispatchAsyncModuleBuilder

java.lang.Object

com.gwtplatform.dispatch.client.gin.AbstractDispatchAsyncModule.Builder

com.gwtplatform.dispatch.rest.client.gin.RestDispatchAsyncModuleBuilder

Direct Known Subclasses:

RestDispatchAsyncModule.Builder

public class RestDispatchAsyncModuleBuilder
extends AbstractDispatchAsyncModule.Builder

A RestDispatchAsyncModule builder.

The possible configurations are:

• All configuration methods listed by AbstractDispatchAsyncModule.Builder
• XSRF Token Header Name: A XsrfHeaderName. The default value is RestDispatchAsyncModule.DEFAULT_XSRF_NAME.
• Serialization Implementation: A Serialization implementation. The default is JsonSerialization.
• Request timeout: The number of milliseconds to wait for a request to complete. The default value is 0 (no timeout).

Constructor Summary

Constructors

Constructor and Description
RestDispatchAsyncModuleBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
RestParameterBuilder	addGlobalHeaderParam(String key) Initiate the creation of a global header parameter that will be attached to all requests.
RestParameterBuilder	addGlobalQueryParam(String key) Initiate the creation of a global query parameter that will be attached to all requests.
RestDispatchAsyncModule	build() Build the AbstractDispatchAsyncModule.
RestDispatchAsyncModuleBuilder	defaultDateFormat(String defaultDateFormat) Specify the pattern to use to format dates before they are sent to the end-point.
String	getDefaultDateFormat()
Multimap<HttpMethod,RestParameter>	getGlobalHeaderParams()
Multimap<HttpMethod,RestParameter>	getGlobalQueryParams()
int	getRequestTimeoutMs()
Class<? extends Serialization>	getSerializationClass()
String	getXsrfTokenHeaderName()
RestDispatchAsyncModuleBuilder	requestTimeout(int timeoutMs) Specify the number of milliseconds to wait for a request to complete.
RestDispatchAsyncModuleBuilder	serialization(Class<? extends Serialization> serializationClass) Specify the serialization implementation to use.
RestDispatchAsyncModuleBuilder	xcsrfTokenHeaderName(String xsrfTokenHeaderName) Deprecated. See xsrfTokenHeaderName(String)
RestDispatchAsyncModuleBuilder	xsrfTokenHeaderName(String xsrfTokenHeaderName) Specify the XSRF token header name.

Methods inherited from class com.gwtplatform.dispatch.client.gin.AbstractDispatchAsyncModule.Builder

clientActionHandlerRegistry, dispatchHooks, exceptionHandler, sessionAccessor

Methods inherited from class java.lang.Object

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

Constructor Detail

RestDispatchAsyncModuleBuilder

public RestDispatchAsyncModuleBuilder()

Method Detail

addGlobalHeaderParam

public RestParameterBuilder addGlobalHeaderParam(String key)

Initiate the creation of a global header parameter that will be attached to all requests.

Parameters:

key - The key used for this parameter

Returns:

the parameter builder instance

addGlobalQueryParam

public RestParameterBuilder addGlobalQueryParam(String key)

Initiate the creation of a global query parameter that will be attached to all requests.

Parameters:

key - The key used for this parameter

Returns:

the parameter builder instance

build

public RestDispatchAsyncModule build()

Description copied from class: AbstractDispatchAsyncModule.Builder

Build the AbstractDispatchAsyncModule.

Specified by:

build in class AbstractDispatchAsyncModule.Builder

Returns:

The built AbstractDispatchAsyncModule.

defaultDateFormat

public RestDispatchAsyncModuleBuilder defaultDateFormat(String defaultDateFormat)

Specify the pattern to use to format dates before they are sent to the end-point. The pattern must follow the rules defined by DateTimeFormat.

Default is DateFormat.DEFAULT.

Parameters:

defaultDateFormat - The pattern used to format dates.

Returns:

this builder object.

getDefaultDateFormat

public String getDefaultDateFormat()

getGlobalHeaderParams

public Multimap<HttpMethod,RestParameter> getGlobalHeaderParams()

getGlobalQueryParams

public Multimap<HttpMethod,RestParameter> getGlobalQueryParams()

getRequestTimeoutMs

public int getRequestTimeoutMs()

getSerializationClass

public Class<? extends Serialization> getSerializationClass()

getXsrfTokenHeaderName

public String getXsrfTokenHeaderName()

requestTimeout

public RestDispatchAsyncModuleBuilder requestTimeout(int timeoutMs)

Specify the number of milliseconds to wait for a request to complete. If the timeout is reached, AsyncCallback#onFailure(Throwable) will be called. Default is 0: no timeout.

Parameters:

timeoutMs - The maximum time to wait, in milliseconds, or 0 for no timeout.

Returns:

this builder object.

serialization

public RestDispatchAsyncModuleBuilder serialization(Class<? extends Serialization> serializationClass)

Specify the serialization implementation to use. Default is JsonSerialization.

Parameters:

serializationClass - The Serialization implementation to use.

Returns:

this builder object.

xcsrfTokenHeaderName

@Deprecated
public RestDispatchAsyncModuleBuilder xcsrfTokenHeaderName(String xsrfTokenHeaderName)

Deprecated. See xsrfTokenHeaderName(String)

Specify the XSRF token header name.

xsrfTokenHeaderName

public RestDispatchAsyncModuleBuilder xsrfTokenHeaderName(String xsrfTokenHeaderName)

Specify the XSRF token header name.

Parameters:

xsrfTokenHeaderName - The XSRF token header name.

Returns:

this builder object.