|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.jersey.oauth.server.api.providers.DefaultOAuthProvider
@Provider public class DefaultOAuthProvider
Default in-memory implementation of OAuthProvider. Stores consumers and tokens in static hash maps. Provides some additional helper methods for consumer and token management (registering new consumers, retrieving a list of all registered consumers per owner, listing the authorized tokens per principal, revoking tokens, etc.)
Nested Class Summary | |
---|---|
static class |
DefaultOAuthProvider.Consumer
Simple read-only implementation of OAuthConsumer . |
class |
DefaultOAuthProvider.Token
Simple immutable implementation of OAuthToken . |
Constructor Summary | |
---|---|
DefaultOAuthProvider()
|
Method Summary | |
---|---|
java.lang.String |
authorizeToken(DefaultOAuthProvider.Token token,
java.security.Principal userPrincipal,
java.util.Set<java.lang.String> roles)
Authorizes a request token for given principal and roles and returns verifier. |
OAuthToken |
getAccessToken(java.lang.String token)
Returns the access token by the consumer key and token value. |
java.util.Set<DefaultOAuthProvider.Token> |
getAccessTokens(java.lang.String principalName)
Returns a list of access tokens authorized with the supplied principal name. |
DefaultOAuthProvider.Consumer |
getConsumer(java.lang.String consumerKey)
Gets consumer corresponding to a given consumer key. |
java.util.Set<DefaultOAuthProvider.Consumer> |
getConsumers(java.lang.String owner)
Returns a set of consumers registered by a given owner. |
DefaultOAuthProvider.Token |
getRequestToken(java.lang.String token)
Returns the request token by the consumer key and token value. |
OAuthToken |
newAccessToken(OAuthToken requestToken,
java.lang.String verifier)
Creates a new access token. |
protected static MultivaluedMap<java.lang.String,java.lang.String> |
newImmutableMultiMap(java.util.Map<java.lang.String,java.util.List<java.lang.String>> source)
|
OAuthToken |
newRequestToken(java.lang.String consumerKey,
java.lang.String callbackUrl,
java.util.Map<java.lang.String,java.util.List<java.lang.String>> attributes)
Creates a new request token for a given consumerKey. |
protected java.lang.String |
newUUIDString()
Generates a new non-guessable random string (used for token/customer strings, secrets and verifier. |
DefaultOAuthProvider.Consumer |
registerConsumer(java.lang.String owner,
MultivaluedMap<java.lang.String,java.lang.String> attributes)
Registers a new consumer. |
void |
revokeAccessToken(java.lang.String token,
java.lang.String principalName)
Checks if the supplied token is authorized for a given principal name and if so, revokes the authorization. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DefaultOAuthProvider()
Method Detail |
---|
public DefaultOAuthProvider.Consumer getConsumer(java.lang.String consumerKey)
OAuthProvider
getConsumer
in interface OAuthProvider
consumerKey
- consumer key
public DefaultOAuthProvider.Consumer registerConsumer(java.lang.String owner, MultivaluedMap<java.lang.String,java.lang.String> attributes)
owner
- Identifier of the owner that registers the consumer (user ID or similar).attributes
- Additional attributes (name-values pairs - to store additional
information about the consumer, such as name, URI, description, etc.)
public java.util.Set<DefaultOAuthProvider.Consumer> getConsumers(java.lang.String owner)
owner
- Identifier of the owner that registered the consumers to be retrieved.
public java.util.Set<DefaultOAuthProvider.Token> getAccessTokens(java.lang.String principalName)
principalName
- Principal name for which to retrieve the authorized tokens.
public java.lang.String authorizeToken(DefaultOAuthProvider.Token token, java.security.Principal userPrincipal, java.util.Set<java.lang.String> roles)
token
- Request token to authorize.userPrincipal
- User principal to authorize the token for.roles
- Set of roles to authorize the token for.
public void revokeAccessToken(java.lang.String token, java.lang.String principalName)
token
- Access token to revoke the authorization for.principalName
- Principal name the token is currently authorized for.protected java.lang.String newUUIDString()
public DefaultOAuthProvider.Token getRequestToken(java.lang.String token)
OAuthProvider
getRequestToken
in interface OAuthProvider
token
- request token value
public OAuthToken newRequestToken(java.lang.String consumerKey, java.lang.String callbackUrl, java.util.Map<java.lang.String,java.util.List<java.lang.String>> attributes)
OAuthProvider
newRequestToken
in interface OAuthProvider
consumerKey
- consumer key to create a request token forcallbackUrl
- callback url for this request token requestattributes
- additional service provider-specific parameters
(this can be used to indicate what level of access is requested
- i.e. readonly, or r/w, etc.)
public OAuthToken newAccessToken(OAuthToken requestToken, java.lang.String verifier)
OAuthProvider
newAccessToken
in interface OAuthProvider
requestToken
- authorized request tokenverifier
- verifier passed to the callback after authorization
public OAuthToken getAccessToken(java.lang.String token)
OAuthProvider
getAccessToken
in interface OAuthProvider
token
- access token value
protected static MultivaluedMap<java.lang.String,java.lang.String> newImmutableMultiMap(java.util.Map<java.lang.String,java.util.List<java.lang.String>> source)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |