Class DefaultOAuth1Provider.Token

java.lang.Object
org.glassfish.jersey.server.oauth1.DefaultOAuth1Provider.Token
All Implemented Interfaces:
OAuth1Token
Enclosing class:
DefaultOAuth1Provider

public class DefaultOAuth1Provider.Token extends Object implements OAuth1Token
Simple immutable implementation of OAuth1Token.
  • Field Details

    • token

      private final String token
    • secret

      private final String secret
    • consumerKey

      private final String consumerKey
    • callbackUrl

      private final String callbackUrl
    • principal

      private final Principal principal
    • roles

      private final Set<String> roles
    • attribs

      private final javax.ws.rs.core.MultivaluedMap<String,String> attribs
  • Constructor Details

  • Method Details

    • getToken

      public String getToken()
      Description copied from interface: OAuth1Token
      Returns string representing the token.
      Specified by:
      getToken in interface OAuth1Token
      Returns:
      string representing the token
    • getSecret

      public String getSecret()
      Description copied from interface: OAuth1Token
      Returns the token secret.
      Specified by:
      getSecret in interface OAuth1Token
      Returns:
      token secret
    • getConsumer

      public OAuth1Consumer getConsumer()
      Description copied from interface: OAuth1Token
      Returns consumer this token was issued for.
      Specified by:
      getConsumer in interface OAuth1Token
      Returns:
      consumer this token was issued for.
    • getAttributes

      public javax.ws.rs.core.MultivaluedMap<String,String> getAttributes()
      Description copied from interface: OAuth1Token
      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 OAuth1Provider.newRequestToken(String, String, java.util.Map) 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 OAuth1Token
      Returns:
      immutable map of custom attributes
    • getPrincipal

      public Principal getPrincipal()
      Description copied from interface: OAuth1Token
      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 OAuth1Token
      Returns:
      Principal corresponding to this token, or null if the token is not authorized
    • isInRole

      public boolean isInRole(String role)
      Description copied from interface: OAuth1Token
      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(String) to this method.
      Specified by:
      isInRole in interface OAuth1Token
      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 DefaultOAuth1Provider.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.