OAuthTokenExtractors (Syncany API Documentation)

java.lang.Object
- org.syncany.plugins.transfer.oauth.OAuthTokenExtractors

public abstract class OAuthTokenExtractors
extends java.lang.Object

Factory class to generate some common OAuthTokenExtractors.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`OAuthTokenExtractors.NamedQueryTokenExtractor`	A `OAuthTokenExtractors.NamedQueryTokenExtractor` is a simple `OAuthTokenExtractor` which looks for a token and a CSRF secret in the redirect URL.

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String RFC_ACCESS_TOKEN_FIELD

static java.lang.String RFC_CODE_FIELD

static java.lang.String RFC_STATE_FIELD

Constructor Summary

Constructors
Constructor Description

OAuthTokenExtractors()

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static OAuthTokenExtractor`	`newTokenExtractorForMode(OAuthMode mode)`	Get a common `OAuthTokenExtractor` depending on the chosen `OAuthMode`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - RFC_CODE_FIELD
```
public static final java.lang.String RFC_CODE_FIELD
```
    See Also:
    
    Constant Field Values
  - RFC_ACCESS_TOKEN_FIELD
```
public static final java.lang.String RFC_ACCESS_TOKEN_FIELD
```
    See Also:
    
    Constant Field Values
  - RFC_STATE_FIELD
```
public static final java.lang.String RFC_STATE_FIELD
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OAuthTokenExtractors
```
public OAuthTokenExtractors()
```
- Method Detail
  - newTokenExtractorForMode
```
public static OAuthTokenExtractor newTokenExtractorForMode(OAuthMode mode)
```
    Get a common OAuthTokenExtractor depending on the chosen OAuthMode. More precisely, this creates a OAuthTokenExtractors.NamedQueryTokenExtractor with token field id set to "state" in OAuthMode.SERVER and "access_token" in OAuthMode.BROWSER. However, "state" is used in both cases to identify a potential CSRF value.
    
    Parameters:
    
    mode - OAuthMode supported by the TransferPlugin.
    
    Returns:
    
    A corresponding OAuthTokenExtractors.NamedQueryTokenExtractor.