A B C D E G H I J K M N O P Q R S T U V W

A

ACCESS_TOKEN - Static variable in interface org.agorava.AgoravaConstants

Access Token field name in OAuth request

accessToken(Token) - Method in class org.agorava.api.oauth.OAuthSession.Builder

Set the OAuth Access token for the session

add(String, String) - Method in interface org.agorava.api.rest.HttpParameters

Create a param from key value and add it to the list

add(T) - Method in interface org.agorava.api.storage.Repository

Add the given element

addAll(HttpParameters) - Method in interface org.agorava.api.rest.HttpParameters

Merge another HttpParameters in this list

addBodyParameter(String, String) - Method in interface org.agorava.api.rest.Request

Add a body Parameter (for POST/ PUT Requests)

addBodyParameters(Map<String, ? extends Object>) - Method in interface org.agorava.api.rest.Request

Add Body parameters from a map

addHeader(String, String) - Method in interface org.agorava.api.rest.Request

Add an HTTP HEADER to the Request

addMap(Map<String, ? extends Object>) - Method in interface org.agorava.api.rest.HttpParameters

Add a map to this param list

addOAuthParameter(String, String) - Method in interface org.agorava.api.oauth.OAuthRequest

Adds an OAuth parameter to the request.

addPayload(String) - Method in interface org.agorava.api.rest.Request

Add body payload from a String

addPayload(byte[]) - Method in interface org.agorava.api.rest.Request

Add body payload from an Array of bytes

addQuerystring(String) - Method in interface org.agorava.api.rest.HttpParameters

Add a Query String in this param list.

addQuerystringParameter(String, String) - Method in interface org.agorava.api.rest.Request

Add a QueryString parameter

AgoravaConstants - Interface in org.agorava

This interface contains OAuth and other Agorava constants

AgoravaContext - Class in org.agorava

Class containing configuration for Agorava.

AgoravaContext() - Constructor for class org.agorava.AgoravaContext

Default protected constructor to prevent instantiation of this class

AgoravaException - Exception in org.agorava.api.exception

Default Agorava exception.

AgoravaException(String, Exception) - Constructor for exception org.agorava.api.exception.AgoravaException

Default constructor

AgoravaException(String) - Constructor for exception org.agorava.api.exception.AgoravaException

No-exception constructor.

AgoravaException(Exception) - Constructor for exception org.agorava.api.exception.AgoravaException

No-message constructor.

API_KEY - Static variable in interface org.agorava.api.oauth.application.OAuthAppSettingsBuilder

key label for the consumer key of the OAuth application

API_SECRET - Static variable in interface org.agorava.api.oauth.application.OAuthAppSettingsBuilder

key label for the consumer secret of the OAuth application

apiKey(String) - Method in interface org.agorava.api.oauth.application.OAuthAppSettingsBuilder

Set the Social Media application consumer key

apiKey(String) - Method in class org.agorava.api.oauth.application.SimpleOAuthAppSettingsBuilder

apiSecret(String) - Method in interface org.agorava.api.oauth.application.OAuthAppSettingsBuilder

Set the Social Media application secret key

apiSecret(String) - Method in class org.agorava.api.oauth.application.SimpleOAuthAppSettingsBuilder

AppSettingsTuner - Interface in org.agorava.spi

An interface to provide a way to tune OAuthAppSettings

asFormUrlEncodedString() - Method in interface org.agorava.api.rest.HttpParameters

asOauthBaseString() - Method in interface org.agorava.api.rest.HttpParameters

asUrl(String) - Method in interface org.agorava.api.rest.HttpParameters

Append the list to an URL

B

BeanResolver - Class in org.agorava.api.atinject

Provide an agnostic way to resolve a bean across all JSR 330 engine

BeanResolver() - Constructor for class org.agorava.api.atinject.BeanResolver

build() - Method in interface org.agorava.api.oauth.application.OAuthAppSettingsBuilder

Builds the OAuthAppSettings

build() - Method in class org.agorava.api.oauth.application.PropertyOAuthAppSettingsBuilder

Builds the OAuthAppSettings

build() - Method in class org.agorava.api.oauth.application.SimpleOAuthAppSettingsBuilder

build() - Method in class org.agorava.api.oauth.OAuthSession.Builder

Build the OAuthSession

buildAbsoluteUri(String) - Method in class org.agorava.spi.ProviderApiService

Build an URI.

buildSessionFor(String) - Method in interface org.agorava.api.service.OAuthLifeCycleService

Build a new OAuth Session for the given provider name and set it as current

buildSessionFor(Annotation) - Method in interface org.agorava.api.service.OAuthLifeCycleService

Build a new OAuth Session for the given provider qualifier and set it as current

buildUri(String, String, String) - Method in class org.agorava.spi.ProviderApiService

Build an URI with a parameter

buildUri(String, Map<String, ? extends Object>) - Method in class org.agorava.spi.ProviderApiService

Build an URI with multiple parameters coming from a Map

BUNDLE_NAME - Static variable in class org.agorava.api.oauth.application.PropertyOAuthAppSettingsBuilder

Global constant to give type safe name for the bundleName property when used in .application.OAuthApplication

bundleName(String) - Method in class org.agorava.api.oauth.application.PropertyOAuthAppSettingsBuilder

Set the bundle name to read settings from.

C

CALLBACK - Static variable in interface org.agorava.AgoravaConstants

Call Back Url field name in OAuth request

CALLBACK - Static variable in interface org.agorava.api.oauth.application.OAuthAppSettingsBuilder

key label for the call back url to send to of the tier service

callback(String) - Method in interface org.agorava.api.oauth.application.OAuthAppSettingsBuilder

Set the Callback for the application

callback(String) - Method in class org.agorava.api.oauth.application.SimpleOAuthAppSettingsBuilder

Set the Callback for the application

CALLBACK_URL - Static variable in interface org.agorava.AgoravaConstants

default OAuth Callback relative url to send user when returning from OAuth service.

checkEmptyString(String, String) - Static method in class org.agorava.api.service.Preconditions

Checks that a string is not null or empty

checkNotNull(Object, String) - Static method in class org.agorava.api.service.Preconditions

Checks that an object is not null.

checkValidOAuthCallback(String, String) - Static method in class org.agorava.api.service.Preconditions

Checks that a URL is a valid OAuth callback

checkValidUrl(String, String) - Static method in class org.agorava.api.service.Preconditions

Checks that a URL is valid

CLIENT_ID - Static variable in interface org.agorava.AgoravaConstants

Client Id field name in OAuth request

CLIENT_SECRET - Static variable in interface org.agorava.AgoravaConstants

Client Secret field name in OAuth request

CODE - Static variable in interface org.agorava.AgoravaConstants

Return code field name in OAuth request

ConnectionException - Exception in org.agorava.api.exception

Low level exception in Rest attempt to connect to tier service

ConnectionException(Exception) - Constructor for exception org.agorava.api.exception.ConnectionException

Default constructor

CONSUMER_KEY - Static variable in interface org.agorava.AgoravaConstants

Consumer key field name in OAuth request

CONSUMER_SECRET - Static variable in interface org.agorava.AgoravaConstants

Consumer secret key field name in OAuth request

createNew() - Method in interface org.agorava.api.storage.GlobalRepository

Create a new element and set it as current

Current - Annotation Type in org.agorava.api.atinject

Qualifier to distinguish the current OAuthSession in a multiple OAuthSession context

D

decode(String) - Static method in class org.agorava.api.service.OAuthEncoder

Decode a String from OAuth format

delete(String) - Method in interface org.agorava.api.rest.RestService

Perform a REST delete command with given uri

E

EMPTY_TOKEN - Static variable in interface org.agorava.AgoravaConstants

An empty Token

encode(String) - Static method in class org.agorava.api.service.OAuthEncoder

Encode a String in OAuth format

endDance(String) - Method in interface org.agorava.api.service.OAuthLifeCycleService

OAuth dance exit point.

endDance() - Method in interface org.agorava.api.service.OAuthLifeCycleService

OAuth dance exit point.

equals(Object) - Method in class org.agorava.api.oauth.OAuthSession

equals(Object) - Method in class org.agorava.api.oauth.Token

equals(Object) - Method in class org.agorava.spi.UserProfile

extract(F) - Method in interface org.agorava.api.extractor.Extractor

Extract data from a given object

Extractor<T,F> - Interface in org.agorava.api.extractor

Generic Extractor, root of all Extractors hierarchy

ExtractorType - Annotation Type in org.agorava.api.extractor

Qualifier to distinguish different Extractor implementations

ExtractorType.Type - Enum in org.agorava.api.extractor

Different types of Extractor

G

GenericBean - Annotation Type in org.agorava.api.atinject

This qualifier is used to mark Class to indicate that it should be used to generate differrent beans for each ProviderRelated Qualifier.

get(String, Class<T>, boolean) - Method in interface org.agorava.api.oauth.OAuthService

Perform a conditionally signed REST get command and return an object of the provided class

get(String, Class<T>) - Method in interface org.agorava.api.rest.RestService

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

get(String, Class<T>, Object...) - Method in interface org.agorava.api.rest.RestService

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

get(String) - Method in interface org.agorava.api.storage.Repository

Return element with the given id

getAccessToken() - Method in interface org.agorava.api.oauth.OAuthService

getAccessToken(Token, String) - Method in interface org.agorava.api.oauth.OAuthService

Returns the Oauth access token from request token and verifier

getAccessToken(Token, Verifier) - Method in interface org.agorava.api.oauth.OAuthService

Retrieve the access token

getAccessToken() - Method in class org.agorava.api.oauth.OAuthSession

getAccessTokenEndpoint() - Method in class org.agorava.spi.ProviderConfigOauth10a

Returns the URL that receives the access token requests.

getAccessTokenEndpoint() - Method in class org.agorava.spi.ProviderConfigOauth20

Returns the URL that receives the access token requests.

getAccessTokenExtractor() - Method in class org.agorava.spi.ProviderConfigOauth

Returns the access token extractor.

getAccessTokenExtractor() - Method in class org.agorava.spi.ProviderConfigOauth10a

Returns the access token extractor.

getAccessTokenExtractor() - Method in class org.agorava.spi.ProviderConfigOauth20

Returns the access token extractor.

getAccessTokenExtractor() - Method in class org.agorava.spi.ProviderConfigOauth20Final

Returns the access token extractor.

getAccessTokenVerb() - Method in class org.agorava.spi.ProviderConfigOauth10a

Returns the verb for the access token endpoint (defaults to POST)

getAccessTokenVerb() - Method in class org.agorava.spi.ProviderConfigOauth20

Returns the verb for the access token endpoint (defaults to GET)

getAccessTokenVerb() - Method in class org.agorava.spi.ProviderConfigOauth20Final

Returns the verb for the access token endpoint (defaults to GET)

getAll() - Method in interface org.agorava.api.storage.Repository

getAllActiveSessions() - Method in interface org.agorava.api.service.OAuthLifeCycleService

getAllSessions() - Method in interface org.agorava.api.storage.GlobalRepository

getApiKey() - Method in class org.agorava.api.oauth.application.OAuthAppSettings

getApiSecret() - Method in class org.agorava.api.oauth.application.OAuthAppSettings

getAuthorizationUrl() - Method in interface org.agorava.api.oauth.OAuthService

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

getAuthorizationUrl(Token) - Method in class org.agorava.spi.ProviderConfigOauth10a

Returns the URL where you should redirect your users to authenticate your application.

getAuthorizationUrl(OAuthAppSettings) - Method in class org.agorava.spi.ProviderConfigOauth20

Returns the URL where you should redirect your users to authenticate your application.

getBaseStringExtractor() - Method in class org.agorava.spi.ProviderConfigOauth10a

Returns the base string extractor.

getBody() - Method in interface org.agorava.api.rest.Response

Obtains the HTTP Response body

getBodyContents() - Method in interface org.agorava.api.rest.Request

Returns the body of the request

getBodyParams() - Method in interface org.agorava.api.rest.Request

Obtains a HttpParameters of the body parameters.

getCallback() - Method in class org.agorava.api.oauth.application.OAuthAppSettings

getCharset() - Method in interface org.agorava.api.rest.Request

Returns the connection charset.

getCode() - Method in interface org.agorava.api.rest.Response

Obtains the HTTP status code

getCompleteUrl() - Method in interface org.agorava.api.rest.Request

Returns the complete url (host + resource + encoded querystring parameters).

getCurrent() - Method in interface org.agorava.api.storage.Repository

getCurrentRepository() - Method in interface org.agorava.spi.UserSessionRepositoryResolver

getCurrentService() - Method in interface org.agorava.api.service.OAuthLifeCycleService

getCurrentSession() - Method in interface org.agorava.api.service.OAuthLifeCycleService

getCurrentSession(UserSessionRepository) - Method in interface org.agorava.spi.SessionResolver

getCurrentUserProfileService() - Method in interface org.agorava.api.service.OAuthLifeCycleService

getEventData() - Method in class org.agorava.api.event.SocialEvent

getExtraData() - Method in class org.agorava.api.oauth.OAuthSession

getFullName() - Method in class org.agorava.spi.UserProfile

getHeader(String) - Method in interface org.agorava.api.rest.Response

Obtains a single HTTP HEADER value, or null if undefined

getHeaderExtractor() - Method in class org.agorava.spi.ProviderConfigOauth10a

Returns the header extractor.

getHeaders() - Method in interface org.agorava.api.rest.Request

Returns the connection headers as a Map

getHeaders() - Method in interface org.agorava.api.rest.Response

Obtains a Map containing the HTTP Response Headers

getId() - Method in class org.agorava.api.oauth.OAuthSession

getId() - Method in interface org.agorava.api.storage.Identifiable

getId() - Method in class org.agorava.spi.UserProfile

Permanent identifier against the social relationship for the life-time of the network account

getInstance() - Static method in class org.agorava.api.atinject.BeanResolver

getInternalCallBack() - Static method in class org.agorava.AgoravaContext

getJsonMapper() - Method in interface org.agorava.api.oauth.OAuthService

getLabel() - Method in enum org.agorava.api.oauth.OAuth.OAuthVersion

getListOfServices() - Static method in class org.agorava.AgoravaContext

getMessage() - Method in class org.agorava.api.event.SocialEvent

getName() - Method in class org.agorava.api.oauth.OAuthSession

getNonce() - Method in interface org.agorava.api.service.TimestampService

Returns a nonce (unique value for each request)

getOauthParameters() - Method in interface org.agorava.api.oauth.OAuthRequest

Returns the Map containing the key-value pair of parameters.

getOAuthVersion() - Method in class org.agorava.spi.ProviderConfigOauth

getOAuthVersion() - Method in class org.agorava.spi.ProviderConfigOauth10a

getOAuthVersion() - Method in class org.agorava.spi.ProviderConfigOauth20

getOAuthVersion() - Method in class org.agorava.spi.ProviderConfigOauth20Final

getProducerScope() - Static method in class org.agorava.AgoravaContext

getProfileImageUrl() - Method in class org.agorava.spi.UserProfile

getProviderAnnotation() - Method in class org.agorava.spi.ProviderConfig

getProviderName() - Method in class org.agorava.spi.ProviderConfig

getQualifier() - Method in class org.agorava.api.oauth.application.OAuthAppSettings

getQualifierToService() - Static method in class org.agorava.AgoravaContext

getQueryStringParams() - Method in interface org.agorava.api.rest.Request

Get a HttpParameters with the query string parameters.

getRepo() - Method in class org.agorava.api.oauth.OAuthSession

getRequest() - Method in interface org.agorava.api.rest.Response

getRequestToken() - Method in interface org.agorava.api.oauth.OAuthService

Returns an OAuth request token to initiate an OAuth connection.

getRequestToken() - Method in class org.agorava.api.oauth.OAuthSession

getRequestTokenEndpoint() - Method in class org.agorava.spi.ProviderConfigOauth10a

Returns the URL that receives the request token requests.

getRequestTokenExtractor() - Method in class org.agorava.spi.ProviderConfigOauth10a

Returns the request token extractor.

getRequestTokenVerb() - Method in class org.agorava.spi.ProviderConfigOauth10a

Returns the verb for the request token endpoint (defaults to POST)

getResponse() - Method in exception org.agorava.api.exception.ResponseException

getSanitizedUrl() - Method in interface org.agorava.api.rest.Request

Returns the URL without the port and the query string part.

getScope() - Method in class org.agorava.api.oauth.application.OAuthAppSettings

getSecret() - Method in class org.agorava.api.oauth.Token

getService() - Method in class org.agorava.spi.ProviderApiService

getServiceName() - Method in class org.agorava.api.oauth.OAuthSession

getServiceQualifier() - Method in class org.agorava.api.oauth.OAuthSession

getServicesToQualifier() - Static method in class org.agorava.AgoravaContext

getSession() - Method in interface org.agorava.api.oauth.OAuthService

getSession() - Method in class org.agorava.spi.ProviderApiService

getSignature(String, String, String) - Method in interface org.agorava.api.service.SignatureService

Returns the signature

getSignatureMethod() - Method in interface org.agorava.api.service.SignatureService

getSignaturePlace() - Method in class org.agorava.spi.ProviderConfigOauth

getSignatureService() - Method in class org.agorava.spi.ProviderConfigOauth10a

Returns the signature service.

getSocialMediaName() - Method in class org.agorava.api.oauth.application.OAuthAppSettings

getSocialMediaName() - Method in interface org.agorava.api.rest.RestService

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

getSocialRelated() - Static method in class org.agorava.AgoravaContext

getStatus() - Method in class org.agorava.api.event.SocialEvent

getStream() - Method in interface org.agorava.api.rest.Response

Obtains the meaningful stream of the HttpUrlConnection, either inputStream or errorInputStream, depending on the status code

getTimestampInSeconds() - Method in interface org.agorava.api.service.TimestampService

Returns the unix epoch timestamp in seconds

getTimestampService() - Method in class org.agorava.spi.ProviderConfigOauth10a

Returns the timestamp service.

getToken() - Method in class org.agorava.api.oauth.Token

getUrl() - Method in interface org.agorava.api.rest.Request

Obtains the URL of the HTTP Request.

getUserProfile() - Method in class org.agorava.api.oauth.OAuthSession

getUserProfile() - Method in interface org.agorava.spi.UserProfileService

getValue() - Method in class org.agorava.api.oauth.Verifier

getVerb() - Method in interface org.agorava.api.rest.Request

Returns the HTTP Verb

getVerifier() - Method in interface org.agorava.api.oauth.OAuthService

Access to OAuth verifier

getVerifier() - Method in class org.agorava.api.oauth.OAuthSession

getVerifierParamName() - Method in interface org.agorava.api.oauth.OAuthService

Gives the OAuth verifier parameter name

getVerifierParamName() - Method in interface org.agorava.api.service.OAuthLifeCycleService

return the name of the parameter for the verifier (OAuth 1.0a) or code (OAuth 2.0) returned by the provider in the callback

getVersion() - Method in interface org.agorava.api.oauth.OAuthService

Gives the OAuth version of the provider

GlobalRepository - Interface in org.agorava.api.storage

Represents a Repository containing data for all OAuth connexion in the application

H

hashCode() - Method in class org.agorava.api.oauth.OAuthSession

hashCode() - Method in class org.agorava.api.oauth.Token

hashCode() - Method in class org.agorava.spi.UserProfile

hasScope() - Method in class org.agorava.api.oauth.application.OAuthAppSettings

HEADER - Static variable in interface org.agorava.AgoravaConstants

HEADER field name in OAuth request

HttpParameters - Interface in org.agorava.api.rest

Http Parameters manipulation with various String transformation

I

id(String) - Method in class org.agorava.api.oauth.OAuthSession.Builder

Set the id for the session to build.

Identifiable - Interface in org.agorava.api.storage

Provides String id to implementations

InjectWithQualifier - Annotation Type in org.agorava.api.atinject

Annotation used in Generic Bean to mark injection point that should be modified by framework bootstrap to bear the same ProviderRelated qualifier than the containing bean.

instance - Static variable in class org.agorava.api.atinject.BeanResolver

The current Resolver.

INTERN_CALLBACK_PARAM - Static variable in interface org.agorava.AgoravaConstants

parameter name to store internal callback in OAuthSession.extraData

internalCallBack - Static variable in class org.agorava.AgoravaContext

The default internal callback when whe return from OAuth connexion

isConnected() - Method in class org.agorava.api.oauth.OAuthSession

isConnected() - Method in interface org.agorava.api.rest.RestService

Returns the status of this Service

isEmpty() - Method in class org.agorava.api.oauth.Token

isSuccessful() - Method in interface org.agorava.api.rest.Response

J

join(Collection, Character) - Static method in class org.agorava.api.service.StringUtils

Join a collection of Object with a given character as a separator

join(Object[], char) - Static method in class org.agorava.api.service.StringUtils

Join an array of Object with a given character as a separator

JsonMapperService - Interface in org.agorava.api.service

Manage JSON Serialization / De-serialization to and from Object

K

killCurrentSession() - Method in interface org.agorava.api.service.OAuthLifeCycleService

kill (disconnect and garbage) the current session

killSession(OAuthSession) - Method in interface org.agorava.api.service.OAuthLifeCycleService

kill (disconnect and garbage) the given session

M

mapToObject(Response, Class<T>) - Method in interface org.agorava.api.service.JsonMapperService

Parse the content of the provided Response to de-serialize to an object of the given Class

N

NAME - Static variable in interface org.agorava.api.oauth.application.OAuthAppSettingsBuilder

key label for the name of the OAuth service

name(String) - Method in interface org.agorava.api.oauth.application.OAuthAppSettingsBuilder

Set the name of the Social Media for which the settings are intended

name(String) - Method in class org.agorava.api.oauth.application.SimpleOAuthAppSettingsBuilder

NONCE - Static variable in interface org.agorava.AgoravaConstants

Unique stamp to field name in OAuth request

NULL - Static variable in class org.agorava.api.oauth.OAuthSession

A null OAuthSession used to avoid NPE

O

OAuth - Annotation Type in org.agorava.api.oauth

Qualifier to distinguish different implementations of services or helpers regarding OAuth version or OAuth 2.0 flavor

OAuth.OAuthVersion - Enum in org.agorava.api.oauth

The different values of OAuth

OAuthApplication - Annotation Type in org.agorava.api.oauth.application

This annotation is used to produce OAuthAppSettings in code

OAuthAppSettings - Class in org.agorava.api.oauth.application

Configuration settings needed to access to an OAuth 1.0a and 2.0 service tier.

OAuthAppSettingsBuilder - Interface in org.agorava.api.oauth.application

Builder for an OAuthAppSettings can be initialized directly from fields name or from an Array of Param in case of Annotation configuration with OAuthApplication.

OAuthComplete - Class in org.agorava.api.event

Event sent at the end of OAuth authentication cycle containing the new OAuthSession

OAuthComplete(SocialEvent.Status, String, OAuthSession) - Constructor for class org.agorava.api.event.OAuthComplete

OAuthEncoder - Class in org.agorava.api.service

Utility class to encode and decode string for OAuth Format

OAuthLifeCycleService - Interface in org.agorava.api.service

Main entry point for Agorava.

OAuthParametersMissingException - Exception in org.agorava.api.exception

Specialized exception that represents a missing OAuth parameter.

OAuthParametersMissingException(OAuthRequest) - Constructor for exception org.agorava.api.exception.OAuthParametersMissingException

Default constructor.

OAuthRequest - Interface in org.agorava.api.oauth

Extends Request to add OAuth specific

OAuthService - Interface in org.agorava.api.oauth

Provides all Oauth Services

OAuthSession - Class in org.agorava.api.oauth

Contains user data for a session connection to a given OAuthService.

OAuthSession.Builder - Class in org.agorava.api.oauth

Builder class for OAuthSession

OAuthSession.Builder() - Constructor for class org.agorava.api.oauth.OAuthSession.Builder

OAuthSignatureException - Exception in org.agorava.api.exception

Specialized exception that represents a problem in OAuth signature

OAuthSignatureException(String, Exception) - Constructor for exception org.agorava.api.exception.OAuthSignatureException

Default constructor

objectToJsonString(Object) - Method in interface org.agorava.api.service.JsonMapperService

Transforms an object to a JSON string

org.agorava - package org.agorava

Contains transverse and context configuration elements

org.agorava.api.atinject - package org.agorava.api.atinject

This package contains general JSR 330 Qualifier and associated annotations.

org.agorava.api.event - package org.agorava.api.event

This package contains all the events used by Agorava CDI implementation but could be used elsewhere since it doesn't have CDI or JSR 330 dependency

org.agorava.api.exception - package org.agorava.api.exception

This package contains all the Agorava specific exception

org.agorava.api.extractor - package org.agorava.api.extractor

This package contains different Extractor used in Agorava

org.agorava.api.oauth - package org.agorava.api.oauth

This package contains API elements to manage interactions with generic OAuth services

org.agorava.api.oauth.application - package org.agorava.api.oauth.application

This package contains all class related to OAuth application settings

org.agorava.api.rest - package org.agorava.api.rest

This package contains all the Agorava Rest client framework

org.agorava.api.service - package org.agorava.api.service

Agorava miscellaneous services and utilities

org.agorava.api.storage - package org.agorava.api.storage

This package contains storage API for Agorava

org.agorava.spi - package org.agorava.spi

Contains all Agorava's Service Provider Interface that has to be extended for each provider module

OUT_OF_BAND - Static variable in interface org.agorava.AgoravaConstants

Special "Out Of Band" Call back for non Web app

P

Param - Annotation Type in org.agorava.api.oauth.application

Support annotation to transport additional parameter for OAuthApplication annotation helping configuring the final OAuthAppSettingsBuilder

PARAM_PREFIX - Static variable in interface org.agorava.AgoravaConstants

Prefix field name in OAuth request

params(Param[]) - Method in interface org.agorava.api.oauth.application.OAuthAppSettingsBuilder

Load builder params with an array of Param.

params(Param[]) - Method in class org.agorava.api.oauth.application.SimpleOAuthAppSettingsBuilder

params - Variable in class org.agorava.spi.ProviderApiService

Helps the service to build URI to call tier API

post(String, Map<String, ?>, Class<T>) - Method in interface org.agorava.api.rest.RestService

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

post(String, Object, Object...) - Method in interface org.agorava.api.rest.RestService

Perform a REST post command with given object and given URI params.

Preconditions - Class in org.agorava.api.service

Utils for checking preconditions and invariants

PREFIX - Static variable in interface org.agorava.api.oauth.application.OAuthAppSettingsBuilder

key prefix label

PREFIX - Static variable in class org.agorava.api.oauth.application.PropertyOAuthAppSettingsBuilder

Global constant to give type safe name for the prefix property when used in .application.OAuthApplication

prefix(String) - Method in class org.agorava.api.oauth.application.PropertyOAuthAppSettingsBuilder

Set the prefix for the keys in the bundle If it's not used, default prefix will be empty

producerScope - Static variable in class org.agorava.AgoravaContext

Scope for the producer

PropertyOAuthAppSettingsBuilder - Class in org.agorava.api.oauth.application

This Builder creates a OAuthAppSettings from a ResourceBundle The bundle name is "agorava" ("agorava.properties" filename) by default but can be customized through (String) keys in the file must be : apiKey apiSecret callback scope

You can configure a prefix for the key with PropertyOAuthAppSettingsBuilder.prefix(String).

PropertyOAuthAppSettingsBuilder() - Constructor for class org.agorava.api.oauth.application.PropertyOAuthAppSettingsBuilder

ProviderApiService - Class in org.agorava.spi

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

ProviderApiService() - Constructor for class org.agorava.spi.ProviderApiService

ProviderConfig - Class in org.agorava.spi

Root of all providers services configuration

ProviderConfig() - Constructor for class org.agorava.spi.ProviderConfig

Default constructor used to find Provider's name in ProviderRelated meta annotation that must be present on mandatory annotation on all concrete ProviderConfig descendants

ProviderConfigOauth - Class in org.agorava.spi

Root of all OAuth providers services configuration

ProviderConfigOauth() - Constructor for class org.agorava.spi.ProviderConfigOauth

ProviderConfigOauth.SignaturePlace - Enum in org.agorava.spi

Places where signature could be stored in OAuthRequest for OAuth 1.0a

ProviderConfigOauth10a - Class in org.agorava.spi

Default Provider configuration implementing the OAuth protocol, version 1.0a

This class is meant to be extended by concrete implementations of the Provider configuration, providing the endpoints and endpoint-http-verbs.

ProviderConfigOauth10a() - Constructor for class org.agorava.spi.ProviderConfigOauth10a

ProviderConfigOauth20 - Class in org.agorava.spi

Default Provider configuration implementing the OAuth protocol, version 2.0 (draft 11)

This class is meant to be extended by concrete implementations of the API, providing the endpoints and endpoint-http-verbs.

ProviderConfigOauth20() - Constructor for class org.agorava.spi.ProviderConfigOauth20

ProviderConfigOauth20Final - Class in org.agorava.spi

Default Provider configuration implementing the OAuth protocol, version 2.0 final

This class is meant to be extended by concrete implementations of the API, providing the endpoints and endpoint-http-verbs.

ProviderConfigOauth20Final() - Constructor for class org.agorava.spi.ProviderConfigOauth20Final

ProviderMismatchException - Exception in org.agorava.api.exception

Exception launch when an action has to used two beans belonging to different providers (i.e an OAuthSession for Provider A and an OAuthService for provider B

ProviderMismatchException(String) - Constructor for exception org.agorava.api.exception.ProviderMismatchException

Default constructor

providerName(String) - Method in class org.agorava.api.oauth.OAuthSession.Builder

Set the provider qualifier for the session from the provider name

ProviderRelated - Annotation Type in org.agorava.api.atinject

This Meta-annotation is used to annotate Service Providers (i.e.

put(String, Object, Object...) - Method in interface org.agorava.api.rest.RestService

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

Q

qualifier(Annotation) - Method in interface org.agorava.api.oauth.application.OAuthAppSettingsBuilder

Set the qualifier of the Social Media for which the settings are intended.

qualifier(Annotation) - Method in class org.agorava.api.oauth.application.SimpleOAuthAppSettingsBuilder

qualifier(Annotation) - Method in class org.agorava.api.oauth.OAuthSession.Builder

Set the provider qualifier for the session

R

readFromOAuthSession(OAuthSession) - Method in class org.agorava.api.oauth.OAuthSession.Builder

Configure this builder with an existing OAuthSession.

readFromSettings(OAuthAppSettings) - Method in interface org.agorava.api.oauth.application.OAuthAppSettingsBuilder

Set builder params from an existing OAuthAppSettings

readFromSettings(OAuthAppSettings) - Method in class org.agorava.api.oauth.application.SimpleOAuthAppSettingsBuilder

REDIRECT_URI - Static variable in interface org.agorava.AgoravaConstants

Redirect uri field name in OAuth request

remove(String) - Method in interface org.agorava.api.storage.Repository

Remove the element with the given id

remove(T) - Method in interface org.agorava.api.storage.Repository

Remove the given element

removeCurrent() - Method in interface org.agorava.api.storage.Repository

Remove the current Element

repo(UserSessionRepository) - Method in class org.agorava.api.oauth.OAuthSession.Builder

Set the User Repository which contains the session to build

REPOID_PARAM - Static variable in interface org.agorava.AgoravaConstants

parameter name used to propagate Identifiable.getId() in url

Repository<T extends Identifiable> - Interface in org.agorava.api.storage

A repository containing a collection of element that can be iterated

Request - Interface in org.agorava.api.rest

A REST request

requestFactory(Verb, String) - Method in interface org.agorava.api.oauth.OAuthService

Creates an OAuthRequest with the given Rest Verb and uri

requestToken(Token) - Method in class org.agorava.api.oauth.OAuthSession.Builder

Set the OAuth Request Token for the session

RequestTuner - Interface in org.agorava.api.rest

A Request Tuner to alter Rest request behaviour

resolve(String) - Method in class org.agorava.api.atinject.BeanResolver

Resolve a bean by its name

resolve(Class<T>) - Method in class org.agorava.api.atinject.BeanResolver

Resolve a bean by its class

resolve(String, boolean) - Method in class org.agorava.api.atinject.BeanResolver

Resolve bean by its class.

resolve(Class<T>, boolean) - Method in class org.agorava.api.atinject.BeanResolver

RESOLVER_COOKIE_LIFE_PARAM - Static variable in interface org.agorava.AgoravaConstants

parameter name in config containing the the lifetime of cookies

RESOLVER_REPO_COOKIE_NAME - Static variable in interface org.agorava.AgoravaConstants

cookie name used to store Identifiable.getId() on the browser

resolveSessionForQualifier(Annotation) - Method in interface org.agorava.api.service.OAuthLifeCycleService

Resolve session for the given qualifier.

Response - Interface in org.agorava.api.rest

ResponseException - Exception in org.agorava.api.exception

Exception thrown when a problem occurred in high level Rest exchanges.

ResponseException(Response) - Constructor for exception org.agorava.api.exception.ResponseException

Default constructor

RestService - Interface in org.agorava.api.rest

Manage basic REST actions

S

SCOPE - Static variable in interface org.agorava.AgoravaConstants

Scope field name in OAuth request

SCOPE - Static variable in interface org.agorava.api.oauth.application.OAuthAppSettingsBuilder

key label for the scope of the OAuth application

scope(String) - Method in interface org.agorava.api.oauth.application.OAuthAppSettingsBuilder

Set the OAuth 2.0 scope for the application

scope(String) - Method in class org.agorava.api.oauth.application.SimpleOAuthAppSettingsBuilder

send(RequestTuner) - Method in interface org.agorava.api.rest.Request

Execute the request and return a Response

send() - Method in interface org.agorava.api.rest.Request

Execute the request and return a Response

sendSignedRequest(Verb, String) - Method in interface org.agorava.api.oauth.OAuthService

Send an OAuth request signed without any parameter

sendSignedRequest(Verb, String, Map<String, ?>) - Method in interface org.agorava.api.oauth.OAuthService

Send an OAuth request signed with a list a parameter

sendSignedRequest(Verb, String, String, Object) - Method in interface org.agorava.api.oauth.OAuthService

Send an OAuth request signed with a single parameter

sendSignedRequest(OAuthRequest) - Method in interface org.agorava.api.oauth.OAuthService

Signs and sends a simple request

sendSignedXmlRequest(Verb, String, String) - Method in interface org.agorava.api.oauth.OAuthService

Send an OAuth request signed with an XML Payload as content

SessionResolver - Interface in org.agorava.spi

setAccessToken(Token) - Method in interface org.agorava.api.oauth.OAuthService

Set the Access Token with for an OAuth access

setAccessToken(String, String) - Method in interface org.agorava.api.oauth.OAuthService

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

setAccessToken(Token) - Method in class org.agorava.api.oauth.OAuthSession

setCharset(String) - Method in interface org.agorava.api.rest.Request

Set the charset of the body of the request

setConnectionKeepAlive(boolean) - Method in interface org.agorava.api.rest.Request

Sets whether the underlying Http Connection is persistent or not.

setConnectTimeout(int, TimeUnit) - Method in interface org.agorava.api.rest.Request

Sets the connect timeout for the underlying HttpURLConnection

setCurrent(T) - Method in interface org.agorava.api.storage.Repository

Set the current element

setCurrent(String) - Method in interface org.agorava.api.storage.Repository

Look for element with the given id, set it as current and return it

setCurrentSession(OAuthSession) - Method in interface org.agorava.api.service.OAuthLifeCycleService

Makes the given OAuth session the current session

setReadTimeout(int, TimeUnit) - Method in interface org.agorava.api.rest.Request

Sets the read timeout for the underlying HttpURLConnection

setRepo(UserSessionRepository) - Method in class org.agorava.api.oauth.OAuthSession

Attach this Session the given Repository

setRequestToken(Token) - Method in class org.agorava.api.oauth.OAuthSession

setUserProfile(UserProfile) - Method in class org.agorava.api.oauth.OAuthSession

setVerifier(String) - Method in interface org.agorava.api.oauth.OAuthService

Used to initialize verifier code returned by OAuth service

setVerifier(String) - Method in class org.agorava.api.oauth.OAuthSession

SIGN_METHOD - Static variable in interface org.agorava.AgoravaConstants

Signature method field name in OAuth request

SIGNATURE - Static variable in interface org.agorava.AgoravaConstants

Signature field name in OAuth request

SignatureService - Interface in org.agorava.api.service

Signs a base string, returning the OAuth signature

SignatureType - Annotation Type in org.agorava.api.service

Qualifier to distinguish different SignatureService implementations

SignatureType.Type - Enum in org.agorava.api.service

signRequest(Token, OAuthRequest) - Method in interface org.agorava.api.oauth.OAuthService

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

SimpleOAuthAppSettingsBuilder - Class in org.agorava.api.oauth.application

SimpleOAuthAppSettingsBuilder() - Constructor for class org.agorava.api.oauth.application.SimpleOAuthAppSettingsBuilder

size() - Method in interface org.agorava.api.rest.HttpParameters

SocialEvent<T> - Class in org.agorava.api.event

Generic event for all Agorava Event.

SocialEvent(SocialEvent.Status, String, T) - Constructor for class org.agorava.api.event.SocialEvent

SocialEvent.Status - Enum in org.agorava.api.event

Status of the Event

startDanceFor(String) - Method in interface org.agorava.api.service.OAuthLifeCycleService

OAuth Dance entry point.

startDanceFor(String, String) - Method in interface org.agorava.api.service.OAuthLifeCycleService

OAuth Dance entry point.

startDanceFor(Annotation) - Method in interface org.agorava.api.service.OAuthLifeCycleService

OAuth dance entry point.

StatusUpdated - Class in org.agorava.api.event

Event sent after a status update

StatusUpdated(SocialEvent.Status, String, Object) - Constructor for class org.agorava.api.event.StatusUpdated

StringExtractor - Interface in org.agorava.api.extractor

Extracts an OAuth 1.0a url-encoded base string from the OAuthRequest.

StringUtils - Class in org.agorava.api.service

T

TIMESTAMP - Static variable in interface org.agorava.AgoravaConstants

Time stamp field name in OAuth request

TimestampService - Interface in org.agorava.api.service

Unix epoch timestamp generator.

TOKEN - Static variable in interface org.agorava.AgoravaConstants

Token field name in OAuth request

Token - Class in org.agorava.api.oauth

Represents an OAuth token (either request or access token) and its secret

Token(String, String) - Constructor for class org.agorava.api.oauth.Token

Default constructor

TOKEN_SECRET - Static variable in interface org.agorava.AgoravaConstants

Secret token field name in OAuth request

TokenExtractor - Interface in org.agorava.api.extractor

Simple command object that extracts a Token from a String

toString() - Method in class org.agorava.api.oauth.application.OAuthAppSettings

toString() - Method in class org.agorava.api.oauth.OAuthSession

toString() - Method in class org.agorava.api.oauth.Token

tune(Request) - Method in interface org.agorava.api.rest.RequestTuner

the tuning command

tune(OAuthAppSettings) - Method in interface org.agorava.spi.AppSettingsTuner

The tuning method

U

userProfile(UserProfile) - Method in class org.agorava.api.oauth.OAuthSession.Builder

Set the user profile link to the session to build.

UserProfile - Class in org.agorava.spi

Generic abstract class to define a basic user information

UserProfile(String) - Constructor for class org.agorava.spi.UserProfile

Default constructor

UserProfileService - Interface in org.agorava.spi

Implementation will provide generic service around UserProfile for a given Provider

UserSessionRepository - Interface in org.agorava.api.storage

Allows to manage multiple OAuth Session.

UserSessionRepositoryResolver - Interface in org.agorava.spi

Implementation should provide a way to retrieve the current (active) UserSessionRepository

V

valueOf(String) - Static method in enum org.agorava.api.event.SocialEvent.Status

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.agorava.api.extractor.ExtractorType.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.agorava.api.oauth.OAuth.OAuthVersion

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.agorava.api.rest.Verb

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.agorava.api.service.SignatureType.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.agorava.spi.ProviderConfigOauth.SignaturePlace

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.agorava.api.event.SocialEvent.Status

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.agorava.api.extractor.ExtractorType.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.agorava.api.oauth.OAuth.OAuthVersion

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.agorava.api.rest.Verb

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.agorava.api.service.SignatureType.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.agorava.spi.ProviderConfigOauth.SignaturePlace

Returns an array containing the constants of this enum type, in the order they are declared.

Verb - Enum in org.agorava.api.rest

An enumeration containing HTTP Verbs.

VERIFIER - Static variable in interface org.agorava.AgoravaConstants

Returned Verifier field name in OAuth request

verifier(String) - Method in class org.agorava.api.oauth.OAuthSession.Builder

Set the OAuth Verifier (OAuth 1.0a) or Code (OAuth 2.0a) returned by the provider in the callback

Verifier - Class in org.agorava.api.oauth

Represents an OAuth verifier code.

Verifier(String) - Constructor for class org.agorava.api.oauth.Verifier

Default constructor.

VERSION - Static variable in interface org.agorava.AgoravaConstants

OAuth Version field name in OAuth request

W

webAbsolutePath - Static variable in class org.agorava.AgoravaContext

The complete Web Context path (protocol, server, application context) of this Agorava Instance

A B C D E G H I J K M N O P Q R S T U V W