code.grnet.gr Git - aquarium/blob - src/main/scala/gr/grnet/aquarium/actor/ActorRole.scala

   1 /*
   2  * Copyright 2011-2012 GRNET S.A. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or
   5  * without modification, are permitted provided that the following
   6  * conditions are met:
   7  *
   8  *   1. Redistributions of source code must retain the above
   9  *      copyright notice, this list of conditions and the following
  10  *      disclaimer.
  11  *
  12  *   2. Redistributions in binary form must reproduce the above
  13  *      copyright notice, this list of conditions and the following
  14  *      disclaimer in the documentation and/or other materials
  15  *      provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
  18  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  20  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
  21  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  24  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  25  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  27  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28  * POSSIBILITY OF SUCH DAMAGE.
  29  *
  30  * The views and conclusions contained in the software and
  31  * documentation are those of the authors and should not be
  32  * interpreted as representing official policies, either expressed
  33  * or implied, of GRNET S.A.
  34  */
  35 package gr.grnet.aquarium.actor
  36
  37 import service.user.UserActor
  38 import gr.grnet.aquarium.actor.message.event.{ProcessIMEvent, ProcessResourceEvent}
  39 import message.{GetUserBillRequest, GetUserWalletRequest, GetUserStateRequest, GetUserBalanceRequest}
  40 import gr.grnet.aquarium.actor.message.config.{InitializeUserActorState, AquariumPropertiesLoaded, ActorConfigurationMessage}
  41
  42 /**
  43  * Each actor within Aquarium plays one role.
  44  *
  45  * A role also dictates which configuration messages the respective actor handles.
  46  */
  47 sealed abstract class ActorRole(
  48     val role: String,
  49     val isCacheable: Boolean,
  50     val actorType: Class[_ <: RoleableActor],
  51     val handledServiceMessages: Set[Class[_]],
  52     val handledConfigurationMessages: Set[Class[_ <: ActorConfigurationMessage]] = Set()
  53 ) {
  54
  55   val knownMessageTypes = handledServiceMessages ++ handledConfigurationMessages
  56
  57   def canHandleConfigurationMessage[A <: ActorConfigurationMessage](cl: Class[A]): Boolean = {
  58     handledConfigurationMessages contains cl
  59   }
  60
  61   def canHandleConfigurationMessage[A <: ActorConfigurationMessage : Manifest](msg: A): Boolean = {
  62     canHandleConfigurationMessage(msg.getClass)
  63   }
  64
  65   def canHandleServiceMessage[A <: AnyRef](cl: Class[A]): Boolean = {
  66     handledServiceMessages contains cl
  67   }
  68
  69   def canHandleServiceMessage[A <: AnyRef : Manifest](msg: A): Boolean = {
  70     canHandleServiceMessage(msg.getClass)
  71   }
  72
  73   def canHandleMessage[A <: AnyRef](cl: Class[A]): Boolean = {
  74     knownMessageTypes contains cl
  75   }
  76
  77   def canHandleMessage[A <: AnyRef: Manifest](msg: A): Boolean = {
  78     canHandleMessage(msg.getClass)
  79   }
  80 }
  81
  82 /**
  83  * User-oriented business logic handler role.
  84  */
  85 case object UserActorRole
  86     extends ActorRole("UserActorRole",
  87                       false,
  88                       classOf[UserActor],
  89                       Set(classOf[ProcessResourceEvent],
  90                           classOf[ProcessIMEvent],
  91                           classOf[GetUserWalletRequest],
  92                           classOf[GetUserBalanceRequest],
  93                           classOf[GetUserBillRequest],
  94                           classOf[GetUserStateRequest]),
  95                       Set(classOf[InitializeUserActorState],
  96                           classOf[AquariumPropertiesLoaded]))