public class OAuth2AuthorizationConfiguration extends AuthorizationConfiguration<OAuth2AuthorizationConfiguration> implements org.jboss.aerogear.android.core.Config<OAuth2AuthorizationConfiguration>
| Constructor and Description |
|---|
OAuth2AuthorizationConfiguration() |
| 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.
|
addOnAuthorizationCreatedListener, asModule, getName, getOnAuthorizationCreatedListeners, setName, setOnAuthorizationCreatedListenerspublic String getAuthzEndpoint()
public OAuth2AuthorizationConfiguration setAuthzEndpoint(String authzEndpoint)
authzEndpoint - new authzEndpointpublic String getRedirectURL()
public OAuth2AuthorizationConfiguration setRedirectURL(String redirectURL)
redirectURL - a new redirectURLpublic String getAccessTokenEndpoint()
public OAuth2AuthorizationConfiguration setAccessTokenEndpoint(String accessTokenEndpoint)
accessTokenEndpoint - a new accessTokenEndpointpublic List<String> getScopes()
public OAuth2AuthorizationConfiguration setScopes(List<String> scopes)
scopes - a new List of scopespublic String getClientId()
public OAuth2AuthorizationConfiguration setClientId(String clientId)
clientId - a new clientIdpublic String getClientSecret()
public OAuth2AuthorizationConfiguration setClientSecret(String clientSecret)
clientSecret - a new clientSecretpublic String getAccountId()
OAuth2AuthzSession which will be used to store the information.
It is unique per app and generated by you, the developer.public OAuth2AuthorizationConfiguration setAccountId(String accountId)
OAuth2AuthzSession which will be used to store the information.
It is unique per app and generated by you, the developer.accountId - the new account IDpublic Set<android.util.Pair<String,String>> getAdditionalAuthorizationParams()
public OAuth2AuthorizationConfiguration addAdditionalAuthorizationParam(android.util.Pair<String,String> additionalAuthorizationParam)
additionalAuthorizationParam - add a new Pair of AuthorizationParamspublic OAuth2AuthorizationConfiguration removeAdditionalAuthorizationParam(android.util.Pair<String,String> additionalAuthorizationParam)
additionalAuthorizationParam - Authorization param to be removedpublic Set<android.util.Pair<String,String>> getAdditionalAccessParams()
public OAuth2AuthorizationConfiguration addAdditionalAccessParam(android.util.Pair<String,String> additionalAccessParam)
additionalAccessParam - add a new Pair of AccessParamspublic OAuth2AuthorizationConfiguration removeAdditionalAccessParam(android.util.Pair<String,String> additionalAccessParam)
additionalAccessParam - Access param to be removedprotected AuthzModule buildModule()
AuthorizationConfigurationbuildModule in class AuthorizationConfiguration<OAuth2AuthorizationConfiguration>public URL getBaseURL()
public OAuth2AuthorizationConfiguration setBaseURL(URL baseURL)
baseURL - new baseURLpublic String getRefreshEndpoint()
public OAuth2AuthorizationConfiguration setRefreshEndpoint(String refreshEndpoint)
refreshEndpoint - a new endpoint.Copyright © 2015 JBoss by Red Hat. All rights reserved.