|
||||||||||
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<java.lang.String,java.lang.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 |
---|
java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V> |
Field Summary | |
---|---|
static java.lang.String |
AUTHORIZATION_HEADER
Name of HTTP authorization header. |
static java.lang.String |
CALLBACK
Name of parameter containing the callback URL. |
static java.lang.String |
CONSUMER_KEY
Name of parameter containing the consumer key. |
static java.lang.String |
NONCE
Name of parameter containing the nonce. |
static java.lang.String |
REALM
Name of parameter containing the protection realm. |
static java.lang.String |
SCHEME
OAuth scheme in Authorization header. |
static java.lang.String |
SIGNATURE
Name of parameter containing the signature. |
static java.lang.String |
SIGNATURE_METHOD
Name of parameter containing the signature method. |
static java.lang.String |
TIMESTAMP
Name of parameter containing the timestamp. |
static java.lang.String |
TOKEN
Name of parameter containing the access/request token. |
static java.lang.String |
VERIFIER
Name of parameter containing the verifier code. |
static java.lang.String |
VERSION
Name of parameter containing the protocol version. |
Constructor Summary | |
---|---|
OAuthParameters()
|
Method Summary | |
---|---|
OAuthParameters |
callback(java.lang.String callback)
Builder pattern method to return OAuthParameters after setting
callback URL. |
OAuthParameters |
consumerKey(java.lang.String consumerKey)
Builder pattern method to return OAuthParameters after setting
consumer key. |
java.lang.String |
getConsumerKey()
Returns the consumer key. |
java.lang.String |
getNonce()
Returns the nonce, a value that should be unique for a given timestamp. |
java.lang.String |
getRealm()
Returns the protection realm for the request. |
java.lang.String |
getSignature()
Returns the signature for the request. |
java.lang.String |
getSignatureMethod()
Returns the signature method used to sign the request. |
java.lang.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). |
java.lang.String |
getToken()
Returns the request or access token. |
java.lang.String |
getVersion()
Returns the protocol version. |
OAuthParameters |
nonce()
Builder pattern method to return OAuthParameters after setting
nonce to a randomly-generated UUID. |
OAuthParameters |
nonce(java.lang.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(java.lang.String realm)
Builder pattern method to return OAuthParameters after setting
protection realm. |
void |
setConsumerKey(java.lang.String consumerKey)
Sets the consumer key. |
void |
setNonce()
Sets the nonce to contain a randomly-generated UUID. |
void |
setNonce(java.lang.String nonce)
Sets the nonce, a value that should be unique for a given timestamp. |
void |
setRealm(java.lang.String realm)
Sets the protection realm for the request. |
void |
setSignature(java.lang.String signature)
Sets the signature for the request. |
void |
setSignatureMethod(java.lang.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(java.lang.String timestamp)
Sets the timestamp. |
void |
setToken(java.lang.String token)
Sets the request or access token. |
void |
setVersion(java.lang.String version)
Sets the protocol version. |
OAuthParameters |
signature(java.lang.String signature)
Builder pattern method to return OAuthParameters after setting
signature. |
OAuthParameters |
signatureMethod(java.lang.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(java.lang.String timestamp)
Builder pattern method to return OAuthParameters after setting
timestamp. |
OAuthParameters |
token(java.lang.String token)
Builder pattern method to return OAuthParameters after setting
token. |
OAuthParameters |
verifier(java.lang.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(java.lang.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 java.lang.String AUTHORIZATION_HEADER
public static final java.lang.String SCHEME
public static final java.lang.String REALM
public static final java.lang.String CONSUMER_KEY
public static final java.lang.String TOKEN
public static final java.lang.String SIGNATURE_METHOD
public static final java.lang.String SIGNATURE
public static final java.lang.String TIMESTAMP
public static final java.lang.String NONCE
public static final java.lang.String VERSION
public static final java.lang.String VERIFIER
public static final java.lang.String CALLBACK
Constructor Detail |
---|
public OAuthParameters()
Method Detail |
---|
public java.lang.String getRealm()
public void setRealm(java.lang.String realm)
public OAuthParameters realm(java.lang.String realm)
OAuthParameters
after setting
protection realm.
realm
- the protection realm for the request.
public java.lang.String getConsumerKey()
public void setConsumerKey(java.lang.String consumerKey)
public OAuthParameters consumerKey(java.lang.String consumerKey)
OAuthParameters
after setting
consumer key.
consumerKey
- the consumer key.public java.lang.String getToken()
public void setToken(java.lang.String token)
public OAuthParameters token(java.lang.String token)
OAuthParameters
after setting
token.
token
- the access or request token.
public java.lang.String getSignatureMethod()
public void setSignatureMethod(java.lang.String signatureMethod)
public OAuthParameters signatureMethod(java.lang.String signatureMethod)
OAuthParameters
after setting
signature method.
signatureMethod
- the signature method used to sign the request.
public java.lang.String getSignature()
public void setSignature(java.lang.String signature)
public OAuthParameters signature(java.lang.String signature)
OAuthParameters
after setting
signature.
signature
- the signature for the request.
public java.lang.String getTimestamp()
public void setTimestamp(java.lang.String timestamp)
public OAuthParameters timestamp(java.lang.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 java.lang.String getNonce()
public void setNonce(java.lang.String nonce)
public OAuthParameters nonce(java.lang.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 java.lang.String getVersion()
public void setVersion(java.lang.String version)
public OAuthParameters version(java.lang.String version)
OAuthParameters
after setting
version.
version
- the protocol version.
public OAuthParameters version()
OAuthParameters
after setting
version to the default value of 1.0.
public OAuthParameters verifier(java.lang.String verifier)
OAuthParameters
after setting
verifier code.
verifier
- the verifier code.
public OAuthParameters callback(java.lang.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 |