code.grnet.gr Git - aquarium/blob - logic/src/main/scala/gr/grnet/aquarium/processor/actor/ReflectiveAquariumActor.scala

   1 /*
   2  * Copyright 2011 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
  36 package gr.grnet.aquarium
  37 package processor
  38 package actor
  39
  40 import akka.actor.Actor
  41 import com.ckkloverdos.maybe.{Failed, NoVal, Just, Maybe}
  42 import util.{Loggable, shortNameOfClass}
  43
  44 /**
  45  * An actor who dispatches to particular methods based on the type of the received message.
  46  *
  47  * @author Christos KK Loverdos <loverdos@gmail.com>.
  48  */
  49 trait ReflectiveAquariumActor extends Actor with Loggable {
  50   private val messageMethodMap: Map[Class[_ <: AnyRef], java.lang.reflect.Method] = {
  51     val classMethodPairs = for(knownMessageType <- knownMessageTypes) yield {
  52       require(knownMessageType ne null, "Null in knownMessageTypes of %s".format(this.getClass))
  53       val methodName = "on%s".format(shortNameOfClass(knownMessageType))
  54       // For each class MethodClass we expect a method with the following signature:
  55       // def onMethodClass(message: MethodClass): Unit
  56       Maybe(this.getClass.getMethod(methodName, knownMessageType)) match {
  57         case Just(method) =>
  58           method.setAccessible(true)
  59           (knownMessageType, method)
  60         case NoVal =>
  61           throw new Exception("Reflective actor %s does not know how to process message %s".format(this.getClass, knownMessageType))
  62         case Failed(e, m) =>
  63           throw new Exception("Reflective actor %s does not know how to process message %s".format(this.getClass, knownMessageType), e)
  64       }
  65     }
  66
  67     Map(classMethodPairs: _*)
  68   }
  69
  70   def knownMessageTypes: List[Class[_ <: AnyRef]]
  71
  72   protected def receive: Receive  = {
  73     case null =>
  74       receiveNull
  75     case message: AnyRef =>
  76       messageMethodMap.get(message.getClass) match {
  77         case Some(reflectiveMethod) =>
  78           reflectiveMethod.invoke(this, message)
  79         case None =>
  80           receiveUnknown(message)
  81       }
  82     case message =>
  83       // For the Anys....
  84       receiveUnknown(message)
  85   }
  86
  87   def receiveNull: Unit = {}
  88
  89   def receiveUnknown(message: Any): Unit = {
  90     logger.warn("Received unknown message: %s".format(message))
  91   }
  92 }