Packages

c

uk.gov.hmrc.auth.core.retrieve

SimpleRetrieval

case class SimpleRetrieval[A](propertyName: String, valueReads: Reads[A]) extends Retrieval[A] with Product with Serializable

A Retrieval that will return only a single property on successful authorisation

propertyName

The name of the property to return from auth on success. Must be a supported property in auth.

valueReads

The JSON Reads to apply to the returned JSON property

Linear Supertypes
Serializable, Product, Equals, Retrieval[A], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SimpleRetrieval
  2. Serializable
  3. Product
  4. Equals
  5. Retrieval
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new SimpleRetrieval(propertyName: String, valueReads: Reads[A])

    propertyName

    The name of the property to return from auth on success. Must be a supported property in auth.

    valueReads

    The JSON Reads to apply to the returned JSON property

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def and[B](other: Retrieval[B]): Retrieval[~[A, B]]

    Allows simpler and more concise code for the lib user at the call site when authorising

    Allows simpler and more concise code for the lib user at the call site when authorising

    other

    The Retrieval to be joined with this Retrieval

    returns

    A Retrieval[A ~ B] that contains this Retrieval and the one passed in

    Definition Classes
    Retrieval
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  12. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  13. def productElementNames: Iterator[String]
    Definition Classes
    Product
  14. val propertyName: String
  15. val propertyNames: Seq[String]

    The properties to return from a successful authorise call.

    The properties to return from a successful authorise call. These have to be explicitly supported by the auth service being called

    returns

    A list of property names to return.

    Definition Classes
    SimpleRetrievalRetrieval
  16. val reads: Reads[A]

    The Reads that will be used upon the returned JSON

    The Reads that will be used upon the returned JSON

    returns

    JSON Reads

    Definition Classes
    SimpleRetrievalRetrieval
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. val valueReads: Reads[A]
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Retrieval[A]

Inherited from AnyRef

Inherited from Any

Ungrouped