Package com.atlassian.oauth

Class Consumer

java.lang.Object
com.atlassian.oauth.Consumer
@Immutable public final class Consumer extends Object

Immutable representation of an OAuth consumer. At a miminum a consumer is required to have a key, a name, and a public key. A consumer can also be configured to have a description and a default callback URL that will be used if a callback URL is not provided after a user authorizes a request token.

Instances of Consumer objects can be constructed using the builder. For example

   Consumer c = Consumer.key("consumer-key").name("Consumer").publicKey(publicRSAKey).build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Consumer.InstanceBuilder
    Builder allowing the optional attributes of the Consumer object under construction to be set and construction of the final Consumer instance.
    static enum 
    Consumer.SignatureMethod
    The ways in which consumers can sign requests, as per

  • Method Summary

    Modifier and Type
    Method
    Description
    URI
    getCallback()
    Returns the default callback URI used after a request token has been authorized if no callback URI was provided in the authorization request.
    String
    getDescription()
    Returns the optional description of the consumer as it would be displayed to the user, null if the description was not set.
    String
    getExecutingTwoLOUser()
    Returns the user whose credential is used to execute 2LO requests.
    String
    getKey()
    Returns the unique key used to identify the consumer in requests unauthorized OAuth request tokens.
    String
    getName()
    Returns the name of the consumer as it will be displayed to the user.
    PublicKey
    getPublicKey()
    Returns the RSA public key for the consumer, null if the signature method is not RSA-SHA1.
    Consumer.SignatureMethod
    getSignatureMethod()
    Returns the method the consumer uses to sign requests.
    boolean
    getThreeLOAllowed()
    Returns whether 3 Legged OAuth requests are allowed for this consumer.
    boolean
    getTwoLOAllowed()
    Returns whether 2 Legged OAuth requests are allowed for this consumer.
    boolean
    getTwoLOImpersonationAllowed()
    Returns whether 2 Legged OAuth with impersonation requests are allowed for this consumer.
    static Consumer.InstanceBuilder
    key(String key)
    Static factory method that starts the process of building a Consumer instance.
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Method Details

    • key

      public static Consumer.InstanceBuilder key(String key)
      Static factory method that starts the process of building a Consumer instance. Returns an InstanceBuilder so the other attribute can be set.
      Parameters:
      key - unique key used to identify the consumer in requests unauthorized OAuth request tokens
      Returns:
      the builder for constructing the rest of the Consumer instance

    • getKey

      public String getKey()
      Returns the unique key used to identify the consumer in requests unauthorized OAuth request tokens.
      Returns:
      the unique key used to identify the consumer in requests unauthorized OAuth request tokens

    • getName

      public String getName()
      Returns the name of the consumer as it will be displayed to the user.
      Returns:
      the name of the consumer as it will be displayed to the user

    • getSignatureMethod

      public Consumer.SignatureMethod getSignatureMethod()
      Returns the method the consumer uses to sign requests.
      Returns:
      the method the consumer uses to sign requests

    • getPublicKey

      public PublicKey getPublicKey()
      Returns the RSA public key for the consumer, null if the signature method is not RSA-SHA1. If the signature method is RSA-SHA1, this key is used in verifying the signature in requests from the consumer.
      Returns:
      the RSA public key for the consumer, null if the signature method is not RSA-SHA1

    • getDescription

      public String getDescription()
      Returns the optional description of the consumer as it would be displayed to the user, null if the description was not set.
      Returns:
      the optional description of the consumer as it would be displayed to the user, null if the description was not set.

    • getCallback

      public URI getCallback()
      Returns the default callback URI used after a request token has been authorized if no callback URI was provided in the authorization request.
      Returns:
      the default callback URI used after a request token has been authorized

    • getThreeLOAllowed

      public boolean getThreeLOAllowed()
      Returns whether 3 Legged OAuth requests are allowed for this consumer.
      Returns:
      whether 3 Legged OAuth requests are allowed for this consumer

    • getTwoLOAllowed

      public boolean getTwoLOAllowed()
      Returns whether 2 Legged OAuth requests are allowed for this consumer.
      Returns:
      whether 2 Legged OAuth requests are allowed for this consumer

    • getExecutingTwoLOUser

      public String getExecutingTwoLOUser()
      Returns the user whose credential is used to execute 2LO requests. This could be null only if twoLOAllowed is false.
      Returns:
      the user whose credential is used to execute 2LO requests

    • getTwoLOImpersonationAllowed

      public boolean getTwoLOImpersonationAllowed()
      Returns whether 2 Legged OAuth with impersonation requests are allowed for this consumer.
      Returns:
      whether 2 Legged OAuth with impersonation requests are allowed for this consumer

    • toString

      public String toString()
      Overrides:
      toString in class Object