Package org.syncany.plugins.transfer.oauth

Interface OAuthGenerator

public interface OAuthGenerator

For TransferPlugins that base their authentication on OAuth, a generator class can be used to create the authentication URL and check the user-provided token. The concrete implementation of this interface should be provided to the TransferSettings class via the OAuth annotation.
A generator can be extended with OAuthGenerator.WithInterceptor, OAuthGenerator.WithExtractor and OAuthGenerator.WithNoRedirectMode.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	OAuthGenerator.WithExtractor	Use a custom OAuthTokenExtractor instead of the default one which depends on the OAuthMode in use.
static interface	OAuthGenerator.WithInterceptor	Use a custom OAuthTokenInterceptor instead of the default one which depends on the OAuthMode in use.
static interface	OAuthGenerator.WithNoRedirectMode	If an OAuth based plugin also supports copy&pasting a token from a website it should extend this interface.

Method Summary

Modifier and Type	Method	Description
void	checkToken(java.lang.String token, java.lang.String csrfState)	Validate the given token and (optional) csrf parameter.
java.net.URI	generateAuthUrl(java.net.URI redirectUri)	Generate a URL which can be accessed by a user to authorize Syncany

Method Detail

generateAuthUrl

java.net.URI generateAuthUrl(java.net.URI redirectUri)
                      throws StorageException

Generate a URL which can be accessed by a user to authorize Syncany

Parameters:

redirectUri - The URL to which the OAuth provider should redirect in any case (either success or failure)

Returns:

A URL to authorize Syncany using the provided redirectUri

Throws:

StorageException

checkToken

void checkToken(java.lang.String token,
                java.lang.String csrfState)
         throws StorageException

Validate the given token and (optional) csrf parameter.

Parameters:

token - Token provided by OAuthTokenWebListener.

csrfState - Content of the state parameter (optional).

Throws:

StorageException