org.jboss.aerogear.android.authorization.oauth2

Class OAuth2Properties

java.lang.Object

org.jboss.aerogear.android.authorization.oauth2.OAuth2Properties

public final class OAuth2Properties
extends Object

Authorization configuration class.

Constructor Summary

Constructors

Constructor and Description
OAuth2Properties(URL baseURL, String name)

Method Summary

Modifier and Type	Method and Description
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	getName() Name refers to the name of the module this config will become
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.
void	setAccessTokenEndpoint(String accessTokenEndpoint) The accessTokenEndpoint is responsible for generating an accesstoken for an authorized user.
void	setAccountId(String accountId) The account ID parameter is to identify it ID of the OAuth2AuthzSession which will be used to store the information.
void	setAuthzEndpoint(String authzEndpoint) The authzEnpoint defines the endpoint which the Authorization module will use to obtain an authorization token.
void	setClientId(String clientId) The client ID is the ID assigned to the application by the service provider.
void	setClientSecret(String clientSecret) The client secret is assigned to the application by the service provider.
void	setRedirectURL(String redirectURL) The redirect URL is the url which handles consuming a response from the authorization server.
void	setRefreshEndpoint(String refreshEndpoint) The refresh endpoint is the path to the location of the refresh token.
void	setScopes(List<String> scopes) Scopes are a list of permissions the application will request at Authorization.

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth2Properties

public OAuth2Properties(URL baseURL,
                        String name)

Parameters:

baseURL - This is the url which endpoints will be appended to.

name - A name to reference the AuthorizationModule which this config will create.

Method Detail

getBaseURL

public URL getBaseURL()

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

Returns:

the current baseURL

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 void setAuthzEndpoint(String authzEndpoint)

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

Parameters:

authzEndpoint - a new authzEndpoint

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 void setRedirectURL(String redirectURL)

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

Parameters:

redirectURL - a new redirectURL

getAccessTokenEndpoint

public String getAccessTokenEndpoint()

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

Returns:

the current accessTokenEndpoint

setAccessTokenEndpoint

public void setAccessTokenEndpoint(String accessTokenEndpoint)

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

Parameters:

accessTokenEndpoint - a new accessTokenEndpoint

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 void setScopes(List<String> scopes)

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

Parameters:

scopes - a new list of scopes to replace the current one

getClientId

public String getClientId()

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

Returns:

the current clientID

setClientId

public void setClientId(String clientId)

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

Parameters:

clientId - a new client ID

getClientSecret

public String getClientSecret()

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

Returns:

the current clientSecret

setClientSecret

public void setClientSecret(String clientSecret)

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

Parameters:

clientSecret - a new client secret

getName

public String getName()

Name refers to the name of the module this config will become

Returns:

the current name

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 void 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 - a new accountId

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.

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.

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 refreshEndpoint

setRefreshEndpoint

public void 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.