One pipe less
[aquarium] / src / main / scala / gr / grnet / aquarium / store / PolicyStore.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.store
37
38 import collection.immutable
39 import gr.grnet.aquarium.logic.accounting.dsl.Timeslot
40 import gr.grnet.aquarium.message.avro.gen.PolicyMsg
41 import gr.grnet.aquarium.policy.PolicyModel
42 import gr.grnet.aquarium.message.avro.ModelFactory
43
44 /**
45  * A store for serialized policy models.
46  *
47  * @author Georgios Gousios <gousiosg@gmail.com>
48  * @author Christos KK Loverdos <loverdos@gmail.com>
49  */
50 trait PolicyStore {
51   def foreachPolicy[U](f: PolicyMsg ⇒ U): Unit
52
53   def loadSortedPoliciesWithin(fromMillis: Long, toMillis: Long): immutable.SortedMap[Timeslot, PolicyMsg]
54
55   def loadSortedPolicyModelsWithin(fromMillis: Long, toMillis: Long): immutable.SortedMap[Timeslot, PolicyModel] = {
56     loadSortedPoliciesWithin(fromMillis, toMillis).map { case (timeslot, msg) ⇒
57       (timeslot, ModelFactory.newPolicyModel(msg))
58     }
59   }
60
61   def loadPolicyAt(atMillis: Long): Option[PolicyMsg]
62
63   /**
64    * Store an accounting policy.
65    */
66   def insertPolicy(policy: PolicyMsg): PolicyMsg
67 }