Class/Object

com.mohiva.play.silhouette.impl.providers

DefaultSocialStateHandler

Related Docs: object DefaultSocialStateHandler | package providers

Permalink

class DefaultSocialStateHandler extends SocialStateHandler

The base implementation of the SocialStateHandler.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DefaultSocialStateHandler
  2. SocialStateHandler
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DefaultSocialStateHandler(handlers: Set[SocialStateItemHandler], signer: Signer)

    Permalink

    handlers

    The item handlers configured for this handler.

    signer

    The signer implementation to sign the state.

Type Members

  1. type Self = DefaultSocialStateHandler

    Permalink

    The concrete instance of the state provider.

    The concrete instance of the state provider.

    Definition Classes
    DefaultSocialStateHandlerSocialStateHandler

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. val handlers: Set[SocialStateItemHandler]

    Permalink

    The item handlers configured for this handler.

    The item handlers configured for this handler.

    Definition Classes
    DefaultSocialStateHandlerSocialStateHandler
  11. def hashCode(): Int

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  16. def publish[B](result: Result, state: SocialState)(implicit request: ExtractableRequest[B]): Result

    Permalink

    Publishes the state to the client.

    Publishes the state to the client.

    B

    The type of the request body.

    result

    The result to send to the client.

    state

    The state to publish.

    request

    The current request.

    returns

    The result to send to the client.

    Definition Classes
    DefaultSocialStateHandlerSocialStateHandler
    See also

    PublishableSocialStateItemHandler

  17. def serialize(state: SocialState): String

    Permalink

    Serializes the given state into a single state value which can be passed with the state param.

    Serializes the given state into a single state value which can be passed with the state param.

    If no handler is registered on the provider then we omit state signing, because it makes no sense the sign an empty state.

    state

    The social state to serialize.

    returns

    The serialized state as string.

    Definition Classes
    DefaultSocialStateHandlerSocialStateHandler
  18. def state(implicit ec: ExecutionContext): Future[SocialState]

    Permalink

    Gets the social state for all handlers.

    Gets the social state for all handlers.

    ec

    The execution context to handle the asynchronous operations.

    returns

    The social state for all handlers.

    Definition Classes
    DefaultSocialStateHandlerSocialStateHandler
  19. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    AnyRef → Any
  21. def unserialize[B](state: String)(implicit request: ExtractableRequest[B], ec: ExecutionContext): Future[SocialState]

    Permalink

    Unserializes the social state from the state param.

    Unserializes the social state from the state param.

    If no handler is registered on the provider then we omit the state validation. This is needed in some cases where the authentication process was started from a client side library and not from Silhouette.

    B

    The type of the request body.

    state

    The state to unserialize.

    request

    The request to read the value of the state param from.

    ec

    The execution context to handle the asynchronous operations.

    returns

    The social state on success, an error on failure.

    Definition Classes
    DefaultSocialStateHandlerSocialStateHandler
  22. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. def withHandler(handler: SocialStateItemHandler): DefaultSocialStateHandler

    Permalink

    Creates a copy of the state provider with a new handler added.

    Creates a copy of the state provider with a new handler added.

    There exists two types of state handlers. The first type are global state handlers which can be configured by the user with the help of a configuration mechanism or through dependency injection. And there a local state handlers which are provided by the application itself. This method exists to handle the last type of state handlers, because it allows to extend the list of user defined state handlers from inside the library.

    handler

    The handler to add.

    returns

    A new state provider with a new handler added.

    Definition Classes
    DefaultSocialStateHandlerSocialStateHandler

Inherited from SocialStateHandler

Inherited from AnyRef

Inherited from Any

Ungrouped