com.sun.jersey.oauth.server.api.providers
Class DefaultOAuthProvider.Token

java.lang.Object
  extended by com.sun.jersey.oauth.server.api.providers.DefaultOAuthProvider.Token
All Implemented Interfaces:
OAuthToken
Enclosing class:
DefaultOAuthProvider

public class DefaultOAuthProvider.Token
extends Object
implements OAuthToken

Simple immutable implementation of OAuthToken.


Constructor Summary
  DefaultOAuthProvider.Token(String token, String secret, DefaultOAuthProvider.Token requestToken)
           
  DefaultOAuthProvider.Token(String token, String secret, String consumerKey, String callbackUrl, Map<String,List<String>> attributes)
           
protected DefaultOAuthProvider.Token(String token, String secret, String consumerKey, String callbackUrl, Principal principal, Set<String> roles, MultivaluedMap<String,String> attributes)
           
 
Method Summary
protected  DefaultOAuthProvider.Token authorize(Principal principal, Set<String> roles)
          Authorizes this token - i.e.
 MultivaluedMap<String,String> getAttributes()
          Returns additional custom attributes associated with the token.
 String getCallbackUrl()
          Returns callback URL for this token (applicable just to request tokens)
 OAuthConsumer getConsumer()
          Returns consumer this token was issued for.
 Principal getPrincipal()
          Returns a Principal object containing the name of the user the request containing this token is authorized to act on behalf of.
 String getSecret()
          Returns the token secret.
 String getToken()
          Returns string representing the token.
 boolean isInRole(String role)
          Returns a boolean indicating whether this token is authorized for the specified logical "role".
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultOAuthProvider.Token

protected DefaultOAuthProvider.Token(String token,
                                     String secret,
                                     String consumerKey,
                                     String callbackUrl,
                                     Principal principal,
                                     Set<String> roles,
                                     MultivaluedMap<String,String> attributes)

DefaultOAuthProvider.Token

public DefaultOAuthProvider.Token(String token,
                                  String secret,
                                  String consumerKey,
                                  String callbackUrl,
                                  Map<String,List<String>> attributes)

DefaultOAuthProvider.Token

public DefaultOAuthProvider.Token(String token,
                                  String secret,
                                  DefaultOAuthProvider.Token requestToken)
Method Detail

getToken

public String getToken()
Description copied from interface: OAuthToken
Returns string representing the token.

Specified by:
getToken in interface OAuthToken
Returns:
string representing the token

getSecret

public String getSecret()
Description copied from interface: OAuthToken
Returns the token secret.

Specified by:
getSecret in interface OAuthToken
Returns:
token secret

getConsumer

public OAuthConsumer getConsumer()
Description copied from interface: OAuthToken
Returns consumer this token was issued for.

Specified by:
getConsumer in interface OAuthToken
Returns:
consumer this token was issued for.

getAttributes

public MultivaluedMap<String,String> getAttributes()
Description copied from interface: OAuthToken
Returns additional custom attributes associated with the token. If this is a request token, this should be a the same set or a defined subset of parameters that were passed to the OAuthProvider#newRequestToken(java.lang.String, java.lang.String, javax.ws.rs.core.MultivaluedMap) method that created this request token. If this is an access token, this is any application defined set that will included as form parameters in a response to accessToken request.

Specified by:
getAttributes in interface OAuthToken
Returns:
immutable map of custom attributes

getPrincipal

public Principal getPrincipal()
Description copied from interface: OAuthToken
Returns a Principal object containing the name of the user the request containing this token is authorized to act on behalf of. When the oauth filter verifies the request with this token is properly authenticated, it injects this token into a security context which then delegates SecurityContext.getUserPrincipal() to this method.

Specified by:
getPrincipal in interface OAuthToken
Returns:
Principal corresponding to this token, or null if the token is not authorized

isInRole

public boolean isInRole(String role)
Description copied from interface: OAuthToken
Returns a boolean indicating whether this token is authorized for the specified logical "role". When the oauth filter verifies the request with this token is properly authenticated, it injects this token into a security context which then delegates SecurityContext.isUserInRole(java.lang.String) to this method.

Specified by:
isInRole in interface OAuthToken
Parameters:
role - a String specifying the name of the role
Returns:
a boolean indicating whether this token is authorized for a given role

getCallbackUrl

public String getCallbackUrl()
Returns callback URL for this token (applicable just to request tokens)

Returns:
callback url

authorize

protected DefaultOAuthProvider.Token authorize(Principal principal,
                                               Set<String> roles)
Authorizes this token - i.e. generates a clone with principal and roles set to the passed values.

Parameters:
principal - Principal to add to the token.
roles - Roles to add to the token.
Returns:
Cloned token with the principal and roles set.


Copyright © 2013 Oracle Corporation. All Rights Reserved.