org.agorava.spi

Class ProviderApiService

java.lang.Object

org.agorava.spi.ProviderApiService

public abstract class ProviderApiService
extends Object

Abstract base class for all Provider high level REST API calls.

Concrete class must implement some or API of the remote service

Author:

Antoine Sabot-Durand

Field Summary

Fields

Modifier and Type	Field and Description
protected HttpParameters	params Helps the service to build URI to call tier API

Constructor Summary

Constructors

Constructor and Description
ProviderApiService()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	buildAbsoluteUri(String uri) Build an URI.
protected String	buildUri(String uri, Map<String,? extends Object> parameters) Build an URI with multiple parameters coming from a Map
protected String	buildUri(String uri, String key, String value) Build an URI with a parameter
protected abstract OAuthService	getService()
protected OAuthSession	getSession()

Methods inherited from class java.lang.Object

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

Field Detail

params

@Inject
protected HttpParameters params

Helps the service to build URI to call tier API

Constructor Detail

ProviderApiService

public ProviderApiService()

Method Detail

buildUri

protected String buildUri(String uri,
              String key,
              String value)

Build an URI with a parameter

Parameters:

uri - base url

key - param name

value - param value

Returns:

absolute uri to perform call to remote service API

buildUri

protected String buildUri(String uri,
              Map<String,? extends Object> parameters)

Build an URI with multiple parameters coming from a Map

Parameters:

uri - base url

parameters - map containing parameters

Returns:

absolute uri to perform call to remote service API

buildAbsoluteUri

protected String buildAbsoluteUri(String uri)

Build an URI. This method should be overridden to build complete URI from relative URI By default it returns the value in parameter to work with absolute uri

Parameters:

uri - to transform in absolute version

Returns:

absolute URI

getService

protected abstract OAuthService getService()

Returns:

the underlying service to communicate with Provider Service

getSession

protected OAuthSession getSession()

Returns:

the current user session