org.jboss.aerogear.android.authorization.oauth2

Class OAuth2AuthorizationConfiguration

java.lang.Object

org.jboss.aerogear.android.authorization.AuthorizationConfiguration<OAuth2AuthorizationConfiguration>

org.jboss.aerogear.android.authorization.oauth2.OAuth2AuthorizationConfiguration

All Implemented Interfaces:

org.jboss.aerogear.android.core.Config<OAuth2AuthorizationConfiguration>

public class OAuth2AuthorizationConfiguration
extends AuthorizationConfiguration<OAuth2AuthorizationConfiguration>
implements org.jboss.aerogear.android.core.Config<OAuth2AuthorizationConfiguration>

Constructor Summary

Constructors

Constructor and Description
OAuth2AuthorizationConfiguration()

Method Summary

Modifier and Type	Method and Description
OAuth2AuthorizationConfiguration	addAdditionalAccessParam(android.util.Pair<String,String> additionalAccessParam) Sometimes a implementation will need additional parameters when access is performed.
OAuth2AuthorizationConfiguration	addAdditionalAuthorizationParam(android.util.Pair<String,String> additionalAuthorizationParam) Sometimes a implementation will need additional parameters when authorization is performed.
protected AuthzModule	buildModule() Validates configuration parameters and returns a AuthenticationModule instance.
String	getAccessTokenEndpoint() The accessTokenEndpoint is responsible for generating an accesstoken for an authorized user.
String	getAccountId() The account ID parameter is to identify it ID of the OAuth2AuthzSession which will be used to store the information.
Set<android.util.Pair<String,String>>	getAdditionalAccessParams() Sometimes a implementation will need additional parameters when access is performed.
Set<android.util.Pair<String,String>>	getAdditionalAuthorizationParams() Sometimes a implementation will need additional parameters when authorization is performed.
String	getAuthzEndpoint() The authzEnpoint defines the endpoint which the Authorization module will use to obtain an authorization token.
URL	getBaseURL() The baseURL is the url which endpoints will be appended to.
String	getClientId() The client ID is the ID assigned to the application by the service provider.
String	getClientSecret() The client secret is assigned to the application by the service provider.
String	getRedirectURL() The redirect URL is the url which handles consuming a response from the authorization server.
String	getRefreshEndpoint() The refresh endpoint is the path to the location of the refresh token.
List<String>	getScopes() Scopes are a list of permissions the application will request at Authorization.
OAuth2AuthorizationConfiguration	removeAdditionalAccessParam(android.util.Pair<String,String> additionalAccessParam) Remove an additional access param
OAuth2AuthorizationConfiguration	removeAdditionalAuthorizationParam(android.util.Pair<String,String> additionalAuthorizationParam) Remove an additional authorization param
OAuth2AuthorizationConfiguration	setAccessTokenEndpoint(String accessTokenEndpoint) The accessTokenEndpoint is responsible for generating an accesstoken for an authorized user.
OAuth2AuthorizationConfiguration	setAccountId(String accountId) The account ID parameter is to identify it ID of the OAuth2AuthzSession which will be used to store the information.
OAuth2AuthorizationConfiguration	setAuthzEndpoint(String authzEndpoint) The authzEnpoint defines the endpoint which the Authorization module will use to obtain an authorization token.
OAuth2AuthorizationConfiguration	setBaseURL(URL baseURL) The baseURL is the url which endpoints will be appended to.
OAuth2AuthorizationConfiguration	setClientId(String clientId) The client ID is the ID assigned to the application by the service provider.
OAuth2AuthorizationConfiguration	setClientSecret(String clientSecret) The client secret is assigned to the application by the service provider.
OAuth2AuthorizationConfiguration	setRedirectURL(String redirectURL) The redirect URL is the url which handles consuming a response from the authorization server.
OAuth2AuthorizationConfiguration	setRefreshEndpoint(String refreshEndpoint) The refresh endpoint is the path to the location of the refresh token.
OAuth2AuthorizationConfiguration	setScopes(List<String> scopes) Scopes are a list of permissions the application will request at Authorization.

Methods inherited from class org.jboss.aerogear.android.authorization.AuthorizationConfiguration

addOnAuthorizationCreatedListener, asModule, getName, getOnAuthorizationCreatedListeners, setName, setOnAuthorizationCreatedListeners

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.aerogear.android.core.Config

getName, setName

Constructor Detail

OAuth2AuthorizationConfiguration

public OAuth2AuthorizationConfiguration()

Method Detail

getAuthzEndpoint

public String getAuthzEndpoint()

The authzEnpoint defines the endpoint which the Authorization module will use to obtain an authorization token.

Returns:

the current authzEndpoint

setAuthzEndpoint

public OAuth2AuthorizationConfiguration setAuthzEndpoint(String authzEndpoint)

The authzEnpoint defines the endpoint which the Authorization module will use to obtain an authorization token.

Parameters:

authzEndpoint - new authzEndpoint

Returns:

the current configuration

getRedirectURL

public String getRedirectURL()

The redirect URL is the url which handles consuming a response from the authorization server.

Returns:

the current redirectURL.

setRedirectURL

public OAuth2AuthorizationConfiguration setRedirectURL(String redirectURL)

The redirect URL is the url which handles consuming a response from the authorization server.

Parameters:

redirectURL - a new redirectURL

Returns:

the current configuration.

getAccessTokenEndpoint

public String getAccessTokenEndpoint()

The accessTokenEndpoint is responsible for generating an accesstoken for an authorized user.

Returns:

the current accessTokenEndpoint

setAccessTokenEndpoint

public OAuth2AuthorizationConfiguration setAccessTokenEndpoint(String accessTokenEndpoint)

The accessTokenEndpoint is responsible for generating an accesstoken for an authorized user.

Parameters:

accessTokenEndpoint - a new accessTokenEndpoint

Returns:

the current configuration

getScopes

public List<String> getScopes()

Scopes are a list of permissions the application will request at Authorization.

Returns:

a copy of the current list of scopes

setScopes

public OAuth2AuthorizationConfiguration setScopes(List<String> scopes)

Scopes are a list of permissions the application will request at Authorization.

Parameters:

scopes - a new List of scopes

Returns:

the current configuration

getClientId

public String getClientId()

The client ID is the ID assigned to the application by the service provider.

Returns:

the current clientID

setClientId

public OAuth2AuthorizationConfiguration setClientId(String clientId)

The client ID is the ID assigned to the application by the service provider.

Parameters:

clientId - a new clientId

Returns:

the current configuration

getClientSecret

public String getClientSecret()

The client secret is assigned to the application by the service provider.

Returns:

the current clientSecret

setClientSecret

public OAuth2AuthorizationConfiguration setClientSecret(String clientSecret)

The client secret is assigned to the application by the service provider.

Parameters:

clientSecret - a new clientSecret

Returns:

the current configuration

getAccountId

public String getAccountId()

The account ID parameter is to identify it ID of the OAuth2AuthzSession which will be used to store the information. It is unique per app and generated by you, the developer.

Returns:

the current account

setAccountId

public OAuth2AuthorizationConfiguration setAccountId(String accountId)

The account ID parameter is to identify it ID of the OAuth2AuthzSession which will be used to store the information. It is unique per app and generated by you, the developer.

Parameters:

accountId - the new account ID

Returns:

the current configuration

getAdditionalAuthorizationParams

public Set<android.util.Pair<String,String>> getAdditionalAuthorizationParams()

Sometimes a implementation will need additional parameters when authorization is performed.

Returns:

the current set of authorization parameters.

addAdditionalAuthorizationParam

public OAuth2AuthorizationConfiguration addAdditionalAuthorizationParam(android.util.Pair<String,String> additionalAuthorizationParam)

Sometimes a implementation will need additional parameters when authorization is performed.

Parameters:

additionalAuthorizationParam - add a new Pair of AuthorizationParams

Returns:

the current configuration

removeAdditionalAuthorizationParam

public OAuth2AuthorizationConfiguration removeAdditionalAuthorizationParam(android.util.Pair<String,String> additionalAuthorizationParam)

Remove an additional authorization param

Parameters:

additionalAuthorizationParam - Authorization param to be removed

Returns:

the current configuration

getAdditionalAccessParams

public Set<android.util.Pair<String,String>> getAdditionalAccessParams()

Sometimes a implementation will need additional parameters when access is performed.

Returns:

the current set of authorization parameters.

addAdditionalAccessParam

public OAuth2AuthorizationConfiguration addAdditionalAccessParam(android.util.Pair<String,String> additionalAccessParam)

Sometimes a implementation will need additional parameters when access is performed.

Parameters:

additionalAccessParam - add a new Pair of AccessParams

Returns:

the current configuration

removeAdditionalAccessParam

public OAuth2AuthorizationConfiguration removeAdditionalAccessParam(android.util.Pair<String,String> additionalAccessParam)

Remove an additional access param

Parameters:

additionalAccessParam - Access param to be removed

Returns:

the current configuration

buildModule

protected AuthzModule buildModule()

Description copied from class: AuthorizationConfiguration

Validates configuration parameters and returns a AuthenticationModule instance.

Specified by:

buildModule in class AuthorizationConfiguration<OAuth2AuthorizationConfiguration>

Returns:

An AuthenticationModule based on this configuration

getBaseURL

public URL getBaseURL()

The baseURL is the url which endpoints will be appended to.

Returns:

the current baseURL

setBaseURL

public OAuth2AuthorizationConfiguration setBaseURL(URL baseURL)

The baseURL is the url which endpoints will be appended to.

Parameters:

baseURL - new baseURL

Returns:

the current configuration.

getRefreshEndpoint

public String getRefreshEndpoint()

The refresh endpoint is the path to the location of the refresh token. Defaults to an empty String.

Returns:

the current baseURL

setRefreshEndpoint

public OAuth2AuthorizationConfiguration setRefreshEndpoint(String refreshEndpoint)

The refresh endpoint is the path to the location of the refresh token. Defaults to an empty String.

Parameters:

refreshEndpoint - a new endpoint.

Returns:

the current configuration.