org.springframework.social.oauth2

Class OAuth2Parameters

java.lang.Object

org.springframework.social.support.ParameterMap

org.springframework.social.oauth2.OAuth2Parameters

All Implemented Interfaces:

Map<String,List<String>>, MultiValueMap<String,String>

public final class OAuth2Parameters
extends ParameterMap

Parameters for building an OAuth2 authorize URL.

See Also:

OAuth2Operations.buildAuthorizeUrl(GrantType, OAuth2Parameters)

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
OAuth2Parameters() Creates a new OAuth2Parameters map that is initially empty.
OAuth2Parameters(Map<String,List<String>> parameters) Creates a new OAuth2Parameters populated from the initial parameters provided.

Method Summary

Modifier and Type	Method and Description
String	getRedirectUri() The authorization callback url.
String	getScope() The permissions the application is seeking with the authorization (optional).
String	getState() An opaque key that must be included in the provider's authorization callback (optional).
void	setRedirectUri(String redirectUri) Sets the authorization callback url.
void	setScope(String scope) Sets the permissions the application is seeking with the authorization (optional).
void	setState(String state) Sets an opaque key that must be included in the provider's authorization callback (optional).

Methods inherited from class org.springframework.social.support.ParameterMap

add, addAll, addAll, clear, containsKey, containsValue, entrySet, get, getFirst, isEmpty, keySet, put, putAll, remove, set, setAll, size, toSingleValueMap, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

OAuth2Parameters

public OAuth2Parameters()

Creates a new OAuth2Parameters map that is initially empty. Use the setter methods to add parameters after construction.

See Also:

setRedirectUri(String), setScope(String), setState(String), ParameterMap.set(String, String)

OAuth2Parameters

public OAuth2Parameters(Map<String,List<String>> parameters)

Creates a new OAuth2Parameters populated from the initial parameters provided.

Parameters:

parameters - the initial parameters

See Also:

setRedirectUri(String), setScope(String), setState(String)

Method Detail

getRedirectUri

public String getRedirectUri()

The authorization callback url. This value must match the redirectUri registered with the provider. This is optional per the OAuth 2 spec, but required by most OAuth 2 providers.

Returns:

The authorization callback url.

setRedirectUri

public void setRedirectUri(String redirectUri)

Sets the authorization callback url. This value must match the redirectUri registered with the provider. This is optional per the OAuth 2 spec, but required by most OAuth 2 providers.

Parameters:

redirectUri - the authorization callback URL

getScope

public String getScope()

The permissions the application is seeking with the authorization (optional).

Returns:

the permissions the application is seeking with the authorization.

setScope

public void setScope(String scope)

Sets the permissions the application is seeking with the authorization (optional).

Parameters:

scope - sets the permissions the application is seeking with the authorization.

getState

public String getState()

An opaque key that must be included in the provider's authorization callback (optional).

Returns:

an opaque key that must be included in the provider's authorization callback.

setState

public void setState(String state)

Sets an opaque key that must be included in the provider's authorization callback (optional).

Parameters:

state - an opaque key that must be included in the provider's authorization callback