play-silhouette
API
Generated with
play-silhouette/play.silhouette/play.silhouette.api/play.silhouette.api.services/AuthenticatorResult

AuthenticatorResult

play.silhouette.api.services.AuthenticatorResult
See theAuthenticatorResult companion object
class AuthenticatorResult(result: Result) extends Result

A marker result which indicates that an operation on an authenticator was processed and therefore it shouldn't updated automatically.

Due the fact that the update method gets called on every subsequent request to update the authenticator related data in the backing store and in the result, it isn't possible to discard or renew the authenticator simultaneously. This is because the "update" method would override the result created by the "renew" or "discard" method, because it will be executed as last in the chain.

As example: If we discard the session in a Silhouette action then it will be removed from session. But at the end the update method will embed the session again, because it gets called with the result of the action.

Value parameters

result

The result to wrap.

Attributes

Companion
object
Graph
Supertypes
class Result
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def copy(header: ResponseHeader, body: HttpEntity, newSession: Option[Session], newFlash: Option[Flash], newCookies: Seq[Cookie], attrs: TypedMap): Result

Creates a new copy of a AuthenticatorResult.

Creates a new copy of a AuthenticatorResult.

Value parameters

body

The response body.

header

The response header, which contains status code and HTTP headers.

newCookies

Some new cookies.

newFlash

A new flash.

newSession

A new session.

Attributes

Returns

A copy of a AuthenticatorResult.

Definition Classes
Result

Inherited methods

def addAttr[A](key: TypedKey[A], value: A): Result

Create a new versions of this object with the given attribute attached to it.

Create a new versions of this object with the given attribute attached to it.

Type parameters

A

The type of value.

Value parameters

key

The new attribute key.

value

The attribute value.

Attributes

Returns

The new version of this object with the new attribute.

Inherited from:
Result
def addAttrs(entries: TypedEntry[_]*): Result

Create a new versions of this object with the given attributes attached to it.

Create a new versions of this object with the given attributes attached to it.

Value parameters

entries

The new attributes.

Attributes

Returns

The new version of this object with the new attributes.

Inherited from:
Result
def addAttrs(e1: TypedEntry[_], e2: TypedEntry[_], e3: TypedEntry[_]): Result

Create a new versions of this object with the given attributes attached to it.

Create a new versions of this object with the given attributes attached to it.

Value parameters

e1

The first new attribute.

e2

The second new attribute.

e3

The third new attribute.

Attributes

Returns

The new version of this object with the new attributes.

Inherited from:
Result
def addAttrs(e1: TypedEntry[_], e2: TypedEntry[_]): Result

Create a new versions of this object with the given attributes attached to it.

Create a new versions of this object with the given attributes attached to it.

Value parameters

e1

The first new attribute.

e2

The second new attribute.

Attributes

Returns

The new version of this object with the new attributes.

Inherited from:
Result
def addAttrs(e1: TypedEntry[_]): Result

Create a new versions of this object with the given attribute attached to it.

Create a new versions of this object with the given attribute attached to it.

Value parameters

e1

The new attribute.

Attributes

Returns

The new version of this object with the new attribute.

Inherited from:
Result
def addingToSession(values: (String, String)*)(implicit request: RequestHeader): Result

Example:

Example:

 Ok.addingToSession("foo" -> "bar").addingToSession("baz" -> "bah")

Value parameters

request

Current request

values

(key -> value) pairs to add to this result’s session

Attributes

Returns

A copy of this result with values added to its session scope.

Inherited from:
Result
def as(contentType: String): Result

Changes the result content type.

Changes the result content type.

For example:

Ok("<text>Hello world</text>").as("application/xml")

Value parameters

contentType

the new content type.

Attributes

Returns

the new result

Inherited from:
Result
def asJava: Result

Convert this result to a Java result.

Convert this result to a Java result.

Attributes

Inherited from:
Result
def bakeCookies(cookieHeaderEncoding: CookieHeaderEncoding, sessionBaker: CookieBaker[Session], flashBaker: CookieBaker[Flash], requestHasFlash: Boolean): Result

Encode the cookies into the Set-Cookie header. The session is always baked first, followed by the flash cookie, followed by all the other cookies in order.

Encode the cookies into the Set-Cookie header. The session is always baked first, followed by the flash cookie, followed by all the other cookies in order.

Attributes

Inherited from:
Result
def discardingCookies(cookies: DiscardingCookie*): Result

Discards cookies along this result.

Discards cookies along this result.

For example:

Redirect(routes.Application.index()).discardingCookies(DiscardingCookie("theme"))

Value parameters

cookies

the cookies to discard along to this result

Attributes

Returns

the new result

Inherited from:
Result
def discardingHeader(name: String): Result

Discards headers to this result.

Discards headers to this result.

For example:

Ok("Hello world").discardingHeader(ETAG)

Value parameters

name

the header to discard from this result.

Attributes

Returns

the new result

Inherited from:
Result
def flashing(values: (String, String)*): Result

Adds values to the flash scope for this result.

Adds values to the flash scope for this result.

For example:

Redirect(routes.Application.index()).flashing("success" -> "Done!")

Value parameters

values

the flash values to set with this result

Attributes

Returns

the new result

Inherited from:
Result
def flashing(flash: Flash): Result

Adds values to the flash scope for this result.

Adds values to the flash scope for this result.

For example:

Redirect(routes.Application.index()).flashing(flash + ("success" -> "Done!"))

Value parameters

flash

the flash scope to set with this result

Attributes

Returns

the new result

Inherited from:
Result
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def removeAttr(key: TypedKey[_]): Result

Create a new versions of this object with the given attribute removed.

Create a new versions of this object with the given attribute removed.

Value parameters

key

The key of the attribute to remove.

Attributes

Returns

The new version of this object with the attribute removed.

Inherited from:
Result
def removingFromSession(keys: String*)(implicit request: RequestHeader): Result

Example:

Example:

 Ok.removingFromSession("foo")

Value parameters

keys

Keys to remove from session

request

Current request

Attributes

Returns

A copy of this result with keys removed from its session scope.

Inherited from:
Result
def session(implicit request: RequestHeader): Session

Value parameters

request

Current request

Attributes

Returns

The session carried by this result. Reads the request’s session if this result does not modify the session.

Inherited from:
Result
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Result -> Any
Inherited from:
Result
def withAttrs(newAttrs: TypedMap): Result

Create a new version of this object with the given attributes attached to it. This replaces any existing attributes.

Create a new version of this object with the given attributes attached to it. This replaces any existing attributes.

Value parameters

newAttrs

The new attributes to add.

Attributes

Returns

The new version of this object with the attributes attached.

Inherited from:
Result
def withCookies(cookies: Cookie*): Result

Adds cookies to this result. If the result already contains cookies then cookies with the same name in the new list will override existing ones.

Adds cookies to this result. If the result already contains cookies then cookies with the same name in the new list will override existing ones.

For example:

Redirect(routes.Application.index()).withCookies(Cookie("theme", "blue"))

Value parameters

cookies

the cookies to add to this result

Attributes

Returns

the new result

Inherited from:
Result
def withDateHeaders(headers: (String, ZonedDateTime)*): Result

Add a header with a DateTime formatted using the default http date format

Add a header with a DateTime formatted using the default http date format

Value parameters

headers

the headers with a DateTime to add to this result.

Attributes

Returns

the new result.

Inherited from:
Result
def withHeaders(headers: (String, String)*): Result

Adds headers to this result.

Adds headers to this result.

For example:

Ok("Hello world").withHeaders(ETAG -> "0")

Value parameters

headers

the headers to add to this result.

Attributes

Returns

the new result

Inherited from:
Result
def withNewSession: Result

Discards the existing session for this result.

Discards the existing session for this result.

For example:

Redirect(routes.Application.index()).withNewSession

Attributes

Returns

the new result

Inherited from:
Result
def withSession(session: (String, String)*): Result

Sets a new session for this result, discarding the existing session.

Sets a new session for this result, discarding the existing session.

For example:

Redirect(routes.Application.index()).withSession("saidHello" -> "yes")

Value parameters

session

the session to set with this result

Attributes

Returns

the new result

Inherited from:
Result
def withSession(session: Session): Result

Sets a new session for this result.

Sets a new session for this result.

For example:

Redirect(routes.Application.index()).withSession(session + ("saidHello" -> "true"))

Value parameters

session

the session to set with this result

Attributes

Returns

the new result

Inherited from:
Result
Generated with