RememberMe

Instance Constructors

new RememberMe(store: TokenStore, cookieSigner: CookieSigner, secretConfiguration: SecretConfiguration)(implicit ec: ExecutionContext)

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val COOKIE_NAME: String

Definition Classes
RememberMe → CookieBaker
final def asInstanceOf[T0]: T0

Definition Classes
Any
def authenticate(req: RequestHeader): Future[Either[AuthFailure, Token]]
def authenticateFromCookie(request: RequestHeader): Future[Option[AuthedRequest]]

returns
the authenticated user, along with an optional cookie to include
def authenticateToken(req: RequestHeader): Future[Option[Token]]

returns
an authenticated token
def clock: Clock

Attributes
protected
Definition Classes
JWTCookieDataCodec
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val cookieSigner: CookieSigner
def cookify(token: Token): Cookie
def decode(encodedString: String): Map[String, String]

Definition Classes
JWTCookieDataCodec → CookieDataCodec
def decodeCookieToMap(cookie: Option[Cookie]): Map[String, String]

Definition Classes
CookieBaker
def decodeFromCookie(cookie: Option[Cookie]): UnAuthToken

Definition Classes
CookieBaker
def deserialize(data: Map[String, String]): UnAuthToken

The API says we must return a token, even if deserialization fails, so we introduce the concept of an "empty" token and filter it away in readToken(RequestHeader).
The API says we must return a token, even if deserialization fails, so we introduce the concept of an "empty" token and filter it away in readToken(RequestHeader).
data
token data
returns
a token

Attributes
protected
Definition Classes
RememberMe → CookieBaker
def discard: DiscardingCookie

Definition Classes
CookieBaker
def domain: Option[String]

Definition Classes
CookieBaker
val emptyCookie: UnAuthToken

Definition Classes
RememberMe → CookieBaker
def encode(data: Map[String, String]): String

Definition Classes
JWTCookieDataCodec → CookieDataCodec
def encodeAsCookie(data: UnAuthToken): Cookie

Definition Classes
CookieBaker
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def httpOnly: Boolean

Definition Classes
CookieBaker
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isSigned: Boolean

Definition Classes
CookieBaker
val jwtConfiguration: JWTConfiguration

Definition Classes
RememberMe → JWTCookieDataCodec
val maxAge: Option[Int]

Definition Classes
RememberMe → CookieBaker
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val path: String

Definition Classes
RememberMe → CookieBaker
def persistNewCookie(loggedInUser: Username): Future[Cookie]
def readToken(req: RequestHeader): Option[UnAuthToken]

req
request
returns
the browser's possibly stored token
def sameSite: Option[SameSite]

Definition Classes
CookieBaker
val secretConfiguration: SecretConfiguration

Definition Classes
RememberMe → JWTCookieDataCodec
def secure: Boolean

Definition Classes
CookieBaker
def serialize(cookie: UnAuthToken): Map[String, String]

Attributes
protected
Definition Classes
RememberMe → CookieBaker
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def uniqueId(): Option[String]

Attributes
protected
Definition Classes
JWTCookieDataCodec
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object RememberMe | package auth

class RememberMe extends CookieBaker[UnAuthToken] with JWTCookieDataCodec

Instance Constructors

new RememberMe(store: TokenStore, cookieSigner: CookieSigner, secretConfiguration: SecretConfiguration)(implicit ec: ExecutionContext)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val COOKIE_NAME: String

final def asInstanceOf[T0]: T0

def authenticate(req: RequestHeader): Future[Either[AuthFailure, Token]]

def authenticateFromCookie(request: RequestHeader): Future[Option[AuthedRequest]]

def authenticateToken(req: RequestHeader): Future[Option[Token]]

def clock: Clock

def clone(): AnyRef

val cookieSigner: CookieSigner

def cookify(token: Token): Cookie

def decode(encodedString: String): Map[String, String]

def decodeCookieToMap(cookie: Option[Cookie]): Map[String, String]

def decodeFromCookie(cookie: Option[Cookie]): UnAuthToken

def deserialize(data: Map[String, String]): UnAuthToken

def discard: DiscardingCookie

def domain: Option[String]

val emptyCookie: UnAuthToken

def encode(data: Map[String, String]): String

def encodeAsCookie(data: UnAuthToken): Cookie

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

def httpOnly: Boolean

final def isInstanceOf[T0]: Boolean

def isSigned: Boolean

val jwtConfiguration: JWTConfiguration

val maxAge: Option[Int]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val path: String

def persistNewCookie(loggedInUser: Username): Future[Cookie]

def readToken(req: RequestHeader): Option[UnAuthToken]

def sameSite: Option[SameSite]

val secretConfiguration: SecretConfiguration

def secure: Boolean

def serialize(cookie: UnAuthToken): Map[String, String]

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

def toString(): String

def uniqueId(): Option[String]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from JWTCookieDataCodec

Inherited from CookieDataCodec

Inherited from CookieBaker[UnAuthToken]

Inherited from AnyRef

Inherited from Any

Ungrouped