org.agorava.api.oauth

Interface OAuthService

All Superinterfaces:

RestService, Serializable

public interface OAuthService
extends RestService

Provides all Oauth Services

Author:

Antoine Sabot-Durand

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	get(String uri, Class<T> clazz, boolean signed) Perform a conditionally signed REST get command and return an object of the provided class
Token	getAccessToken()
Token	getAccessToken(Token requestToken, String verifier) Returns the Oauth access token from request token and verifier
Token	getAccessToken(Token requestToken, Verifier verifier) Retrieve the access token
String	getAuthorizationUrl() Returns the url to the OAuth service to ask an authorization to access the service.
JsonMapperService	getJsonMapper()
Token	getRequestToken() Returns an OAuth request token to initiate an OAuth connection.
OAuthSession	getSession()
String	getVerifier() Access to OAuth verifier
String	getVerifierParamName() Gives the OAuth verifier parameter name
String	getVersion() Gives the OAuth version of the provider
OAuthRequest	requestFactory(Verb verb, String uri) Creates an OAuthRequest with the given Rest Verb and uri
Response	sendSignedRequest(OAuthRequest request) Signs and sends a simple request
Response	sendSignedRequest(Verb verb, String uri) Send an OAuth request signed without any parameter
Response	sendSignedRequest(Verb verb, String uri, Map<String,?> params) Send an OAuth request signed with a list a parameter
Response	sendSignedRequest(Verb verb, String uri, String key, Object value) Send an OAuth request signed with a single parameter
Response	sendSignedXmlRequest(Verb verb, String uri, String payload) Send an OAuth request signed with an XML Payload as content
void	setAccessToken(String token, String secret) Initialize and set an OAuth access token from its and private keys
void	setAccessToken(Token token) Set the Access Token with for an OAuth access
void	setVerifier(String verifierStr) Used to initialize verifier code returned by OAuth service
void	signRequest(Token accessToken, OAuthRequest request) Sign an OAuthRequest in order to make it valid for targeted service

Methods inherited from interface org.agorava.api.rest.RestService

delete, get, get, getSocialMediaName, isConnected, post, post, put

Method Detail

getAccessToken

Token getAccessToken()

Returns:

the access token for the OAuth service

setAccessToken

void setAccessToken(Token token)

Set the Access Token with for an OAuth access

Parameters:

token - the token to set

getAuthorizationUrl

String getAuthorizationUrl()

Returns the url to the OAuth service to ask an authorization to access the service.

Returns:

the REST URL to use request access

getVerifier

String getVerifier()

Access to OAuth verifier

Returns:

the OAUth verifier

setVerifier

void setVerifier(String verifierStr)

Used to initialize verifier code returned by OAuth service

Parameters:

verifierStr - verifier code

sendSignedRequest

Response sendSignedRequest(Verb verb,
                         String uri)

Send an OAuth request signed without any parameter

Parameters:

verb - a REST verb

uri - the REST address of the request

Returns:

an HttpResponse containing the response. It could be in various format (json, xml, string)

sendSignedRequest

Response sendSignedRequest(Verb verb,
                         String uri,
                         Map<String,?> params)

Send an OAuth request signed with a list a parameter

Parameters:

verb - a REST verb

uri - the REST address of the request

params - a Map of key value parameters to send in the header of the request

Returns:

an HttpResponse containing the response. It could be in various format (json, xml, string)

sendSignedRequest

Response sendSignedRequest(Verb verb,
                         String uri,
                         String key,
                         Object value)

Send an OAuth request signed with a single parameter

Parameters:

verb - a REST verb

uri - the REST address of the request

key - name of the parameter

value - value of the parameter

Returns:

an HttpResponse containing the response. It could be in various format (json, xml, string)

setAccessToken

void setAccessToken(String token,
                  String secret)

Initialize and set an OAuth access token from its and private keys

Parameters:

token - key

secret - secret keys

sendSignedXmlRequest

Response sendSignedXmlRequest(Verb verb,
                            String uri,
                            String payload)

Send an OAuth request signed with an XML Payload as content

Parameters:

verb - the REST verb of the request

uri - the url of the remote request

payload - the content of the XML payload to send to the service

Returns:

an HttpResponse containing the response. It could be in various format (json, xml, string)

getSession

OAuthSession getSession()

Returns:

the session settings of the given service

sendSignedRequest

Response sendSignedRequest(OAuthRequest request)

Signs and sends a simple request

Parameters:

request - the request to sign and send

Returns:

the response

get

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

Perform a conditionally signed REST get command 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

signed - indicate if the request has to be signed or not

Returns:

the answer in the asked class T

getVerifierParamName

String getVerifierParamName()

Gives the OAuth verifier parameter name

Returns:

the verifier name

getRequestToken

Token getRequestToken()

Returns an OAuth request token to initiate an OAuth connection. It's the the first step of OAuth negotiation connexion

Returns:

an OAuth request token

getAccessToken

Token getAccessToken(Token requestToken,
                   String verifier)

Returns the Oauth access token from request token and verifier

Parameters:

requestToken - Request token sent to Social Media

verifier - Verifier returned by Social Media after sending the Request Token

Returns:

an OAuth access token

getAccessToken

Token getAccessToken(Token requestToken,
                   Verifier verifier)

Retrieve the access token

Parameters:

requestToken - request token (obtained previously)

verifier - verifier code

Returns:

access token

signRequest

void signRequest(Token accessToken,
               OAuthRequest request)

Sign an OAuthRequest in order to make it valid for targeted service

Parameters:

accessToken - the OAuth access token for the current OAuth session

request - the OAuth request to sign

getVersion

String getVersion()

Gives the OAuth version of the provider

Returns:

the OAuth version used by the provider (i.e. 1.0a or 2.0)

requestFactory

OAuthRequest requestFactory(Verb verb,
                          String uri)

Creates an OAuthRequest with the given Rest Verb and uri

Parameters:

verb - Rest verb to build the request

uri - URI of the request

Returns:

the created OAuthRequest

getJsonMapper

JsonMapperService getJsonMapper()

Returns:

a service to map Json to POJO