|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.AbstractMap<K,V>
java.util.HashMap<String,String>
com.sun.jersey.oauth.signature.OAuthParameters
public class OAuthParameters
A data structure class that represents OAuth protocol parameters.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class java.util.AbstractMap |
---|
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V> |
Field Summary | |
---|---|
static String |
AUTHORIZATION_HEADER
Name of HTTP authorization header. |
static String |
CALLBACK
Name of parameter containing the callback URL. |
static String |
CALLBACK_CONFIRMED
Name of parameter containing the token secret. |
static String |
CONSUMER_KEY
Name of parameter containing the consumer key. |
static String |
NONCE
Name of parameter containing the nonce. |
static String |
REALM
Name of parameter containing the protection realm. |
static String |
SCHEME
OAuth scheme in Authorization header. |
static String |
SIGNATURE
Name of parameter containing the signature. |
static String |
SIGNATURE_METHOD
Name of parameter containing the signature method. |
static String |
TIMESTAMP
Name of parameter containing the timestamp. |
static String |
TOKEN
Name of parameter containing the access/request token. |
static String |
TOKEN_SECRET
Name of parameter containing the token secret. |
static String |
VERIFIER
Name of parameter containing the verifier code. |
static String |
VERSION
Name of parameter containing the protocol version. |
Constructor Summary | |
---|---|
OAuthParameters()
|
Method Summary | |
---|---|
OAuthParameters |
callback(String callback)
Builder pattern method to return OAuthParameters after setting
callback URL. |
OAuthParameters |
consumerKey(String consumerKey)
Builder pattern method to return OAuthParameters after setting
consumer key. |
String |
getCallback()
Returns the callback URL. |
String |
getConsumerKey()
Returns the consumer key. |
String |
getNonce()
Returns the nonce, a value that should be unique for a given timestamp. |
String |
getRealm()
Returns the protection realm for the request. |
String |
getSignature()
Returns the signature for the request. |
String |
getSignatureMethod()
Returns the signature method used to sign the request. |
String |
getTimestamp()
Returns the timestamp, a value expected to be a positive integer, typically containing the number of seconds since January 1, 1970 00:00:00 GMT (epoch). |
String |
getToken()
Returns the request or access token. |
String |
getVerifier()
Returns the verifier code. |
String |
getVersion()
Returns the protocol version. |
OAuthParameters |
nonce()
Builder pattern method to return OAuthParameters after setting
nonce to a randomly-generated UUID. |
OAuthParameters |
nonce(String nonce)
Builder pattern method to return OAuthParameters after setting
nonce. |
OAuthParameters |
readRequest(OAuthRequest request)
Reads a request for OAuth parameters, and populates this object. |
OAuthParameters |
realm(String realm)
Builder pattern method to return OAuthParameters after setting
protection realm. |
void |
setCallback(String callback)
Sets the callback URL. |
void |
setConsumerKey(String consumerKey)
Sets the consumer key. |
void |
setNonce()
Sets the nonce to contain a randomly-generated UUID. |
void |
setNonce(String nonce)
Sets the nonce, a value that should be unique for a given timestamp. |
void |
setRealm(String realm)
Sets the protection realm for the request. |
void |
setSignature(String signature)
Sets the signature for the request. |
void |
setSignatureMethod(String signatureMethod)
Sets the signature method used to sign the request. |
void |
setTimestamp()
Sets the timestamp to the current time as number of seconds since epoch. |
void |
setTimestamp(String timestamp)
Sets the timestamp. |
void |
setToken(String token)
Sets the request or access token. |
void |
setVerifier(String verifier)
Sets the verifier code. |
void |
setVersion()
Sets the protocol version to the default value of 1.0. |
void |
setVersion(String version)
Sets the protocol version. |
OAuthParameters |
signature(String signature)
Builder pattern method to return OAuthParameters after setting
signature. |
OAuthParameters |
signatureMethod(String signatureMethod)
Builder pattern method to return OAuthParameters after setting
signature method. |
OAuthParameters |
timestamp()
Builder pattern method to return OAuthParameters after setting
timestamp to the current time. |
OAuthParameters |
timestamp(String timestamp)
Builder pattern method to return OAuthParameters after setting
timestamp. |
OAuthParameters |
token(String token)
Builder pattern method to return OAuthParameters after setting
token. |
OAuthParameters |
verifier(String verifier)
Builder pattern method to return OAuthParameters after setting
verifier code. |
OAuthParameters |
version()
Builder pattern method to return OAuthParameters after setting
version to the default value of 1.0. |
OAuthParameters |
version(String version)
Builder pattern method to return OAuthParameters after setting
version. |
OAuthParameters |
writeRequest(OAuthRequest request)
Writes the OAuth parameters to a request, as an Authorization header. |
Methods inherited from class java.util.HashMap |
---|
clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values |
Methods inherited from class java.util.AbstractMap |
---|
equals, hashCode, toString |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.util.Map |
---|
equals, hashCode |
Field Detail |
---|
public static final String AUTHORIZATION_HEADER
public static final String SCHEME
public static final String REALM
public static final String CONSUMER_KEY
public static final String TOKEN
public static final String SIGNATURE_METHOD
public static final String SIGNATURE
public static final String TIMESTAMP
public static final String NONCE
public static final String VERSION
public static final String VERIFIER
public static final String CALLBACK
public static final String TOKEN_SECRET
public static final String CALLBACK_CONFIRMED
Constructor Detail |
---|
public OAuthParameters()
Method Detail |
---|
public String getRealm()
public void setRealm(String realm)
public OAuthParameters realm(String realm)
OAuthParameters
after setting
protection realm.
realm
- the protection realm for the request.
public String getConsumerKey()
public void setConsumerKey(String consumerKey)
public OAuthParameters consumerKey(String consumerKey)
OAuthParameters
after setting
consumer key.
consumerKey
- the consumer key.public String getToken()
public void setToken(String token)
public OAuthParameters token(String token)
OAuthParameters
after setting
token.
token
- the access or request token.
public String getSignatureMethod()
public void setSignatureMethod(String signatureMethod)
public OAuthParameters signatureMethod(String signatureMethod)
OAuthParameters
after setting
signature method.
signatureMethod
- the signature method used to sign the request.
public String getSignature()
public void setSignature(String signature)
public OAuthParameters signature(String signature)
OAuthParameters
after setting
signature.
signature
- the signature for the request.
public String getTimestamp()
public void setTimestamp(String timestamp)
public OAuthParameters timestamp(String timestamp)
OAuthParameters
after setting
timestamp.
timestamp
- positive integer, typically number of seconds since epoch.
public void setTimestamp()
public OAuthParameters timestamp()
OAuthParameters
after setting
timestamp to the current time.
public String getNonce()
public void setNonce(String nonce)
public OAuthParameters nonce(String nonce)
OAuthParameters
after setting
nonce.
nonce
- a value that should be unique for a given timestamp.
public void setNonce()
public OAuthParameters nonce()
OAuthParameters
after setting
nonce to a randomly-generated UUID.
public String getVersion()
public void setVersion(String version)
public OAuthParameters version(String version)
OAuthParameters
after setting
version.
version
- the protocol version.
public void setVersion()
public OAuthParameters version()
OAuthParameters
after setting
version to the default value of 1.0.
public String getVerifier()
public void setVerifier(String verifier)
public OAuthParameters verifier(String verifier)
OAuthParameters
after setting
verifier code.
verifier
- the verifier code.
public String getCallback()
public void setCallback(String callback)
public OAuthParameters callback(String callback)
OAuthParameters
after setting
callback URL.
callback
- the callback URL.
public OAuthParameters readRequest(OAuthRequest request)
request
- the request to read OAuth parameters from.
public OAuthParameters writeRequest(OAuthRequest request)
request
- the request to write OAuth parameters to.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |