Trait/Object

com.twitter.finagle

OAuth2

Related Docs: object OAuth2 | package finagle

Permalink

trait OAuth2 extends AnyRef

An entry point API to enable OAuth2 in Finagle services (server-side).

Issuing a token:

import com.twitter.finagle.OAuth2
import com.twitter.finagle.oauth2.{DataHandler, Grant}
import com.twitter.finagle.http.Request
import com.twitter.util.Future

val dataHandler: DataHandler[?] = ???
val request: Request = ??? // contains client credentials

val grant: Future[Grant] = OAuth2.issueAccessToken(request, dataHandler)

Authorizing a request:

import com.twitter.finagle.OAuth2
import com.twitter.finagle.oauth2.{AuthInfo, DataHandler}
import com.twitter.finagle.http.Request
import com.twitter.util.Future

val dataHandler: DataHandler[?] = ???
val request: Request = ??? // contains token

val authInfo: AuthInfo[?] = OAuth2.authorize(request, dataHandler)

Note both authorize and issueAccessToken may resolve into Future.exception containing OAuthError, which could be converted into a barebones HTTP response via .toResponse:

Linear Supertypes
AnyRef, Any
Known Subclasses
OAuth2
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OAuth2
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def authorize[U](request: ProtectedResource, dataHandler: DataHandler[U]): Future[AuthInfo[U]]

    Permalink

  6. def authorize[U](request: Request, dataHandler: DataHandler[U]): Future[AuthInfo[U]]

    Permalink

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  14. def issueAccessToken[U](request: Authorization, dataHandler: DataHandler[U]): Future[GrantResult]

    Permalink

  15. def issueAccessToken[U](request: Request, dataHandler: DataHandler[U]): Future[GrantResult]

    Permalink

  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  20. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  21. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  22. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped