org.agorava.api.oauth.application

Interface OAuthAppSettingsBuilder

All Known Implementing Classes:

PropertyOAuthAppSettingsBuilder, SimpleOAuthAppSettingsBuilder

public interface OAuthAppSettingsBuilder

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

For this last purpose, the interface OAuthAppSettingsBuilder contains constants for fields name should the configuration being read from a text file.

Author:

Antoine Sabot-Durand

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_KEY key label for the consumer key of the OAuth application
static String	API_SECRET key label for the consumer secret of the OAuth application
static String	CALLBACK key label for the call back url to send to of the tier service
static String	NAME key label for the name of the OAuth service
static String	PREFIX key prefix label
static String	SCOPE key label for the scope of the OAuth application

Method Summary

Methods

Modifier and Type	Method and Description
OAuthAppSettingsBuilder	apiKey(String apiKey) Set the Social Media application consumer key
OAuthAppSettingsBuilder	apiSecret(String apiSecret) Set the Social Media application secret key
OAuthAppSettings	build() Builds the OAuthAppSettings
OAuthAppSettingsBuilder	callback(String callback) Set the Callback for the application
OAuthAppSettingsBuilder	name(String name) Set the name of the Social Media for which the settings are intended
OAuthAppSettingsBuilder	params(Param[] params) Load builder params with an array of Param.
OAuthAppSettingsBuilder	qualifier(Annotation qualifier) Set the qualifier of the Social Media for which the settings are intended.
OAuthAppSettingsBuilder	readFromSettings(OAuthAppSettings settings) Set builder params from an existing OAuthAppSettings
OAuthAppSettingsBuilder	scope(String scope) Set the OAuth 2.0 scope for the application

Field Detail

NAME

static final String NAME

key label for the name of the OAuth service

See Also:

Constant Field Values

API_KEY

static final String API_KEY

key label for the consumer key of the OAuth application

See Also:

Constant Field Values

API_SECRET

static final String API_SECRET

key label for the consumer secret of the OAuth application

See Also:

Constant Field Values

CALLBACK

static final String CALLBACK

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

See Also:

Constant Field Values

SCOPE

static final String SCOPE

key label for the scope of the OAuth application

See Also:

Constant Field Values

PREFIX

static final String PREFIX

key prefix label

See Also:

Constant Field Values

Method Detail

qualifier

OAuthAppSettingsBuilder qualifier(Annotation qualifier)

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

Parameters:

qualifier - the name of the related Social Media

Returns:

the current OAuthAppSettingsBuilder

name

OAuthAppSettingsBuilder name(String name)

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

Parameters:

name - the name of the related Social Media

Returns:

the current OAuthAppSettingsBuilder

apiKey

OAuthAppSettingsBuilder apiKey(String apiKey)

Set the Social Media application consumer key

Parameters:

apiKey - the consumer (public) OAuth key

Returns:

the current OAuthAppSettingsBuilder

apiSecret

OAuthAppSettingsBuilder apiSecret(String apiSecret)

Set the Social Media application secret key

Parameters:

apiSecret - the secret (private) OAuth key

Returns:

the current OAuthAppSettingsBuilder

callback

OAuthAppSettingsBuilder callback(String callback)

Set the Callback for the application

Parameters:

callback - a callback url or 'oob' if the application is not on the web

Returns:

the current OAuthAppSettingsBuilder

scope

OAuthAppSettingsBuilder scope(String scope)

Set the OAuth 2.0 scope for the application

Parameters:

scope - list (string separated by commas) of authorized action defined by Social Media for the application

Returns:

the current OAuthAppSettingsBuilder

params

OAuthAppSettingsBuilder params(Param[] params)

Load builder params with an array of Param. This method can be used when params for OAuthAppSettings are defined through an annotation.

Parameters:

params - parameters collection to configure the builder

Returns:

the current OAuthAppSettingsBuilder

build

OAuthAppSettings build()

Builds the OAuthAppSettings

Returns:

the application settings

readFromSettings

OAuthAppSettingsBuilder readFromSettings(OAuthAppSettings settings)

Set builder params from an existing OAuthAppSettings

Parameters:

settings - settings to read from

Returns:

the current OAuthAppSettingsBuilder