Package org.openstreetmap.josm.data.oauth

Class OAuth20Parameters

java.lang.Object

org.openstreetmap.josm.data.oauth.OAuth20Parameters

All Implemented Interfaces:

IOAuthParameters

public final class OAuth20Parameters
extends java.lang.Object
implements IOAuthParameters

Parameters for OAuth 2.0

Since:

18650

Field Summary

Fields

Modifier and Type	Field	Description
private static java.lang.String	API_URL
private java.lang.String	apiUrl
private static java.lang.String	AUTHORIZE_URL
private java.lang.String	authorizeUrl
private static java.lang.String	CLIENT_ID
private static java.lang.String	CLIENT_SECRET
private java.lang.String	clientId
private java.lang.String	clientSecret
private static java.lang.String	REDIRECT_URI
private java.lang.String	redirectUri
private static java.lang.String	TOKEN_URL
private java.lang.String	tokenUrl

Constructor Summary

Constructors

Constructor	Description
OAuth20Parameters(java.lang.String jsonString)	Recreate a parameter object from a JSON string
OAuth20Parameters(java.lang.String clientId, java.lang.String clientSecret, java.lang.String baseUrl, java.lang.String apiUrl, java.lang.String redirectUri)	Create a new OAuth parameter object
OAuth20Parameters(java.lang.String clientId, java.lang.String clientSecret, java.lang.String tokenUrl, java.lang.String authorizeUrl, java.lang.String apiUrl, java.lang.String redirectUri)	Create a new OAuth parameter object

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAccessTokenUrl()	Get the access token URL
java.lang.String	getApiUrl()	Get the actual API URL
java.lang.String	getAuthorizationUrl()	Get the base 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
java.lang.String	getRedirectUri()	Get the redirect URI
int	hashCode()
void	rememberPreferences()	Store the preferences for these parameters
java.lang.String	toPreferencesString()	Convert to a preference string

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openstreetmap.josm.data.oauth.IOAuthParameters

getAuthorizationUrl, getAuthorizationUrl

Field Detail

REDIRECT_URI

private static final java.lang.String REDIRECT_URI

See Also:

Constant Field Values

CLIENT_ID

private static final java.lang.String CLIENT_ID

See Also:

Constant Field Values

CLIENT_SECRET

private static final java.lang.String CLIENT_SECRET

See Also:

Constant Field Values

TOKEN_URL

private static final java.lang.String TOKEN_URL

See Also:

Constant Field Values

AUTHORIZE_URL

private static final java.lang.String AUTHORIZE_URL

See Also:

Constant Field Values

API_URL

private static final java.lang.String API_URL

See Also:

Constant Field Values

redirectUri

private final java.lang.String redirectUri

clientSecret

private final java.lang.String clientSecret

clientId

private final java.lang.String clientId

tokenUrl

private final java.lang.String tokenUrl

authorizeUrl

private final java.lang.String authorizeUrl

apiUrl

private final java.lang.String apiUrl

Constructor Detail

OAuth20Parameters

public OAuth20Parameters(java.lang.String jsonString)

Recreate a parameter object from a JSON string

Parameters:

jsonString - The JSON string with the required data

OAuth20Parameters

public OAuth20Parameters(java.lang.String clientId,
                         java.lang.String clientSecret,
                         java.lang.String baseUrl,
                         java.lang.String apiUrl,
                         java.lang.String redirectUri)

Create a new OAuth parameter object

Parameters:

clientId - The client id. May not be null.

clientSecret - The client secret. May be null. Not currently used.

baseUrl - The base url. This assumes that the endpoints are /token and /authorize.

apiUrl - The API url

redirectUri - The redirect URI for the client.

OAuth20Parameters

public OAuth20Parameters(java.lang.String clientId,
                         java.lang.String clientSecret,
                         java.lang.String tokenUrl,
                         java.lang.String authorizeUrl,
                         java.lang.String apiUrl,
                         java.lang.String redirectUri)

Create a new OAuth parameter object

Parameters:

clientId - The client id.

clientSecret - The client secret. May be null. Not currently used.

tokenUrl - The token request URL (RFC6749 4.4.2)

authorizeUrl - The authorization request URL (RFC6749 4.1.1)

apiUrl - The API url

redirectUri - The redirect URI for the client.

Method Detail

getAccessTokenUrl

public java.lang.String getAccessTokenUrl()

Description copied from interface: IOAuthParameters

Get the access token URL

Specified by:

getAccessTokenUrl in interface IOAuthParameters

Returns:

The URL to use to switch the code to a token

getAuthorizationUrl

public java.lang.String getAuthorizationUrl()

Description copied from interface: IOAuthParameters

Get the base authorization URL to open in a browser

Specified by:

getAuthorizationUrl in interface IOAuthParameters

Returns:

The base URL to send to the browser

getOAuthVersion

public OAuthVersion getOAuthVersion()

Description copied from interface: IOAuthParameters

Get the OAuth version that the API expects

Specified by:

getOAuthVersion in interface IOAuthParameters

Returns:

The oauth version

getClientId

public java.lang.String getClientId()

Description copied from interface: IOAuthParameters

Get the client id

Specified by:

getClientId in interface IOAuthParameters

Returns:

The client id

getClientSecret

public java.lang.String getClientSecret()

Description copied from interface: IOAuthParameters

Get the client secret

Specified by:

getClientSecret in interface IOAuthParameters

Returns:

The client secret

getRedirectUri

public java.lang.String getRedirectUri()

Description copied from interface: IOAuthParameters

Get the redirect URI

Specified by:

getRedirectUri in interface IOAuthParameters

Returns:

The redirect URI

getApiUrl

public java.lang.String getApiUrl()

Description copied from interface: IOAuthParameters

Get the actual API URL

Specified by:

getApiUrl in interface IOAuthParameters

Returns:

The API URl

rememberPreferences

public void rememberPreferences()

Description copied from interface: IOAuthParameters

Store the preferences for these parameters

Specified by:

rememberPreferences in interface IOAuthParameters

toPreferencesString

public java.lang.String toPreferencesString()

Description copied from interface: IOAuthParameters

Convert to a preference string

Specified by:

toPreferencesString in interface IOAuthParameters

Returns:

the preference string

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object