org.agorava.api.rest

Interface RestService

All Superinterfaces:

Serializable

All Known Subinterfaces:

OAuthService

public interface RestService
extends Serializable

Manage basic REST actions

Author:

Antoine Sabot-Durand

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(String uri) Perform a REST delete command with given uri
<T> T	get(String uri, Class<T> clazz) Perform a REST Get command and return an object of the provided class
<T> T	get(String uri, Class<T> clazz, Object... urlParams) Perform a REST get command with given parameters to put in the given URI and return an object of the provided class
String	getSocialMediaName() Returns the name/type of the Social Network we're connected to
boolean	isConnected() Returns the status of this Service
<T> T	post(String uri, Map<String,?> params, Class<T> clazz) Perform a REST post command with given parameters to put in Body and return an object of the provided class
String	post(String uri, Object toPost, Object... urlParams) Perform a REST post command with given object and given URI params.
void	put(String uri, Object toPut, Object... urlParams) Perform a REST put command with given object and given URI params

Method Detail

isConnected

boolean isConnected()

Returns the status of this Service

Returns:

true if the connection process is over and successful

getSocialMediaName

String getSocialMediaName()

Returns the name/type of the Social Network we're connected to

Returns:

name of the service

get

<T> T get(String uri,
        Class<T> clazz)

Perform a REST Get command and return an object of the provided class

Parameters:

uri - the uri to perform the rest get call

clazz - class of the returned object

Returns:

an object of the asked class

get

<T> T get(String uri,
        Class<T> clazz,
        Object... urlParams)

Perform a REST get command with given parameters to put in the given URI and return an object of the provided class

Type Parameters:

T - generic type for returned object

Parameters:

uri - a string with MessageFormat placeholders (i.e. {0}, {1}) style for params. It's the uri to perform the REST get call

clazz - class of the returned object

urlParams - list of params to feed the uri with

Returns:

an object of the asked class

post

<T> T post(String uri,
         Map<String,?> params,
         Class<T> clazz)

Perform a REST post command with given parameters to put in Body and return an object of the provided class

Type Parameters:

T - generic type for returned object

Parameters:

uri - the URI to post to

params - parameters to put in body

clazz - class of the returned object

Returns:

an object of the asked class

post

String post(String uri,
          Object toPost,
          Object... urlParams)

Perform a REST post command with given object and given URI params. Expecting a String (a new URL) as returned data

Parameters:

uri - a string with MessageFormat placeholders (i.e. {0}, {1}) style for params. It's the uri to perform the REST post call

toPost - the object to post

urlParams - list of params to feed the uri with

Returns:

an uri pointing to a resource corresponding to posted object

put

void put(String uri,
       Object toPut,
       Object... urlParams)

Perform a REST put command with given object and given URI params

Parameters:

uri - a string with MessageFormat placeholders (i.e. {0}, {1}) style for params. It's the uri to perform the REST put call

toPut - the object to put

urlParams - list of params to feed the uri with

delete

void delete(String uri)

Perform a REST delete command with given uri

Parameters:

uri - to perform te REST delete call