api
A marker trait for authentication information.
An event which will be published if a request passes authentication.
An event which will be published if a request passes authentication.
The type of the identity.
The logged in identity.
The request header for the associated request.
An authenticator recognizes an authenticated user.
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.
The type of the identity.
The type of the authenticator.
Provides the base implementation for the default error handlers.
Handles not authenticated requests in a default way.
Handles not authorized requests in a default way.
The environment type.
The environment type.
Defines the Identity and Authenticator types for an environment. It is possible
to implement as many types as needed. This has the advantage that an application isn't
bound only to a single Identity -> Authenticator combination.
To define a new environment type create a new trait with the appropriate Identity and Authenticator types:
trait SessionEnv extends Env { type I = User type A = SessionAuthenticator } trait JWTEnv extends Env { type I = User type A = JWTAuthenticator }
Provides the components needed to handle a secured request.
Provides the components needed to handle a secured request.
It's possible to declare different environments for different environment types. The com.mohiva.play.silhouette.api.services.IdentityService and the com.mohiva.play.silhouette.api.services.AuthenticatorService are bound to the appropriate types defined in the environment type. But the EventBus and the list of RequestProvider instances can be defined as needed for every environment type.
Silhouette error handler.
An event bus implementation which uses a class based lookup classification.
An authenticator that may expire.
A result which can transport a result as also additional data through the request handler process.
A result which can transport a result as also additional data through the request handler process.
The type of the data.
A Play Framework result.
Additional data to transport in the result.
This trait represents an authenticated user.
Implement this to get a named logger in scope.
An event which will be published after an identity logged in.
An event which will be published after an identity logged in.
The type of the identity.
The logged in identity.
The request header for the associated request.
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.
The ID of the provider.
A unique key which identifies a user on this provider (userID, email, ...).
An event which will be published after an identity logged out.
An event which will be published after an identity logged out.
The type of the identity.
The logged out identity.
The request header for the associated request.
Handles errors when a user is not authenticated.
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.
The request header for the associated request.
Handles errors when a user is authenticated but not authorized.
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.
The type of the identity.
The logged in identity.
The request header for the associated request.
A marker interface for all providers.
Base implementation for building request handlers.
Base implementation for building request handlers.
The base implementations to handle secured endpoints are encapsulated into request handlers which can execute an arbitrary block of code and must return a HandlerResult. This HandlerResult consists of a normal Play result and arbitrary additional data which can be transported out of these handlers.
The type of the environment.
The type of the request.
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.
An event which will be published after an identity signed up.
An event which will be published after an identity signed up.
The type of the identity.
The newly created identity.
The request header for the associated request.
The Silhouette stack.
The Silhouette stack.
Inject an instance of this trait into your controller to provide all the Silhouette actions.
The type of the environment.
The base event.
Provides the Silhouette stack.
Provides the Silhouette stack.
The type of the environment.
An authenticator which can be stored in a backing store.
The Authenticator companion object.
The companion object.
Companion object to easily create environment instances.
Companion object to easily create environment instances.
Environment[SessionEnv](...) Environment[JWTEnv](...)
A global event bus instance.
The companion object of the login info.
Provides exceptions used by the API.
Provides repositories used by the API to persist entities.
Provides services used by the API to call external or internal services.
Provides utilities used by the API.
The collection of traits and utility classes that form the stable API of Silhouette.