org.agorava.api.oauth.application

Class SimpleOAuthAppSettingsBuilder

java.lang.Object

org.agorava.api.oauth.application.SimpleOAuthAppSettingsBuilder

All Implemented Interfaces:

OAuthAppSettingsBuilder

Direct Known Subclasses:

PropertyOAuthAppSettingsBuilder

public class SimpleOAuthAppSettingsBuilder
extends Object
implements OAuthAppSettingsBuilder

Author:

Antoine Sabot-Durand

Field Summary

Fields inherited from interface org.agorava.api.oauth.application.OAuthAppSettingsBuilder

API_KEY, API_SECRET, CALLBACK, NAME, PREFIX, SCOPE

Constructor Summary

Constructors

Constructor and Description
SimpleOAuthAppSettingsBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
SimpleOAuthAppSettingsBuilder	apiKey(String apiKey) Set the Social Media application consumer key
SimpleOAuthAppSettingsBuilder	apiSecret(String apiSecret) Set the Social Media application secret key
OAuthAppSettings	build() Builds the OAuthAppSettings
SimpleOAuthAppSettingsBuilder	callback(String callback) Set the Callback for the application
SimpleOAuthAppSettingsBuilder	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
SimpleOAuthAppSettingsBuilder	scope(String scope) Set the OAuth 2.0 scope for the application

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleOAuthAppSettingsBuilder

public SimpleOAuthAppSettingsBuilder()

Method Detail

params

public OAuthAppSettingsBuilder params(Param[] params)

Description copied from interface: OAuthAppSettingsBuilder

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

Specified by:

params in interface OAuthAppSettingsBuilder

Parameters:

params - parameters collection to configure the builder

Returns:

the current OAuthAppSettingsBuilder

qualifier

public OAuthAppSettingsBuilder qualifier(Annotation qualifier)

Description copied from interface: OAuthAppSettingsBuilder

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

Specified by:

qualifier in interface OAuthAppSettingsBuilder

Parameters:

qualifier - the name of the related Social Media

Returns:

the current OAuthAppSettingsBuilder

name

public SimpleOAuthAppSettingsBuilder name(String name)

Description copied from interface: OAuthAppSettingsBuilder

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

Specified by:

name in interface OAuthAppSettingsBuilder

Parameters:

name - the name of the related Social Media

Returns:

the current OAuthAppSettingsBuilder

apiKey

public SimpleOAuthAppSettingsBuilder apiKey(String apiKey)

Description copied from interface: OAuthAppSettingsBuilder

Set the Social Media application consumer key

Specified by:

apiKey in interface OAuthAppSettingsBuilder

Parameters:

apiKey - the consumer (public) OAuth key

Returns:

the current OAuthAppSettingsBuilder

apiSecret

public SimpleOAuthAppSettingsBuilder apiSecret(String apiSecret)

Description copied from interface: OAuthAppSettingsBuilder

Set the Social Media application secret key

Specified by:

apiSecret in interface OAuthAppSettingsBuilder

Parameters:

apiSecret - the secret (private) OAuth key

Returns:

the current OAuthAppSettingsBuilder

callback

public SimpleOAuthAppSettingsBuilder callback(String callback)

Set the Callback for the application This implementation add a check to callback. If it's not 'oob' and doesn't start with 'http://' it'll try to get the path of the current application to dynamically create a return URL when connection on Oauth service is over. As some service build the Callback URL from domain name configured when the OAuth application is created (for security reasons), whe should make the distinction between relative URL that should be prefixed here (without a beginning "/") and relative url that will prefixed by remote service (with a beginning "/")

Specified by:

callback in interface OAuthAppSettingsBuilder

Parameters:

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

Returns:

this builder

scope

public SimpleOAuthAppSettingsBuilder scope(String scope)

Description copied from interface: OAuthAppSettingsBuilder

Set the OAuth 2.0 scope for the application

Specified by:

scope in interface OAuthAppSettingsBuilder

Parameters:

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

Returns:

the current OAuthAppSettingsBuilder

build

public OAuthAppSettings build()

Description copied from interface: OAuthAppSettingsBuilder

Builds the OAuthAppSettings

Specified by:

build in interface OAuthAppSettingsBuilder

Returns:

the application settings

readFromSettings

public OAuthAppSettingsBuilder readFromSettings(OAuthAppSettings settings)

Description copied from interface: OAuthAppSettingsBuilder

Set builder params from an existing OAuthAppSettings

Specified by:

readFromSettings in interface OAuthAppSettingsBuilder

Parameters:

settings - settings to read from

Returns:

the current OAuthAppSettingsBuilder