WIP: Remodeling UserState store mechanics
[aquarium] / src / main / scala / gr / grnet / aquarium / actor / service / user / UserActorCache.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
36 package gr.grnet.aquarium.actor
37 package service
38 package user
39
40 import akka.actor.ActorRef
41 import gr.grnet.aquarium.util.{Loggable, Lifecycle}
42 import com.google.common.cache._
43
44 /**
45  * An actor cache implementation using Guava.
46  *
47  * @author Georgios Gousios <gousiosg@gmail.com>
48  */
49 object UserActorCache extends Lifecycle {
50
51   private lazy val cache: Cache[String, ActorRef] =
52     CacheBuilder.newBuilder()
53       .maximumSize(1000)
54       .initialCapacity(100)
55       .concurrencyLevel(20)
56       .removalListener(EvictionListener)
57       .build()
58
59   private[this] object EvictionListener
60     extends RemovalListener[String, ActorRef] with Loggable {
61
62     def onRemoval(p1: RemovalNotification[String, ActorRef]) {
63       val userId = p1.getKey
64       val userActor = p1.getValue
65
66       logger.debug("Parking UserActor for userId = %s".format(userId))
67       UserActorSupervisor.supervisor.unlink(userActor)
68       // Check this is received after any currently servicing business logic message.
69       userActor.stop()
70     }
71   }
72
73   def start() {}
74
75   def stop() = cache.invalidateAll;
76   cache.cleanUp
77
78   def put(userId: String, userActor: ActorRef): Unit =
79     cache.put(userId, userActor)
80
81   def get(userId: String): Option[ActorRef] =
82     cache.getIfPresent(userId) match {
83       case null ⇒ None
84       case actorRef ⇒ Some(actorRef)
85     }
86 }