akka.security

AuthenticationActor

trait AuthenticationActor [C <: Credentials] extends Actor

AuthenticationActor is the super-trait for actors doing Http authentication It defines the common ground and the flow of execution

Linear Supertypes
Actor, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. AuthenticationActor
  2. Actor
  3. AnyRef
  4. Any
Visibility
  1. Public
  2. All

Type Members

  1. type Receive = PartialFunction[Any, Unit]

    Type alias because traits cannot have companion objects.

    Type alias because traits cannot have companion objects.

    Definition Classes
    Actor
  2. type Req = ContainerRequest

Abstract Value Members

  1. def extractCredentials (r: Req): Option[C]

    Attributes
    abstract
  2. def mkSecurityContext (r: Req, user: UserInfo): SecurityContext

    Attributes
    abstract
  3. def realm : String

    Attributes
    abstract
  4. def unauthorized : Response

    Attributes
    abstract
  5. def verify (c: Option[C]): Option[UserInfo]

    Attributes
    abstract

Concrete Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  3. def ## (): Int

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

    Attributes
    final
    Definition Classes
    AnyRef
  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  6. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any
  7. def auth (r: Req): String

  8. def authOption (r: Req): Option[String]

  9. val authenticate : Receive

    Responsible for the execution flow of authentication

    Responsible for the execution flow of authentication

    Credentials are extracted and verified from the request, and a security context is created for the ContainerRequest this should ensure good integration with current Jersey security

    Attributes
    protected
  10. def become (behavior: Receive, discardOld: Boolean = true): Unit

    Changes the Actor's behavior to become the new 'Receive' (PartialFunction[Any, Unit]) handler.

    Changes the Actor's behavior to become the new 'Receive' (PartialFunction[Any, Unit]) handler. Puts the behavior on top of the hotswap stack. If "discardOld" is true, an unbecome will be issued prior to pushing the new behavior to the stack

    Definition Classes
    Actor
  11. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  12. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  13. def equals (arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  14. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  15. def freshInstance (): Option[Actor]

    User overridable callback.

    User overridable callback.

    Is called on the crashed Actor to give it the option of producing the Actor's reincarnation. If it returns None, which is the default, the initially provided actor factory is used.

    Warning: Propagating state from a crashed actor carries the risk of proliferating the cause of the error. Consider let-it-crash first.

    Definition Classes
    Actor
    Annotations
    @experimental( since = "1.2" )
  16. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any
  17. def hashCode (): Int

    Definition Classes
    AnyRef → Any
  18. def isDefinedAt (message: Any): Boolean

    Is the actor able to handle the message passed in as arguments?

    Is the actor able to handle the message passed in as arguments?

    Definition Classes
    Actor
  19. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any
  20. def mkDefaultSecurityContext (r: Req, u: UserInfo, scheme: String): SecurityContext

  21. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  22. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  23. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  24. def optionSelf : Option[ActorRef]

    Option[ActorRef] representation of the 'self' ActorRef reference.

    Option[ActorRef] representation of the 'self' ActorRef reference.

    Mainly for internal use, functions as the implicit sender references when invoking one of the message send functions ('!', '!!' and '!!!').

    Definition Classes
    Actor
  25. def postRestart (reason: Throwable): Unit

    User overridable callback.

    User overridable callback.

    Is called right AFTER restart on the newly created Actor to allow reinitialization after an Actor crash.

    Definition Classes
    Actor
  26. def postStop (): Unit

    User overridable callback.

    User overridable callback.

    Is called when 'actor.stop()' is invoked.

    Definition Classes
    Actor
  27. def preRestart (reason: Throwable, message: Option[Any]): Unit

    User overridable callback.

    User overridable callback.

    Is called on a crashed Actor right BEFORE it is restarted to allow clean up of resources before Actor is terminated. Override either the variant with or without the currentMessage argument.

    Definition Classes
    Actor
  28. def preStart (): Unit

    User overridable callback.

    User overridable callback.

    Is called when an Actor is started by invoking 'actor.start()'.

    Definition Classes
    Actor
  29. def receive : Receive

    User overridable callback/setting.

    User overridable callback/setting.

    Partial function implementing the actor logic. To be implemented by concrete actor class.

    Example code:

      def receive = {
        case Ping =>
          println("got a 'Ping' message")
          self.reply("pong")
    
        case OneWay =>
          println("got a 'OneWay' message")
    
        case unknown =>
          println("unknown message: " + unknown)
    }
    

    Definition Classes
    AuthenticationActorActor
  30. implicit val self : ScalaActorRef

    The 'self' field holds the ActorRef for this actor.

    The 'self' field holds the ActorRef for this actor.

    Can be used to send messages to itself:

    self ! message
    
    Here you also find most of the Actor API.

    For example fields like:

    self.dispatcher = ...
    self.trapExit = ...
    self.faultHandler = ...
    self.lifeCycle = ...
    self.sender
    

    Here you also find methods like:

    self.reply(..)
    self.link(..)
    self.unlink(..)
    self.start(..)
    self.stop(..)
    

    Attributes
    implicit
    Definition Classes
    Actor
  31. val someSelf : Some[ActorRef]

    Some[ActorRef] representation of the 'self' ActorRef reference.

    Some[ActorRef] representation of the 'self' ActorRef reference.

    Mainly for internal use, functions as the implicit sender references when invoking the 'forward' function.

    Definition Classes
    Actor
  32. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  33. def toString (): String

    Definition Classes
    AnyRef → Any
  34. def unbecome (): Unit

    Reverts the Actor behavior to the previous one in the hotswap stack.

    Reverts the Actor behavior to the previous one in the hotswap stack.

    Definition Classes
    Actor
  35. def unhandled (msg: Any): Unit

    User overridable callback.

    User overridable callback.

    Is called when a message isn't handled by the current behavior of the actor by default it throws an UnhandledMessageException

    Definition Classes
    Actor
  36. def wait (): Unit

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

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Deprecated Value Members

  1. def preRestart (reason: Throwable): Unit

    User overridable callback.

    User overridable callback.

    Is called on a crashed Actor right BEFORE it is restarted to allow clean up of resources before Actor is terminated. Override either the variant with or without the currentMessage argument.

    This method is deprecated: use the variant which receives the current message instead. This method will be removed in version 2.0.

    Definition Classes
    Actor
    Annotations
    @deprecated
    Deprecated

    use two-argument version, this one will be removed in 2.0

Inherited from Actor

Inherited from AnyRef

Inherited from Any