org.miniauth.oauth.common

Class OAuthParamMap

java.lang.Object

org.miniauth.oauth.common.OAuthParamMap

All Implemented Interfaces:

Serializable

public final class OAuthParamMap
extends Object
implements Serializable

A "bean" class for encapsulating OAuth parameters. Cf. http://tools.ietf.org/html/rfc5849#section-3.5.1

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OAuthParamMap()
OAuthParamMap(Map<String,? extends Object> paramMap)
OAuthParamMap(Map<String,? extends Object> paramMap, boolean copyOAuthParamOnly)
OAuthParamMap(OAuthParamMap oauthParamMap)
OAuthParamMap(OAuthParamMap oauthParamMap, boolean copyOAuthParamOnly)

Method Summary

Methods

Modifier and Type	Method and Description
String	buildUrlEncodedParamString()
String	buildUrlEncodedParamString(String transmissionType)
boolean	containsKey(Object key)
Set<Map.Entry<String,Object>>	entrySet()
Object	get(Object key)
AccessIdentity	getAccessIdentity()
String	getConsumerKey()
String	getNonce()
String	getSignature()
String	getSignatureMethod()
int	getTimestamp()
String	getToken()
String	getVersion()
boolean	isEmpty()
boolean	isSignatureSet()
Set<String>	keySet()
Object	put(String key, Object value)
Object	remove(Object key)
void	setAccessIdentity(AccessIdentity accessIdentity)
void	setConsumerKey(String consumerKey)
void	setNonce(String nonce)
void	setSignature(String signature)
void	setSignatureMethod(String signatureMethod)
void	setTimestamp(int timestamp)
void	setToken(String token)
void	setVersion(String version)
Map<String,Object>	toReadOnlyMap()
String	toString()
void	updateParams(Map<String,? extends Object> paramMap)
void	updateParams(Map<String,? extends Object> paramMap, boolean copyOAuthParamOnly)
void	updateParams(OAuthParamMap oauthParamMap)
void	updateParams(OAuthParamMap oauthParamMap, boolean copyOAuthParamOnly)

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuthParamMap

public OAuthParamMap()

OAuthParamMap

public OAuthParamMap(OAuthParamMap oauthParamMap)

OAuthParamMap

public OAuthParamMap(OAuthParamMap oauthParamMap,
             boolean copyOAuthParamOnly)

OAuthParamMap

public OAuthParamMap(Map<String,? extends Object> paramMap)

OAuthParamMap

public OAuthParamMap(Map<String,? extends Object> paramMap,
             boolean copyOAuthParamOnly)

Method Detail

updateParams

public void updateParams(OAuthParamMap oauthParamMap)

updateParams

public void updateParams(OAuthParamMap oauthParamMap,
                boolean copyOAuthParamOnly)

updateParams

public void updateParams(Map<String,? extends Object> paramMap)

updateParams

public void updateParams(Map<String,? extends Object> paramMap,
                boolean copyOAuthParamOnly)

toReadOnlyMap

public Map<String,Object> toReadOnlyMap()

isEmpty

public boolean isEmpty()

getConsumerKey

public String getConsumerKey()

setConsumerKey

public void setConsumerKey(String consumerKey)

getToken

public String getToken()

setToken

public void setToken(String token)

getSignature

public String getSignature()

setSignature

public void setSignature(String signature)

getSignatureMethod

public String getSignatureMethod()

setSignatureMethod

public void setSignatureMethod(String signatureMethod)

getNonce

public String getNonce()

setNonce

public void setNonce(String nonce)

getTimestamp

public int getTimestamp()

setTimestamp

public void setTimestamp(int timestamp)

getVersion

public String getVersion()

setVersion

public void setVersion(String version)

containsKey

public boolean containsKey(Object key)

get

public Object get(Object key)

put

public Object put(String key,
         Object value)

remove

public Object remove(Object key)

keySet

public Set<String> keySet()

entrySet

public Set<Map.Entry<String,Object>> entrySet()

isSignatureSet

public boolean isSignatureSet()

getAccessIdentity

public AccessIdentity getAccessIdentity()

setAccessIdentity

public void setAccessIdentity(AccessIdentity accessIdentity)

buildUrlEncodedParamString

public String buildUrlEncodedParamString()
                                  throws MiniAuthException

Throws:

MiniAuthException

buildUrlEncodedParamString

public String buildUrlEncodedParamString(String transmissionType)
                                  throws MiniAuthException

Throws:

MiniAuthException

toString

public String toString()

Overrides:

toString in class Object