com.strongloop.android.remoting.adapters

Class RestAdapter

java.lang.Object

com.strongloop.android.remoting.adapters.Adapter

com.strongloop.android.remoting.adapters.RestAdapter

Direct Known Subclasses:

RestAdapter

public class RestAdapter
extends Adapter

A specific Adapter implementation for RESTful servers. In addition to implementing the Adapter interface, RestAdapter contains a single RestContract to map remote methods to custom HTTP routes. This is only required if the HTTP settings have been customized on the server. When in doubt, try without.

See Also:

RestContract

Nested Class Summary

Nested classes/interfaces inherited from class com.strongloop.android.remoting.adapters.Adapter

Adapter.BinaryCallback, Adapter.Callback, Adapter.JsonArrayCallback, Adapter.JsonCallback, Adapter.JsonObjectCallback

Constructor Summary

Constructors

Constructor and Description
RestAdapter(android.content.Context context, java.lang.String url)

Method Summary

Methods

Modifier and Type	Method and Description
void	connect(android.content.Context context, java.lang.String url) Connects the Adapter to `url`.
protected com.loopj.android.http.AsyncHttpClient	getClient() Get the underlying HTTP client.
RestContract	getContract() Gets this adapter's RestContract, a custom contract for fine-grained route configuration.
void	invokeInstanceMethod(java.lang.String method, java.util.Map<java.lang.String,? extends java.lang.Object> constructorParameters, java.util.Map<java.lang.String,? extends java.lang.Object> parameters, Adapter.BinaryCallback callback) Invokes a remotable method exposed within a prototype on the server, parses the response as binary data.
void	invokeInstanceMethod(java.lang.String method, java.util.Map<java.lang.String,? extends java.lang.Object> constructorParameters, java.util.Map<java.lang.String,? extends java.lang.Object> parameters, Adapter.Callback callback) Invokes a remotable method exposed within a prototype on the server.
void	invokeStaticMethod(java.lang.String method, java.util.Map<java.lang.String,? extends java.lang.Object> parameters, Adapter.BinaryCallback callback) Invokes a remotable method exposed statically on the server, parses the response as binary data.
void	invokeStaticMethod(java.lang.String method, java.util.Map<java.lang.String,? extends java.lang.Object> parameters, Adapter.Callback callback) Invokes a remotable method exposed statically on the server.
boolean	isConnected() Gets whether this adapter is connected to a server.
void	setContract(RestContract contract) Sets this adapter's RestContract, a custom contract for fine-grained route configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestAdapter

public RestAdapter(android.content.Context context,
           java.lang.String url)

Method Detail

getContract

public RestContract getContract()

Gets this adapter's RestContract, a custom contract for fine-grained route configuration.

Returns:

the contract.

getClient

protected com.loopj.android.http.AsyncHttpClient getClient()

Get the underlying HTTP client. This allows subclasses to add custom headers like Authorization.

Returns:

the client.

setContract

public void setContract(RestContract contract)

Sets this adapter's RestContract, a custom contract for fine-grained route configuration.

Parameters:

contract - The contract.

connect

public void connect(android.content.Context context,
           java.lang.String url)

Description copied from class: Adapter

Connects the Adapter to `url`.

Specified by:

connect in class Adapter

url - The URL to connect to.

isConnected

public boolean isConnected()

Description copied from class: Adapter

Gets whether this adapter is connected to a server.

Specified by:

isConnected in class Adapter

Returns:

true if connected, false otherwise.

invokeStaticMethod

public void invokeStaticMethod(java.lang.String method,
                      java.util.Map<java.lang.String,? extends java.lang.Object> parameters,
                      Adapter.Callback callback)

Invokes a remotable method exposed statically on the server.

Unlike Adapter.invokeInstanceMethod(String, Map, Map, Callback), no object needs to be created on the server.

Specified by:

invokeStaticMethod in class Adapter

Parameters:

method - The method to invoke, e.g. "module.doSomething".

parameters - The parameters to invoke with.

callback - The callback to invoke when the execution finishes.

Throws:

java.lang.IllegalStateException - if the contract is not set (see setContract(RestContract)) or the adapter is not connected.

invokeStaticMethod

public void invokeStaticMethod(java.lang.String method,
                      java.util.Map<java.lang.String,? extends java.lang.Object> parameters,
                      Adapter.BinaryCallback callback)

Invokes a remotable method exposed statically on the server, parses the response as binary data.

Unlike Adapter.invokeInstanceMethod(String, Map, Map, BinaryCallback), no object needs to be created on the server.

Overrides:

invokeStaticMethod in class Adapter

Parameters:

method - The method to invoke, e.g. "module.doSomething".

parameters - The parameters to invoke with.

callback - The callback to invoke when the execution finishes.

Throws:

java.lang.IllegalStateException - if the contract is not set (see setContract(RestContract)) or the adapter is not connected.

invokeInstanceMethod

public void invokeInstanceMethod(java.lang.String method,
                        java.util.Map<java.lang.String,? extends java.lang.Object> constructorParameters,
                        java.util.Map<java.lang.String,? extends java.lang.Object> parameters,
                        Adapter.Callback callback)

Invokes a remotable method exposed within a prototype on the server.

This should be thought of as a two-step process. First, the server loads or creates an object with the appropriate type. Then and only then is the method invoked on that object. The two parameter dictionaries correspond to these two steps: `creationParameters` for the former, and `parameters` for the latter.

Specified by:

invokeInstanceMethod in class Adapter

Parameters:

method - The method to invoke, e.g. "MyClass.prototype.doSomething".

constructorParameters - The parameters the virtual object should be created with.

parameters - The parameters to invoke with.

callback - The callback to invoke when the execution finishes.

Throws:

java.lang.IllegalStateException - if the contract is not set (see setContract(RestContract)) or the adapter is not connected.

invokeInstanceMethod

public void invokeInstanceMethod(java.lang.String method,
                        java.util.Map<java.lang.String,? extends java.lang.Object> constructorParameters,
                        java.util.Map<java.lang.String,? extends java.lang.Object> parameters,
                        Adapter.BinaryCallback callback)

Invokes a remotable method exposed within a prototype on the server, parses the response as binary data.

This should be thought of as a two-step process. First, the server loads or creates an object with the appropriate type. Then and only then is the method invoked on that object. The two parameter dictionaries correspond to these two steps: `creationParameters` for the former, and `parameters` for the latter.

Overrides:

invokeInstanceMethod in class Adapter

Parameters:

method - The method to invoke, e.g. "MyClass.prototype.doSomething".

constructorParameters - The parameters the virtual object should be created with.

parameters - The parameters to invoke with.

callback - The callback to invoke when the execution finishes.

Throws:

java.lang.IllegalStateException - if the contract is not set (see setContract(RestContract)) or the adapter is not connected.