Spring Social

org.springframework.social.oauth1
Class OAuth1Parameters

java.lang.Object
  extended by org.springframework.social.support.ParameterMap
      extended by org.springframework.social.oauth1.OAuth1Parameters
All Implemented Interfaces:
java.util.Map<java.lang.String,java.util.List<java.lang.String>>, org.springframework.util.MultiValueMap<java.lang.String,java.lang.String>

public final class OAuth1Parameters
extends ParameterMap

Parameters for building an OAuth1 authorize URL.

Author:
Keith Donald
See Also:
OAuth1Operations.buildAuthorizeUrl(String, OAuth1Parameters)

Nested Class Summary
 
Nested classes/interfaces inherited from interface java.util.Map
java.util.Map.Entry<K,V>
 
Field Summary
static OAuth1Parameters NONE
          Shared instance for passing zero authorization parameters (common for OAuth 1.0a-based flows).
 
Constructor Summary
OAuth1Parameters()
          Creates a new OAuth1Parameters map that is initially empty.
OAuth1Parameters(java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters)
          Creates a new OAuth1Parameters populated from the initial parameters provided.
 
Method Summary
 java.lang.String getCallbackUrl()
          The authorization callback url.
 void setCallbackUrl(java.lang.String callbackUrl)
          Sets the authorization callback url.
 
Methods inherited from class org.springframework.social.support.ParameterMap
add, 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
equals, hashCode
 

Field Detail

NONE

public static final OAuth1Parameters NONE
Shared instance for passing zero authorization parameters (common for OAuth 1.0a-based flows). The underlying map is immutable.

See Also:
Collections.emptyMap()
Constructor Detail

OAuth1Parameters

public OAuth1Parameters()
Creates a new OAuth1Parameters map that is initially empty. Use the setter methods to add parameters after construction.

See Also:
setCallbackUrl(String), ParameterMap.set(String, String)

OAuth1Parameters

public OAuth1Parameters(java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters)
Creates a new OAuth1Parameters populated from the initial parameters provided.

Parameters:
parameters - the initial parameters
See Also:
setCallbackUrl(String)
Method Detail

getCallbackUrl

public java.lang.String getCallbackUrl()
The authorization callback url. This value must be included for OAuth 1.0 providers (and NOT for OAuth 1.0a)


setCallbackUrl

public void setCallbackUrl(java.lang.String callbackUrl)
Sets the authorization callback url. This value must be included for OAuth 1.0 providers (and NOT for OAuth 1.0a).


Spring Social