Trait

com.mohiva.play.silhouette.api

RequestProvider

Related Doc: package api

Permalink

trait RequestProvider extends Provider

A provider which can be hooked into a request.

It scans the request for credentials and returns the login info for it.

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. RequestProvider
  2. Provider
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def authenticate[B](request: Request[B]): Future[Option[LoginInfo]]

    Permalink

    Authenticates an identity based on credentials sent in a request.

    Authenticates an identity based on credentials sent in a request.

    Silhouette supports chaining of request providers. So if more as one request provider is defined it tries to authenticate until one provider returns an identity. To control the behaviour of the chaining you can use the return type by this method.

    None - If returning None, then the next provider in the chain will be executed. Some(identity) - If returning some identity, then this provider will be used for authentication. Exception - Throwing an exception breaks the chain. The error handler will also handle this exception.

    B

    The type of the body.

    request

    The request.

    returns

    Some login info on successful authentication or None if the authentication was unsuccessful.

  2. abstract def id: String

    Permalink

    Gets the provider ID.

    Gets the provider ID.

    returns

    The provider ID.

    Definition Classes
    Provider

Concrete 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 clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit

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

Inherited from Provider

Inherited from AnyRef

Inherited from Any

Ungrouped