com.adobe.granite.auth.oauth

Interface Provider

@ConsumerType
public interface Provider

Interface for OAuth providers.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAccessTokenPropertyPath(java.lang.String clientId) Return the property path where the access token will be stored (if ProviderConfig is has access token storage enabled)
org.scribe.builder.api.Api	getApi() Specifies an instance of scribe Api to use for this provider.
User	getCurrentUser(SlingHttpServletRequest request) Use the request to get the User who has (or will have) oauth profile data attached
java.lang.String	getDetailsURL() OAuth provider's user details URL
java.lang.String	getErrorDescriptionFromValidateTokenResponseBody(java.lang.String responseBody) Parse the response body and return the error description contained in the response
java.lang.String[]	getExtendedDetailsURLs(java.lang.String scope) OAuth provider's user extended details URLs, depending on the specific scope
java.lang.String[]	getExtendedDetailsURLs(java.lang.String scope, java.lang.String userId, java.util.Map<java.lang.String,java.lang.Object> props) OAuth provider's user extended details URLs, depending on the specific scope and previously fetched data (e.g.
java.lang.String	getId() Unique ID for this provider, used to match a ProviderConfig with this Provider
java.lang.String	getName() Readable name for this Provider
java.lang.String	getOAuthIdPropertyPath(java.lang.String clientId) Return the property path where the oauth user id will be stored
org.scribe.model.OAuthRequest	getProtectedDataRequest(java.lang.String url) Create an OAuthRequest to request protected data from the OAuth provider system.
ProviderType	getType() Currently only oauth 1a and oauth 2 are supported.
java.lang.String	getUserFolderPath(java.lang.String userId, java.lang.String clientId, java.util.Map<java.lang.String,java.lang.Object> props) Return the node path where the user should be created
java.lang.String	getUserIdFromValidateTokenResponseBody(java.lang.String responseBody) Parse the response body and return the userId contained in the response
java.lang.String	getUserIdProperty() What is the user data property that contains this OAuth provider's user id? (e.g.
java.lang.String	getValidateTokenUrl(java.lang.String clientId, java.lang.String token) OAuth provider validate token URL
boolean	isValidToken(java.lang.String responseBody, java.lang.String clientId, java.lang.String tokenType) Check the validity of a token
java.util.Map<java.lang.String,java.lang.Object>	mapProperties(java.lang.String srcUrl, java.lang.String clientId, java.util.Map<java.lang.String,java.lang.Object> existing, java.util.Map<java.lang.String,java.lang.String> newProperties) Map the provider's user properties name to CQ user properties.
java.lang.String	mapUserId(java.lang.String userId, java.util.Map<java.lang.String,java.lang.Object> props) Map the provider's userid to CRX user id; Note that usernames must be unique so the returned username should always include some prefix specific to this provider (e.g.
void	onUserCreate(User user) Called after a user is updated (e.g.
void	onUserUpdate(User user) Called after a user is created (i.e.
java.util.Map<java.lang.String,java.lang.String>	parseProfileDataResponse(org.scribe.model.Response response) Parse the OAuth Response for protected profile data during profile import

Method Detail

getType

ProviderType getType()

Currently only oauth 1a and oauth 2 are supported.

Returns:

type

See Also:

ProviderType

getApi

org.scribe.builder.api.Api getApi()

Specifies an instance of scribe Api to use for this provider.

Returns:

Api instance

getDetailsURL

java.lang.String getDetailsURL()

OAuth provider's user details URL

Returns:

url

getExtendedDetailsURLs

java.lang.String[] getExtendedDetailsURLs(java.lang.String scope)

OAuth provider's user extended details URLs, depending on the specific scope

Returns:

url

getExtendedDetailsURLs

java.lang.String[] getExtendedDetailsURLs(java.lang.String scope,
                                          java.lang.String userId,
                                          java.util.Map<java.lang.String,java.lang.Object> props)

OAuth provider's user extended details URLs, depending on the specific scope and previously fetched data (e.g. getDetailsURL(), getExtendedDetailsURLs(String)).

Parameters:

scope - allows to specify a list of property names for each scope

userId - the userId

props - contains the data previously fetched.

Returns:

the list of urls to fetch extended data from.

getId

java.lang.String getId()

Unique ID for this provider, used to match a ProviderConfig with this Provider

Returns:

ID of this provider

getName

java.lang.String getName()

Readable name for this Provider

Returns:

name of this Provider

mapUserId

java.lang.String mapUserId(java.lang.String userId,
                           java.util.Map<java.lang.String,java.lang.Object> props)

Map the provider's userid to CRX user id; Note that usernames must be unique so the returned username should always include some prefix specific to this provider (e.g. in case facebook and twitter have a user with the same username)

Parameters:

userId - provider's userId

props - map of all provider's properties for this userId

Returns:

CQ user id

getUserFolderPath

java.lang.String getUserFolderPath(java.lang.String userId,
                                   java.lang.String clientId,
                                   java.util.Map<java.lang.String,java.lang.Object> props)

Return the node path where the user should be created

Parameters:

userId -

clientId - in use when creating this user

props - map of all provider's properties for this user

Returns:

relative path to store this user within /home/users (e.g. "facebook/1234" might be appropriate for facebook user with id=12345678)

mapProperties

java.util.Map<java.lang.String,java.lang.Object> mapProperties(java.lang.String srcUrl,
                                                               java.lang.String clientId,
                                                               java.util.Map<java.lang.String,java.lang.Object> existing,
                                                               java.util.Map<java.lang.String,java.lang.String> newProperties)

Map the provider's user properties name to CQ user properties. This method will at least be called to map properties fetched from getDetailsURL(). If getExtendedDetailsURLs(String) is not null, this method will be called for the map of properties fetched from each url.

Parameters:

srcUrl -

clientId - in use to retreive this set of properties

existing - CQ properties that have already been mapped

newProperties - addition provider properties that need to be mapped

Returns:

the result of mapping the new properties, and combining with the existing

getAccessTokenPropertyPath

java.lang.String getAccessTokenPropertyPath(java.lang.String clientId)

Return the property path where the access token will be stored (if ProviderConfig is has access token storage enabled)

Parameters:

clientId -

Returns:

the property path where access token may be stored for a user e.g. profile/someapp-clientid/accesstoken

getOAuthIdPropertyPath

java.lang.String getOAuthIdPropertyPath(java.lang.String clientId)

Return the property path where the oauth user id will be stored

Parameters:

clientId -

Returns:

getCurrentUser

User getCurrentUser(SlingHttpServletRequest request)

Use the request to get the User who has (or will have) oauth profile data attached

Parameters:

request -

Returns:

the User or null, if no User is associated with the request

onUserCreate

void onUserCreate(User user)

Called after a user is updated (e.g. profile data is mapped and applied to the user);

Parameters:

user -

onUserUpdate

void onUserUpdate(User user)

Called after a user is created (i.e. profile data is mapped and applied to user already);

Parameters:

user -

getProtectedDataRequest

org.scribe.model.OAuthRequest getProtectedDataRequest(java.lang.String url)

Create an OAuthRequest to request protected data from the OAuth provider system.

Parameters:

url -

Returns:

the OAuthRequest

Since:

2.0

parseProfileDataResponse

java.util.Map<java.lang.String,java.lang.String> parseProfileDataResponse(org.scribe.model.Response response)
                                                                   throws java.io.IOException

Parse the OAuth Response for protected profile data during profile import

Parameters:

response -

Returns:

Map of profile properties

Throws:

java.io.IOException

Since:

2.0

getUserIdProperty

java.lang.String getUserIdProperty()

What is the user data property that contains this OAuth provider's user id? (e.g. "id")

Returns:

getValidateTokenUrl

java.lang.String getValidateTokenUrl(java.lang.String clientId,
                                     java.lang.String token)

OAuth provider validate token URL

Parameters:

clientId -

token -

Returns:

url or null if validate token is not supported

Since:

2.1

isValidToken

boolean isValidToken(java.lang.String responseBody,
                     java.lang.String clientId,
                     java.lang.String tokenType)

Check the validity of a token

Parameters:

responseBody -

clientId -

Returns:

true if the response body contains the validity of the token, the token has been issued for the provided clientId and the token type matches with the one provided

Since:

2.1

getUserIdFromValidateTokenResponseBody

java.lang.String getUserIdFromValidateTokenResponseBody(java.lang.String responseBody)

Parse the response body and return the userId contained in the response

Parameters:

responseBody -

Returns:

the userId contained in the response or null if is not contained

Since:

2.1

getErrorDescriptionFromValidateTokenResponseBody

java.lang.String getErrorDescriptionFromValidateTokenResponseBody(java.lang.String responseBody)

Parse the response body and return the error description contained in the response

Parameters:

responseBody -

Returns:

the error description contained in the response or null if is not contained

Since:

2.1