WIP Resource event handling
[aquarium] / src / main / scala / gr / grnet / aquarium / computation / state / parts / LatestResourceEventsWorker.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.computation
37 package state
38 package parts
39
40 import gr.grnet.aquarium.util.findAndRemoveFromMap
41 import gr.grnet.aquarium.event.model.resource.ResourceEventModel
42 import gr.grnet.aquarium.event.model.resource.ResourceEventModel.FullMutableResourceTypeMap
43
44 /**
45  * This is the mutable cousin of [[gr.grnet.aquarium.computation.state.parts.LatestResourceEventsSnapshot]].
46  *
47  * @param latestEventsMap
48  *
49  * @author Christos KK Loverdos <loverdos@gmail.com>
50  */
51 case class LatestResourceEventsWorker(latestEventsMap: FullMutableResourceTypeMap) {
52
53   /**
54    * The gateway to immutable state.
55    *
56    * @param snapshotTime The relevant snapshot time.
57    * @return A fresh instance of [[gr.grnet.aquarium.computation.state.parts.LatestResourceEventsSnapshot]].
58    */
59   def toImmutableSnapshot(snapshotTime: Long) =
60     LatestResourceEventsSnapshot(latestEventsMap.valuesIterator.toList)
61
62   def updateResourceEvent(resourceEvent: ResourceEventModel): Unit = {
63     latestEventsMap((resourceEvent.resource, resourceEvent.instanceID)) = resourceEvent
64   }
65
66   def findResourceEvent(resource: String, instanceId: String): Option[ResourceEventModel] = {
67     latestEventsMap.get((resource, instanceId))
68   }
69
70   def findAndRemoveResourceEvent(resource: String, instanceId: String): Option[ResourceEventModel] = {
71     findAndRemoveFromMap(latestEventsMap, (resource, instanceId))
72   }
73
74   def size = latestEventsMap.size
75
76   def foreach[U](f: ResourceEventModel => U): Unit = {
77     latestEventsMap.valuesIterator.foreach(f)
78   }
79 }
80
81 object LatestResourceEventsWorker {
82   final val Empty = LatestResourceEventsWorker(scala.collection.mutable.Map())
83
84   /**
85    * Helper factory to construct a worker from a list of events.
86    */
87   def fromList(latestEventsList: List[ResourceEventModel]): LatestResourceEventsWorker = {
88     LatestResourceEventsSnapshot(latestEventsList).toMutableWorker
89   }
90 }
91