api

Type Members

trait AuthInfo extends AnyRef

A marker trait for authentication information.
case class AuthenticatedEvent[I <: Identity](identity: I, request: RequestHeader, messages: Messages) extends SilhouetteEvent with Product with Serializable

An event which will be published if a request passes authentication.
An event which will be published if a request passes authentication.
I
The type of the identity.
identity
The logged in identity.
request
The request header for the associated request.
messages
The messages for the current language.
trait Authenticator extends AnyRef

An authenticator tracks an authenticated user.
trait Authorization[I <: Identity, A <: Authenticator] extends AnyRef

A trait to define Authorization objects that let you hook an authorization implementation in secured endpoints.
A trait to define Authorization objects that let you hook an authorization implementation in secured endpoints.
I
The type of the identity.
A
The type of the authenticator.
trait Environment[I <: Identity, A <: Authenticator] extends ExecutionContextProvider

The environment needed to instantiate a Silhouette controller.
The environment needed to instantiate a Silhouette controller.
I
The type of the identity.
A
The type of the authenticator.
class EventBus extends ActorEventBus with SubchannelClassification

An event bus implementation which uses a class based lookup classification.
trait ExpirableAuthenticator extends Authenticator

An authenticator that may expire.
trait Identity extends AnyRef

This trait represents an authenticated user.
trait Logger extends AnyRef

Implement this to get a named logger in scope.
case class LoginEvent[I <: Identity](identity: I, request: RequestHeader, messages: Messages) extends SilhouetteEvent with Product with Serializable

An event which will be published after an identity logged in.
An event which will be published after an identity logged in.
I
The type of the identity.
identity
The logged in identity.
request
The request header for the associated request.
messages
The messages for the current language.
case class LoginInfo(providerID: String, providerKey: String) extends Product with Serializable

Represents a linked login for an identity (i.e.
Represents a linked login for an identity (i.e. a local username/password or a Facebook/Google account).
The login info contains the data about the provider that authenticated that identity.
providerID
The ID of the provider.
providerKey
A unique key which identifies a user on this provider (userID, email, ...).
case class LogoutEvent[I <: Identity](identity: I, request: RequestHeader, messages: Messages) extends SilhouetteEvent with Product with Serializable

An event which will be published after an identity logged out.
An event which will be published after an identity logged out.
I
The type of the identity.
identity
The logged out identity.
request
The request header for the associated request.
messages
The messages for the current language.
case class NotAuthenticatedEvent(request: RequestHeader, messages: Messages) extends SilhouetteEvent with Product with Serializable

An event which will be published if a request did not pass authentication.
An event which will be published if a request did not pass authentication.
request
The request header for the associated request.
messages
The messages for the current language.
case class NotAuthorizedEvent[I <: Identity](identity: I, request: RequestHeader, messages: Messages) extends SilhouetteEvent with Product with Serializable

An event which will be published if a request did not pass authorization.
An event which will be published if a request did not pass authorization.
I
The type of the identity.
identity
The logged in identity.
request
The request header for the associated request.
messages
The messages for the current language.
trait Provider extends AnyRef

A marker interface for all providers.
trait RequestProvider extends Provider

A provider which can be hooked into a request.
A provider which can be hooked into a request.
It scans the request for credentials and returns the login info for it.
trait SecuredErrorHandler extends AnyRef

Can be mixed into the HttpErrorHandler object to define a global behaviour for unauthorized and forbidden endpoints.
case class SignUpEvent[I <: Identity](identity: I, request: RequestHeader, messages: Messages) extends SilhouetteEvent with Product with Serializable

An event which will be published after an identity signed up.
An event which will be published after an identity signed up.
I
The type of the identity.
identity
The newly created identity.
request
The request header for the associated request.
messages
The messages for the current language.
trait Silhouette[I <: Identity, A <: Authenticator] extends Controller with Logger with I18nSupport

Provides the mechanisms that can be used to protect endpoints and retrieve the current user if available.
Provides the mechanisms that can be used to protect endpoints and retrieve the current user if available.
```
class MyController(
  val messagesApi: MessagesApi,
  val env: Environment[User, CookieAuthenticator])
  extends Silhouette[User, CookieAuthenticator] {

  def protectedAction = SecuredAction { implicit request =>
    Ok("Hello %s".format(request.identity.fullName))
  }
}
```
I
The type of the identity.
A
The type of the authenticator.
trait SilhouetteEvent extends AnyRef

The base event.
trait StorableAuthenticator extends Authenticator

An authenticator which can be stored in a backing store.

Value Members

object Authenticator

The Authenticator companion object.
object Authorization

The companion object.
object Environment

The companion object.
object EventBus

A global event bus instance.
object LoginInfo extends (String, String) ⇒ LoginInfo with Serializable

The companion object of the login info.
package exceptions

Provides exceptions used by the API.
package repositories

Provides repositories used by the API to persist entities.
package services

Provides services used by the API to call external or internal services.
package util

Provides utilities used by the API.

package api

Type Members

trait AuthInfo extends AnyRef

case class AuthenticatedEvent[I <: Identity](identity: I, request: RequestHeader, messages: Messages) extends SilhouetteEvent with Product with Serializable

trait Authenticator extends AnyRef

trait Authorization[I <: Identity, A <: Authenticator] extends AnyRef

trait Environment[I <: Identity, A <: Authenticator] extends ExecutionContextProvider

class EventBus extends ActorEventBus with SubchannelClassification

trait ExpirableAuthenticator extends Authenticator

trait Identity extends AnyRef

trait Logger extends AnyRef

case class LoginEvent[I <: Identity](identity: I, request: RequestHeader, messages: Messages) extends SilhouetteEvent with Product with Serializable

case class LoginInfo(providerID: String, providerKey: String) extends Product with Serializable

case class LogoutEvent[I <: Identity](identity: I, request: RequestHeader, messages: Messages) extends SilhouetteEvent with Product with Serializable

case class NotAuthenticatedEvent(request: RequestHeader, messages: Messages) extends SilhouetteEvent with Product with Serializable

case class NotAuthorizedEvent[I <: Identity](identity: I, request: RequestHeader, messages: Messages) extends SilhouetteEvent with Product with Serializable

trait Provider extends AnyRef

trait RequestProvider extends Provider

trait SecuredErrorHandler extends AnyRef

case class SignUpEvent[I <: Identity](identity: I, request: RequestHeader, messages: Messages) extends SilhouetteEvent with Product with Serializable

trait Silhouette[I <: Identity, A <: Authenticator] extends Controller with Logger with I18nSupport

trait SilhouetteEvent extends AnyRef

trait StorableAuthenticator extends Authenticator

Value Members

object Authenticator

object Authorization

object Environment

object EventBus

object LoginInfo extends (String, String) ⇒ LoginInfo with Serializable

package exceptions

package repositories

package services

package util

Inherited from AnyRef

Inherited from Any

Ungrouped