Package org.openstreetmap.josm.data.oauth

Interface IOAuthParameters

All Known Implementing Classes:

OAuth20Parameters

public interface IOAuthParameters

A generic interface for OAuth Parameters

Since:

18650

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAccessTokenUrl()	Get the access token URL
default java.lang.String	getApiUrl()	Get the actual API URL
java.lang.String	getAuthorizationUrl()	Get the base authorization URL to open in a browser
default java.lang.String	getAuthorizationUrl(java.lang.String state, java.lang.Enum<?>... scopes)	Get the authorization URL to open in a browser
default java.lang.String	getAuthorizationUrl(java.lang.String state, java.lang.String... scopes)	Get the authorization URL to open in a browser
java.lang.String	getClientId()	Get the client id
java.lang.String	getClientSecret()	Get the client secret
OAuthVersion	getOAuthVersion()	Get the OAuth version that the API expects
default java.lang.String	getRedirectUri()	Get the redirect URI
void	rememberPreferences()	Store the preferences for these parameters
default java.lang.String	toPreferencesString()	Convert to a preference string

Method Detail

getAccessTokenUrl

java.lang.String getAccessTokenUrl()

Get the access token URL

Returns:

The URL to use to switch the code to a token

getAuthorizationUrl

java.lang.String getAuthorizationUrl()

Get the base authorization URL to open in a browser

Returns:

The base URL to send to the browser

getAuthorizationUrl

default java.lang.String getAuthorizationUrl(java.lang.String state,
                                             java.lang.Enum<?>... scopes)

Get the authorization URL to open in a browser

Parameters:

state - The state to prevent attackers from providing their own token

scopes - The scopes to request

Returns:

The URL to send to the browser

getAuthorizationUrl

default java.lang.String getAuthorizationUrl(java.lang.String state,
                                             java.lang.String... scopes)

Get the authorization URL to open in a browser

Parameters:

state - The state to prevent attackers from providing their own token

scopes - The scopes to request

Returns:

The URL to send to the browser

getOAuthVersion

OAuthVersion getOAuthVersion()

Get the OAuth version that the API expects

Returns:

The oauth version

getClientId

java.lang.String getClientId()

Get the client id

Returns:

The client id

getClientSecret

java.lang.String getClientSecret()

Get the client secret

Returns:

The client secret

getRedirectUri

default java.lang.String getRedirectUri()

Get the redirect URI

Returns:

The redirect URI

toPreferencesString

default java.lang.String toPreferencesString()

Convert to a preference string

Returns:

the preference string

getApiUrl

default java.lang.String getApiUrl()

Get the actual API URL

Returns:

The API URl

rememberPreferences

void rememberPreferences()

Store the preferences for these parameters