com.gwtplatform.dispatch.rest.client

Class DefaultRestRequestBuilderFactory

java.lang.Object

com.gwtplatform.dispatch.rest.client.DefaultRestRequestBuilderFactory

All Implemented Interfaces:

RestRequestBuilderFactory

public class DefaultRestRequestBuilderFactory
extends Object
implements RestRequestBuilderFactory

Default implementation for RestRequestBuilderFactory.

Method Summary

Methods

Modifier and Type	Method and Description
<A extends RestAction<?>> RequestBuilder	build(A action, String securityToken) Build a RequestBuilder object for the given action.
protected boolean	canSerialize(String bodyType) Verify if the provided bodyType can be serialized.
protected String	encodePathParam(String value) Encodes the given RestParameter as a path parameter.
protected String	encodeQueryParam(String value) Encodes the given RestParameter as a query parameter.
protected String	serialize(Object object, String bodyType) Serialize the given object.

Methods inherited from class java.lang.Object

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

Method Detail

build

public <A extends RestAction<?>> RequestBuilder build(A action,
                                             String securityToken)
                     throws ActionException

Description copied from interface: RestRequestBuilderFactory

Build a RequestBuilder object for the given action.

Specified by:

build in interface RestRequestBuilderFactory

Type Parameters:

A - the action type.

Parameters:

action - the RestAction for which to build the request.

securityToken - the security token to add to the RequestBuilder. Usually the value bound to @XsrfHeaderName.

Returns:

a RequestBuilder object.

Throws:

ActionException - if an exception occured while creating the RequestBuilder.

encodePathParam

protected String encodePathParam(String value)
                          throws ActionException

Encodes the given RestParameter as a path parameter. The default implementation delegates to UrlUtils.encodePathSegment(String).

Parameters:

value - the value to encode.

Returns:

the encoded path parameter.

Throws:

ActionException - if an exception occurred while encoding the path parameter.

See Also:

#encode(com.gwtplatform.dispatch.rest.shared.RestParameter)

encodeQueryParam

protected String encodeQueryParam(String value)
                           throws ActionException

Encodes the given RestParameter as a query parameter. The default implementation delegates to UrlUtils.encodeQueryString(String).

Parameters:

value - the value to encode.

Returns:

the encoded query parameter.

Throws:

ActionException - if an exception occurred while encoding the query parameter.

See Also:

#encode(com.gwtplatform.dispatch.rest.shared.RestParameter)

canSerialize

protected boolean canSerialize(String bodyType)

Verify if the provided bodyType can be serialized.

Parameters:

bodyType - the parameterized type to verify if it can be serialized.

Returns:

true if bodyType can be serialized, otherwise false.

serialize

protected String serialize(Object object,
               String bodyType)

Serialize the given object. We assume canSerialize(String) returns true or a runtime exception may be thrown.

Parameters:

object - the object to serialize.

bodyType - The parameterized type of the object to serialize.

Returns:

The serialized string.