org.springframework.social.oauth2
Class OAuth2Parameters

java.lang.Object
  org.springframework.social.oauth2.OAuth2Parameters

public final class OAuth2Parameters
extends java.lang.Object

Parameters for building an OAuth2 authorize URL.

See Also:

OAuth2Operations.buildAuthorizeUrl(GrantType, OAuth2Parameters)

Constructor Summary

OAuth2Parameters(java.lang.String redirectUri)
Creates a new authorization parameters instance.

OAuth2Parameters(java.lang.String redirectUri, java.lang.String scope)
Creates a new authorization parameters instance.

OAuth2Parameters(java.lang.String redirectUri, java.lang.String scope, java.lang.String state, MultiValueMap<java.lang.String,java.lang.String> additionalParameters)
Creates a new authorization parameters instance.

Method Summary

MultiValueMap<java.lang.String,java.lang.String>	getAdditionalParameters() Additional supported parameters to pass to the provider (optional).
java.lang.String	getRedirectUri() The authorization callback url; this value must match the redirectUri registered with the provider (required).
java.lang.String	getScope() The permissions the application is seeking with the authorization (optional).
java.lang.String	getState() An opaque key that must be included in the provider's authorization callback (optional).

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth2Parameters

public OAuth2Parameters(java.lang.String redirectUri)

Creates a new authorization parameters instance.

Parameters:

redirectUri - the authorization callback url; this value must match the redirectUri registered with the provider (required)

OAuth2Parameters

public OAuth2Parameters(java.lang.String redirectUri,
                        java.lang.String scope)

Creates a new authorization parameters instance.

Parameters:

redirectUri - the authorization callback url; this value must match the redirectUri registered with the provider (required)

scope - the permissions the application is seeking with the authorization (optional)

OAuth2Parameters

public OAuth2Parameters(java.lang.String redirectUri,
                        java.lang.String scope,
                        java.lang.String state,
                        MultiValueMap<java.lang.String,java.lang.String> additionalParameters)

Creates a new authorization parameters instance.

Parameters:

redirectUri - the authorization callback url; this value must match the redirectUri registered with the provider (required)

scope - the permissions the application is seeking with the authorization (optional)

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

additionalParameters - additional supported parameters to pass to the provider (optional)

Method Detail

getRedirectUri

public java.lang.String getRedirectUri()

The authorization callback url; this value must match the redirectUri registered with the provider (required).

getScope

public java.lang.String getScope()

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

getState

public java.lang.String getState()

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

getAdditionalParameters

public MultiValueMap<java.lang.String,java.lang.String> getAdditionalParameters()

Additional supported parameters to pass to the provider (optional).