org.agorava.api.oauth.application

Class PropertyOAuthAppSettingsBuilder

java.lang.Object

org.agorava.api.oauth.application.SimpleOAuthAppSettingsBuilder

org.agorava.api.oauth.application.PropertyOAuthAppSettingsBuilder

All Implemented Interfaces:

OAuthAppSettingsBuilder

public class PropertyOAuthAppSettingsBuilder
extends SimpleOAuthAppSettingsBuilder

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 prefix(String). By default the prefix is empty

Author:

Antoine Sabot-Durand

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUNDLE_NAME Global constant to give type safe name for the bundleName property when used in .application.OAuthApplication
static String	PREFIX Global constant to give type safe name for the prefix property when used in .application.OAuthApplication

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

API_KEY, API_SECRET, CALLBACK, NAME, SCOPE

Constructor Summary

Constructors

Constructor and Description
PropertyOAuthAppSettingsBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
OAuthAppSettings	build() Builds the OAuthAppSettings
PropertyOAuthAppSettingsBuilder	bundleName(String bundleName) Set the bundle name to read settings from.
PropertyOAuthAppSettingsBuilder	prefix(String prefix) Set the prefix for the keys in the bundle If it's not used, default prefix will be empty

Methods inherited from class org.agorava.api.oauth.application.SimpleOAuthAppSettingsBuilder

apiKey, apiSecret, callback, name, params, qualifier, readFromSettings, scope

Methods inherited from class java.lang.Object

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

Field Detail

BUNDLE_NAME

public static final String BUNDLE_NAME

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

See Also:

Constant Field Values

PREFIX

public static final String PREFIX

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

See Also:

Constant Field Values

Constructor Detail

PropertyOAuthAppSettingsBuilder

public PropertyOAuthAppSettingsBuilder()

Method Detail

bundleName

public PropertyOAuthAppSettingsBuilder bundleName(String bundleName)

Set the bundle name to read settings from. If it's not used, default bundle name will be 'agorava'

Parameters:

bundleName - name of the bundle

Returns:

this builder

prefix

public PropertyOAuthAppSettingsBuilder prefix(String prefix)

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

Parameters:

prefix - to add to keys

Returns:

this builder

build

public OAuthAppSettings build()

Builds the OAuthAppSettings

This implementation will build the OAuthAppSettings from a ResourceBundle

It'll first try to load all binding (mandatory) fields from the bundle by looking for the key prefix.fieldName (or fieldName if prefix is empty)

In a second time it'll check if optional fields are present in the bundle (with the same key construction) and load them if they are. If they are not present it'll try to load them without prefix

Specified by:

build in interface OAuthAppSettingsBuilder

Overrides:

build in class SimpleOAuthAppSettingsBuilder

Returns:

the built OAuthAppSettings

Throws:

MissingResourceException - if the bundle can't be open

AgoravaException - if a binding field is missing in the bundle