Class DefaultOAuth1Provider.Consumer

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

public static class DefaultOAuth1Provider.Consumer extends Object implements OAuth1Consumer
Simple read-only implementation of OAuth1Consumer.
  • Field Details

    • key

      private final String key
    • secret

      private final String secret
    • owner

      private final String owner
    • attributes

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

  • Method Details

    • getKey

      public String getKey()
      Description copied from interface: OAuth1Consumer
      Returns consumer key.
      Specified by:
      getKey in interface OAuth1Consumer
      Returns:
      consumer key
    • getSecret

      public String getSecret()
      Description copied from interface: OAuth1Consumer
      Returns consumer secret.
      Specified by:
      getSecret in interface OAuth1Consumer
      Returns:
      consumer secret
    • getOwner

      public String getOwner()
      Returns identifier of owner of this consumer - i.e. who registered the consumer.
      Returns:
      consumer owner
    • getAttributes

      public javax.ws.rs.core.MultivaluedMap<String,String> getAttributes()
      Returns additional attributes associated with the consumer (e.g. name, URI, description, etc.)
      Returns:
      name-values pairs of additional attributes
    • getPrincipal

      public Principal getPrincipal()
      Description copied from interface: OAuth1Consumer
      Returns a Principal object representing this consumer. When the oauth filter verifies the request and no access token is provided, this is the principal that will get set to the security context. This can be used for 2-legged oauth. If the server does not allow consumers acting on their own (with no access token), this method should return null.
      Specified by:
      getPrincipal in interface OAuth1Consumer
      Returns:
      Principal corresponding to this consumer, or null if 2-legged oauth not supported (i.e. consumers can't act on their own)
    • isInRole

      public boolean isInRole(String role)
      Description copied from interface: OAuth1Consumer
      Returns a boolean indicating whether this consumer is authorized for the specified logical "role". When the oauth filter verifies the request and no access token is provided (2-legged oauth), it sets the consumer object to the security context which then delegates SecurityContext.isUserInRole(String) to this method.
      Specified by:
      isInRole in interface OAuth1Consumer
      Parameters:
      role - a String specifying the name of the role
      Returns:
      a boolean indicating whether this token is authorized for a given role