com.adobe.granite.auth.oauth

Interface Provider2

All Superinterfaces:

Provider

@ConsumerType
public interface Provider2
extends Provider

The Provider2 extends the Provider interface and adds the ability to perform log-out operation.

If a registered Provider service implements this interface the logout(ProviderConfig) method is called when the user clicks the logout button.

Since:

3.12

Method Summary

Modifier and Type	Method and Description
java.lang.String	logout(ProviderConfig providerConfig) This method will be called when the user clicks the logout button.

Methods inherited from interface com.adobe.granite.auth.oauth.Provider

getAccessTokenPropertyPath, getApi, getCurrentUser, getDetailsURL, getErrorDescriptionFromValidateTokenResponseBody, getExtendedDetailsURLs, getExtendedDetailsURLs, getId, getName, getOAuthIdPropertyPath, getProtectedDataRequest, getType, getUserFolderPath, getUserIdFromValidateTokenResponseBody, getUserIdProperty, getValidateTokenUrl, isValidToken, mapProperties, mapUserId, onUserCreate, onUserUpdate, parseProfileDataResponse

Method Detail

logout

java.lang.String logout(ProviderConfig providerConfig)

This method will be called when the user clicks the logout button. If a registered Provider service implements this interface

Parameters:

providerConfig - the providerConfig

Returns:

the URL where to redirect after logout

Since:

3.12